PageRenderTime 9ms CodeModel.GetById 2ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 1ms

/contrib/cvs/doc/HACKING.DOCS

https://bitbucket.org/freebsd/freebsd-head/
Unknown | 46 lines | 40 code | 6 blank | 0 comment | 0 complexity | 549d33b2dfeaa9c31679b743d19b0134 MD5 | raw file
 1Here's some of the texinfo conventions the CVS documentation uses:
 2
 3@code{ ... }			command usage & command snippets, including
 4				command names.
 5@var{ ... }			variables - text which the user is expected to
 6				replace with some meaningful text of their own
 7				in actual usage.
 8@file{ ... }			file names
 9@samp{ ... }			for most anything else you need quotes around
10				(often still misused for command snippets)
11@example ... @end example	example command usage and output, etc.
12@emph{ ... }			emphasis - warnings, stress, etc.  This will be
13				bracketed by underline characters in info files
14				(_ ... _) and in italics in PDF & probably in
15				postscript & HTML.
16@strong{ ... }			Similar to @emph{}, but the effect is to
17				bracket with asterisks in info files (* ... *)
18				and in bold in PDF & probably in postscript &
19				HTML.
20@noindent			Suppresses indentation of the following
21				paragraph.  This can ocassionally be useful
22				after examples and the like.
23@cindex ...			Add a tag to the index.
24@pxref{ ... }			Cross reference in parentheses.
25@xref{ ... }			Cross reference.
26
27Preformatted text should be marked as such (use @example... there may be other
28ways) since many of the final output formats can use relational fonts otherwise
29and marking it as formatted should restrict it to a fixed width font.  Keep
30this sort of text to 80 characters or less per line since larger may not be
31properly viewable for some info users.
32
33There are dictionary lists and function definition markers.  Scan cvs.texinfo
34for their usage.  There may be table definitions as well but I haven't used
35them.
36
37Use lots of index markers.  Scan the index for the current style.  Try to reuse
38an existing entry if the meaning is similar.
39
40`makeinfo' 3.11 or greater is required for output generation since earlier
41versions do not support the @ifnottex & @ifnothtml commands.  There may be
42other commands used in `cvs.texinfo' that are unsupported by earlier versions
43of `makeinfo' by the time you read this.
44
45For more on using texinfo docs, see the `info texinfo' documentation or
46http://www.gnu.org/manual/texinfo/texinfo.html .