diff options
author | jthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2002-04-03 13:19:12 +0000 |
---|---|---|
committer | jthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2002-04-03 13:19:12 +0000 |
commit | 4eed31e178ec82880cd27d785aac7fe13dc17bf2 (patch) | |
tree | afb725eed647bb2d209771d34deb13c6dbb65d8b /doc | |
parent | 13ffbdd8d610ff5dcf2b9b5876160ae3a00e84f7 (diff) |
revise FunctionDescription environment a bit so that the "See Also"
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
Diffstat (limited to 'doc')
-rw-r--r-- | doc/UsersGuide/UsersGuide.tex | 26 |
1 files changed, 21 insertions, 5 deletions
diff --git a/doc/UsersGuide/UsersGuide.tex b/doc/UsersGuide/UsersGuide.tex index 5f50b055..2e005536 100644 --- a/doc/UsersGuide/UsersGuide.tex +++ b/doc/UsersGuide/UsersGuide.tex @@ -216,7 +216,7 @@ % % Alternate environments/macros to define function descriptions % (can/should be used to replace CCTKFunc environment) -% Jonathan Thornburg, 10 Nov 2001 +% Jonathan Thornburg, 10 Nov 2001, revised 26 Mar 2002 & 3 Apr 2002 % % Usage: % \begin{FunctionDescription}{name} @@ -349,6 +349,22 @@ }%%% }%%% {\end{list}}%%% +\newenvironment{FunctionDescriptionWideEntry} + {%%% + \begin{list}%%% + {}%%% + {%%% + \renewcommand{\makelabel}{\Lentrylabel}%%% + \setlength{\topsep}{0ex}%%% + \setlength{\partopsep}{0ex}%%% + \setlength{\itemsep}{0ex}%%% + \setlength{\labelwidth}{16em}%%% + \setlength{\leftmargin}{\labelwidth+\labelsep}%%% + \setlength{\itemindent}{0em}%%% + \setlength{\listparindent}{0em}%%% + }%%% + }%%% + {\end{list}}%%% % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % @@ -388,17 +404,17 @@ \newenvironment{SeeAlsoSection} {%%% \par\noindent{\bf See Also} - \begin{FunctionDescriptionEntry} + \begin{FunctionDescriptionWideEntry} }%%% - {\end{FunctionDescriptionEntry}} + {\end{FunctionDescriptionWideEntry}} \newenvironment{SeeAlso}[1]{\item[\tt ##1]}{} % \newenvironment{ErrorSection} {%%% \par\noindent{\bf Errors} - \begin{FunctionDescriptionEntry} + \begin{FunctionDescriptionWideEntry} }%%% - {\end{FunctionDescriptionEntry}} + {\end{FunctionDescriptionWideEntry}} \newenvironment{Error}[1]{\item[\tt ##1]}{} % \newenvironment{ExampleSection} |