← Back to branch summary

~ubuntu-branches/ubuntu/feisty/fpc/feisty

« back to all changes in this revision

Viewing changes to fpcdocs/fpc.sty.doc

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2007-01-27 20:08:50 UTC
  • mfrom: (1.2.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070127200850-9mrptaqqjsx9nwa7
Tags: 2.0.4-5
* Fixed Build-Depends.
* Add myself to Uploaders in debian/control.
* Make sure that the sources are really patched before building them.
* Build unit 'libc' on powerpc too.

Show diffs side-by-side

added added

removed removed

Lines of Context:
fpcdocs/fpc.sty.doc
 
1
fpc.sty defines the following:
 
2
 
 
3
\procedure{name}{args}{desc}{errs}{seealso}
 
4
\Procedure{name}{desc}{errs}{seealso}
 
5
\function{name}{args}{return-type}{desc}{errs}{seealso}
 
6
\Function{name}{return-type}{desc}{errs}{seealso}
 
7
 
 
8
here is:
 
9
name : the name of the function/procedure
 
10
args : the (optional) arguments. type them between (), the sty doesn't add
 
11
them.
 
12
desc : the description of what it does. This can be very long.
 
13
errs : possible errors, and what the function then does.
 
14
seealso : info about related commands.
 
15
 
 
16
Each procedure/punction call produces a subsection. it adds a label
 
17
'pro:name' or 'fu:name' and an index entry 'name'.
 
18
then it gives the declaration as in the pascal file,
 
19
it adds the description, the errors and see also, all in a list.
 
20
the Capital letter commands are shorthands for if the function has no
 
21
arguments (such as WhereX or so in crt.)
 
22
 
 
23
So the above \function would produce:
 
24
 
 
25
name    (format of subsection)
 
26
------------------------------------
 
27
 
 
28
Declaration: name args : return-type
 
29
 
 
30
Description : desc
 
31
 
 
32
Errors : errs
 
33
 
 
34
See also : seealso
 
35
 
 
36
The style redifines the \maketitle command, and adds a
 
37
\description{Your description goes here}
 
38
\version{Your version goes here}
 
39
command, which produces something on the titlepage. (see the docs for
 
40
examples)
 
41
 
 
42
it also defines 
 
43
\var{arg}
 
44
which typesets in \texttt its argument
 
45
 
 
46
\seef{name}
 
47
makes a cross reference (pageref) to function name (be careful about capitals).
 
48
\seep{name}
 
49
makes a cross reference (pageref) to procedure name..
 
50
\seem{man}{sec}
 
51
produces a reference to a UNIX man page. as in : 
 
52
man (sec)
 
53
 
 
54
For nice typesetting it defines also \fpc, which nicely formats the name of
 
55
the compiler.
 
56
 
 
57
Then it defines also
 
58
\linux
 
59
\dos
 
60
\msdos
 
61
\ostwo
 
62
\windowsnt
 
63
\windows
 
64
commands, which just typeset in small caps the name of the OS's...
 
65
 
 
66
I think that's about it.
 
67
Michael.