This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | Next revisionBoth sides next revision |
| reference:help_formatting [2017/02/07 07:25] – [Categories] universal gawrilow | reference:help_formatting [2017/02/07 07:28] – [Markup] gawrilow |
|---|
| | |
| ===== Markup ===== | ===== Markup ===== |
| A modest markup is allowed in the texts, faintly resembling the syntax of Wiki you are just reading: ''%%//%%''//italics//''%%//%%'', ''%%**%%''**bold**''%%**%%'', ''%%__%%''__underlined__''%%__%%'', simple HTML tags like ''%%<sub>%%''index''%%</sub>%%'' or ''%%<sup>%%''power''%%</sup>%%'', as well as references to other ''%%[[%%''topics''%%]]%%'' or ''%%[[wiki:%%''page''%%#%%''anchor''|''Wiki pages''%%]]%%'' . You should use them sparingly, however, because they can clutter the on-screen presentation and even render it completely illegible. | A modest markup is allowed in the texts, faintly resembling the syntax of Wiki you are just reading: ''%%//%%''//italics//''%%//%%'', ''%%**%%''**bold**''%%**%%'', ''%%__%%''__underlined__''%%__%%'', simple HTML tags like ''%%<sub>%%''index''%%</sub>%%'' or ''%%<sup>%%''power''%%</sup>%%'', mathematical symbol entities like ''%%⊕%%'' as well as references to other ''%%[[%%''topics''%%]]%%'' or ''%%[[wiki:%%''page''%%#%%''anchor''|''Wiki pages''%%]]%%'' . You should use them sparingly, however, because they can clutter the on-screen presentation and even render it completely illegible. |
| ===== Examples ===== | ===== Examples ===== |
| Help blocks may contain examples illustrating typical use cases or clarifying the exact semantics. In particular, documentation of functions and properties which are likely to be looked at by beginners should be accompanied with easy to understand examples. The examples should be valid perl/polymake commands which could be copied verbatim into the interactive shell and executed. If appropriate, an example can contain the response expected to appear on the screen. | Help blocks may contain examples illustrating typical use cases or clarifying the exact semantics. In particular, documentation of functions and properties which are likely to be looked at by beginners should be accompanied with easy to understand examples. The examples should be valid perl/polymake commands which could be copied verbatim into the interactive shell and executed. If appropriate, an example can contain the response expected to appear on the screen. |