661
edits
Help text style guide: Difference between revisions
Jump to navigation
Jump to search
→TexInfo: add section for line limit of examples (from the removed manual section on contribution guidelines)
Carandraug (talk | contribs) (→Formatting: change subsections by what a user may want and not by existing evironments. Also explain how to add TeX mathematical formulas) |
Carandraug (talk | contribs) (→TexInfo: add section for line limit of examples (from the removed manual section on contribution guidelines)) |
||
| Line 27: | Line 27: | ||
= TexInfo = | = TexInfo = | ||
This is the preferred format for help text. There is also a comprehensive [http://www.gnu.org/software/texinfo/manual/texinfo/html_node/index.html TexInfo manual]. | This is the preferred format for help text. There is also a comprehensive [http://www.gnu.org/software/texinfo/manual/texinfo/html_node/index.html TexInfo manual]. | ||
== Examples == | |||
If you give a code example in the documentation written in Texinfo with | |||
the {{codeline|@example}} environment, you should be aware that the text | |||
within such an environment will not be wrapped. It is recommended that | |||
you keep the lines short enough to fit on pages in the generated pdf or | |||
ps documents. That means, keep the lines of examples under 60 characters. | |||
== Octave specific macros == | == Octave specific macros == | ||