X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=contrib%2FSTANDARDS;h=c66f77b57904a776d27d849e5f8ed17cc1e0b1cf;hb=31fbadea3713c2024fd1ac0d881f40f44b9f0df7;hp=80b0b58899d70e499e28a64687969bcbce85d1a0;hpb=6387a29a5c3aae2cb319dcaf803fb2df24eea46d;p=sbcl.git diff --git a/contrib/STANDARDS b/contrib/STANDARDS index 80b0b58..c66f77b 100644 --- a/contrib/STANDARDS +++ b/contrib/STANDARDS @@ -71,11 +71,23 @@ good place to test that they still exist, etc. * Documentation -[ Would be at least nice. My tendency is to say plain text or HTML, -and optionally your choice of source format which can generate either -of the preceding. Document formats not available on typical -well-endowed-with-free-stuff Unix systems are discouraged. DocBook -is fine, as the SBCL manual is DocBook anyway ] +Each package should provide documentation in Texinfo format. For the +documentation to be included in the sbcl manual, the following must +hold: + +- Each Texinfo file must have the extension `.texinfo' so the + automatic manual builder will find it. + +- It must contain one @node - @section pair at the top and only + @subsection (or lower) sectioning commands within, e.g. + +@node Sample Contrib +@section Sample Contrib +... + + so that the contrib menu can be created automatically. + +Take care to choose unique node names. [ make install should copy the documentation somewhere that the user can find it ]