summaryrefslogtreecommitdiff
path: root/doc/UsersGuide/UsersGuide.tex
Commit message (Collapse)AuthorAge
* Prev commit broke a couple of code examples. Fixed these.swhite2004-01-19
| | | | | | | | | | | | | | | Latex didn't like {\tt \#}. Made \verb|#| instead,. To Glossary, added many references, added several technical terms. Made some chapter and section reference names more readable. (this is a bigger project--a standard format would be nice) More use of 'alltt' environment in cases where some formatting is desirable in format specifications git-svn-id: http://svn.cactuscode.org/flesh/trunk@3532 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Move more headers from *.tex into cactus.sty.schnetter2003-07-18
| | | | | | | Make part letters handle up to 52 parts, using lower case letters if necessary. git-svn-id: http://svn.cactuscode.org/flesh/trunk@3299 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Move most of the (duplicated) latex headers into cactus.sty.schnetter2003-07-18
| | | | | | | Fix typos in template.tex. git-svn-id: http://svn.cactuscode.org/flesh/trunk@3295 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Make users' guide work with pdflatex.schnetter2003-07-18
| | | | | | | | | Remove all traces of \ifpdf. Make hyperref work. Add pdf versions of figures. git-svn-id: http://svn.cactuscode.org/flesh/trunk@3290 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Fixed hyperref conflict when using pdflatexallen2003-07-17
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@3289 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Keep the reference guide as part of the users guide temporarily.allen2003-07-06
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@3255 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Split of a "Reference Manual" from the Users Guide. Will update the docsallen2003-07-05
| | | | | | | | | | and different options for this, and add its own directory once we settle on the name of it. Fixes Cactus/1545 git-svn-id: http://svn.cactuscode.org/flesh/trunk@3249 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Stripped out Jonathan's FunctionDescription environment.rideout2002-09-04
| | | | | | | UsersGuide now depends on cactus package. git-svn-id: http://svn.cactuscode.org/flesh/trunk@2994 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Added some of the fancier pdftex options (hyperref, thumbpdf) as anallen2002-06-26
| | | | | | | | | | | | | | | | | | | | | | | experiment to see what people think. I'm not an expert on pdftex so would really welcome any suggestions ... I had to add a couple of restrictions to the hyperref options because we use the same numbers for pages/sections etc in different chapters. To get this full pdf version at the moment you need to cd docs/UsersGuide pdftex UsersGuide pdftex UsersGuide thumbpdf UsersGuide pdftex UsersGuide pdftex UsersGuide where some of these pdftex's must be redundent. Gabrielle git-svn-id: http://svn.cactuscode.org/flesh/trunk@2916 17b73243-c579-4c4c-a9d2-2d5706c11dac
* revise FunctionDescription environment a bit so that the "See Also"jthorn2002-04-03
| | | | | | | | | | | | | | | | | | | | | and "Errors" sections have more horizontal space in the left column --> greatly increases the number of entries that can fit in a single line, i.e. we now have See Also CCTK_LongFunctionName() Some text describing it CCTK_EvenLongerFunctionName() Some text describing this one whereas before we had See Also CCTK_LongFunctionName() Some text describing it CCTK_EvenLongerFunctionName() Some text describing this one git-svn-id: http://svn.cactuscode.org/flesh/trunk@2691 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Changed date on cover page to no longer be in math mode, so that therideout2002-04-03
| | | | | | | | | space is not stripped out between the date and time. Stripped out archaic stuff which followed \end{document}. git-svn-id: http://svn.cactuscode.org/flesh/trunk@2684 17b73243-c579-4c4c-a9d2-2d5706c11dac
* UsersGuide.texjthorn2002-03-26
| | | | | | | | | | | | | | | | | | | | | | * rework FunctionDescription environment to fix a number of latex formatting problems: now uses latex list (similar to existing Lentry environment), so text for individual items is now a list \item, rather than in a minipage environment as before --> page breaking works properly (finally!); in particular, long examples are now page-broken properly, rather than running off the bottom of the page like they did before --> \NewPar (for paragraph breaks in items) no longer needed, now the ordinary tex leave-a-blank-line (gives \par) works fine Alas, the new format requires changes in how the environment is used, hence the corresponding changes to FunctionReference.tex FunctionReference.tex * make changes in each use of the FunctionDescription environment to match new definition of that environment * fix memory leak in Util_TableItQueryKeyValueInfo() example git-svn-id: http://svn.cactuscode.org/flesh/trunk@2672 17b73243-c579-4c4c-a9d2-2d5706c11dac
* UsersGuide.texjthorn2002-03-23
| | | | | | | | | | | | | add \Cplusplus macro to properly typeset "C++" FunctionReference.tex in CCTK_InterpLocalUniform() example, fix array initializations that were valid C++ but not C, and add a paragraph outlining the problem (thanks to Ian Hawke for pointing this out!) git-svn-id: http://svn.cactuscode.org/flesh/trunk@2662 17b73243-c579-4c4c-a9d2-2d5706c11dac
* add new chapter "Utility Routines",jthorn2001-12-20
| | | | | | | | | | initially containing programming guide for the key/value tables routines. also renumber all the other cactusparts, i.e. utility routines is now C, Infrastructure Thorn Writer's Guide is now D, Function Reference E, etc git-svn-id: http://svn.cactuscode.org/flesh/trunk@2522 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Fixed many many bugs and typos. (Many more remain.) Cleaned uprideout2001-12-17
| | | | | | | | | | numerous sections. Added some clarifications. Closes Cactus/508 (I think, though he mentioned a section which doesn't seem to exist). Partly closes Cactus/696. git-svn-id: http://svn.cactuscode.org/flesh/trunk@2508 17b73243-c579-4c4c-a9d2-2d5706c11dac
* UsersGuide.texjthorn2001-11-13
| | | | | | | | | | | | | | | | Add new environment FunctionDescription , to be used for detailed function descriptions. This could in the future replace the existing CCTKFunc environment -- it has mostly a superset of that one's features (but if misses a few others). FunctionReference.tex Add descriptions of new Util_Table* table functions. Also add commented-out entries in table of contents for all other Util_* functions found by grepping Cactus/src/util/*.c for @routine git-svn-id: http://svn.cactuscode.org/flesh/trunk@2463 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Adding stuff for PDFallen2001-07-04
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@2268 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Starting to work on revamping parts of users guideallen2001-05-05
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@2144 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Getting the parskip right for the table of contentsallen2001-04-09
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@2105 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Smaller ps diagram for front pageallen2001-04-09
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@2100 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Resetting the parindent and parskip after the front page.allen2001-02-23
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@2044 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Fixed typo in function reference template: Synopis -> Synopsis.tradke2001-02-17
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@2028 17b73243-c579-4c4c-a9d2-2d5706c11dac
* grdoc.goodale2000-02-04
| | | | | | | Tom git-svn-id: http://svn.cactuscode.org/flesh/trunk@1360 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Added the Cactus logo to the front page.goodale1999-09-24
| | | | | | | Tom git-svn-id: http://svn.cactuscode.org/flesh/trunk@988 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Changes, updates and improvementsallen1999-09-24
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@985 17b73243-c579-4c4c-a9d2-2d5706c11dac
* final corrections to docsallen1999-07-30
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@847 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Added to Tom's commands so there is a \showcargs if you on;yallen1999-07-26
| | | | | | | have a C function git-svn-id: http://svn.cactuscode.org/flesh/trunk@785 17b73243-c579-4c4c-a9d2-2d5706c11dac
* New Part: Function Referenceallen1999-07-21
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@756 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Added a new description environment that copies the typical UNIX man page layoutlanfer1999-07-12
| | | | | | | | | for flags. If you liek this I will move some of the itemize env. over to this style. gerd git-svn-id: http://svn.cactuscode.org/flesh/trunk@696 17b73243-c579-4c4c-a9d2-2d5706c11dac
* It does help to turn fancy headings on !goodale1999-07-12
| | | | | | | Tom git-svn-id: http://svn.cactuscode.org/flesh/trunk@695 17b73243-c579-4c4c-a9d2-2d5706c11dac
* New formatting for the document -goodale1999-07-12
| | | | | | | | | | | | | parts are now A,B,C... page numbers are of the for A1/A15 and locally numbered within parts chapter number are off the form A3 and locally numbered within parts pages have footers saying (hopefully) the filname and RCS version number new title page Tom git-svn-id: http://svn.cactuscode.org/flesh/trunk@694 17b73243-c579-4c4c-a9d2-2d5706c11dac
* New LaTeX macros for formatting descriptions of functions.goodale1999-07-08
| | | | | | | Tom git-svn-id: http://svn.cactuscode.org/flesh/trunk@687 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Partly added macros to describe routines, but hit a problemallen1999-06-01
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@537 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Forgot to take out footer experiment stuffallen1999-02-14
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@268 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Changes for changing names build->config and Standard Toolkit -> Base Packageallen1999-02-14
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@267 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Renamed files so that we don't have to change numbers to add parts.allen1999-02-12
| | | | | | | Started adding functions to the Infrastructure part. git-svn-id: http://svn.cactuscode.org/flesh/trunk@237 17b73243-c579-4c4c-a9d2-2d5706c11dac
* split off the three partslanfer1999-02-03
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@202 17b73243-c579-4c4c-a9d2-2d5706c11dac
* section on architecture and requ. softwarelanfer1999-02-03
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@201 17b73243-c579-4c4c-a9d2-2d5706c11dac
* A couple of minor mods to make things neater.goodale1999-02-03
| | | | | | | Tom git-svn-id: http://svn.cactuscode.org/flesh/trunk@191 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Answered a few of Carsten's queries.goodale1999-02-03
| | | | | | | | | | | Put versioning info in (or at least i hope it works 8-) Made the appendices a seperate part, which should make the html version look nicer. Tom git-svn-id: http://svn.cactuscode.org/flesh/trunk@190 17b73243-c579-4c4c-a9d2-2d5706c11dac
* More information into the "Configuration file syntax" appendix.allen1999-02-02
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@183 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Additions to Interface sectionallen1999-02-02
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@173 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Proofread the introduction, and added material on thorn compilation from Tom'sgundlach1999-01-28
| | | | | | | email. Also removed some blank parts at the end to save paper. git-svn-id: http://svn.cactuscode.org/flesh/trunk@127 17b73243-c579-4c4c-a9d2-2d5706c11dac
* An attempt to save paper.gundlach1999-01-27
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@126 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Checkin of UsersGuide in progress.gundlach1999-01-27
git-svn-id: http://svn.cactuscode.org/flesh/trunk@125 17b73243-c579-4c4c-a9d2-2d5706c11dac
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-11 02:05:16 +0000