How to use this

$ debiandoc2text example.sgml $ debiandoc2html example.sgml $ debiandoc2latexpdf example.sgml General Notes

Case and quotation

Distribution codenames uppercase: Potato, Woody

Use "..." (double quotations, American usage) for most quotation. "..." becomes a set of curly quotes in PDF but source SGML code is a set of straight double quotes.

Use `' (grave and apostrophe in source SGML) to quote a letter or key name: type `S' (Rationale: printed output converts "..." to curly quotes, but doesn't convert '' similary. `' convert set of curly single quote and looks better. Also, text output uses `...' for cross-ref quotation.) No need to use any quotation with tt-tags like `<tt>...</tt>'.

For terms like "bash", "perl", and "awk" that double as command names and names of programming languages, use: capitalized name when referring to the language. Likewise, capitalize a program name when used to describe a well-known program suite: Exim, Mutt, Elm, Vim, Samba, Emacs, etc. <prgn> tag for the program command. <tt> tag for the program command with command line options. <file> tag for the full path file or directory name. Thus: The developer of Perl is Larry Wall To check your Perl version, use perl -V. (taged as <tt>...</tt>) perl (taged as <prgn>...</prgn>) should be located in /usr/bin (taged as <file>...</file>) See next sections for more on tags. Inline tags

Followings will elucidate effect of each tag (check result in each format, wrapping is enabled for these tags.): "em" — emphasis, _text_ HTML=italics "strong" — more emphasis, _text_ HTML=PDF=BOLD "var" — metasyntactic variable, <text> HTML=PDF=italics "prgn" — program-name-or-well-known-file-name, `text' HTML=PDF=fix "package" — package-name, `text' HTML=PDF=fix "file" — /full/path/file/or/directory/name, `text' HTML=PDF=fix "tt" — terminal input/output with metasyntactic variable, `text' HTML=PDF=fix (variable=italics fix) Example tag

<example> tag is good for terminal interaction, table, ... where no-wrapping is desirable. <example> 0 1 2 3 4 5 6 7 123456789012345678901234567890123456789012345678901234567890123456789012 <- must be liess than 72 char (70 better) per line within example tag -> this is because this section is not wrapped. # root-shell-command <var>variable</var> # sgml original # root-shell-command variable # result $ user-shell-command <var>variable</var> $ user-shell-command variable </example> Examples of SGML Cross reference

<ref id="inline-tag">: <manref name="ls" section="1">: <url id="http://www.debian.org" name="Debian">: List

This section illustrates how list-types render SGML. Compare results with the source. Tag-list has some limitation in wrapping.

List: Item 1 (simple list) Item 1.1 (sublist) Item 1.2 (sublist) Item 2. Long list of words will wrap line into next line. Long list of words will wrap line into next line. Long list of word will wrap line into next line. Long list of word will wrap line into next line.

Paragraph Item 3 Item 4

Enumlist: Item 1 (simple enumlist) Item 1.1 (sub-enumlist) Item 1.2 (sub-enumlist) Item 2 Long list of words will wrap line into next line. Long list of words will wrap line into next line. Long list of words will wrap line into next line.

Paragraph Long list of words will wrap line into next line. Long list of words will wrap line into next line. Long list of words will wrap line into next line. Item 3 Item 3.1 (sublist) Item 3.2 (sublist) Item 4 Taglist: Tag 1 Item 1 (simple taglist) Item 1.1 (sub-enumlist) Item 1.2 (sub-enumlist) Tag 2 Long list of words will wrap line into next line. Long list of words will wrap line into next line. Long list of words will wrap line into next line. Item 2 Long list of words will wrap line into next line. Long list of words will wrap line into next line. Long list of words will wrap line into next line.

Paragraph Long list of words will wrap line into next line. Long list of words will wrap line into next line. Long list of words will wrap line into next line. Tag 3 Item 3 Item 3.1 (sublist) Item 3.2 (sublist) Tag 4 Item 4 Word convention

Alphabetical list of word convention: APT # an acronym, not a single program name auto-start back end boot disk chip set codename conffile de-install email filename file system hard link multi-byte multi-user multi-volume nameserver non-developers on-screen overwrite post-configuration pre-release reconfigure record-keeping regular-expression (adj.) runlevel setup single-user (adj.) start-up sysadmin Web Web page website