/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

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