Python/libs/pygments-lexer-pseudocode2: docs/lexer-algpseudocode.rst annotate

annotate docs/lexer-algpseudocode.rst @ 277:a5c96fdd1cb3

Wording in docs

author	Franz Glasner <fzglas.hg@dom66.de>
date	Wed, 20 May 2026 12:10:47 +0200
parents	397ed930a5ba
children	315e94bac8a7

rev	line source
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1 .. -- coding: utf-8; indent-tabs-mode: nil; --
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	3
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	4 *************************************
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	5 AlgPseudocode and Language Variants
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	6 *************************************
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	7
263 2e78e255b54e Make a link to the reST source where appropriate to learn about the lexer syntax Franz Glasner <fzglas.hg@dom66.de> parents: 241 diff changeset	8 .. only:: html
2e78e255b54e Make a link to the reST source where appropriate to learn about the lexer syntax Franz Glasner <fzglas.hg@dom66.de> parents: 241 diff changeset	9
265 e5ea2f955986 Optimize documentation layout: use a local ToC where appropriate (lexers, filters) Franz Glasner <fzglas.hg@dom66.de> parents: 263 diff changeset	10 .. contents::
e5ea2f955986 Optimize documentation layout: use a local ToC where appropriate (lexers, filters) Franz Glasner <fzglas.hg@dom66.de> parents: 263 diff changeset	11
e5ea2f955986 Optimize documentation layout: use a local ToC where appropriate (lexers, filters) Franz Glasner <fzglas.hg@dom66.de> parents: 263 diff changeset	12 .. only:: html
e5ea2f955986 Optimize documentation layout: use a local ToC where appropriate (lexers, filters) Franz Glasner <fzglas.hg@dom66.de> parents: 263 diff changeset	13
263 2e78e255b54e Make a link to the reST source where appropriate to learn about the lexer syntax Franz Glasner <fzglas.hg@dom66.de> parents: 241 diff changeset	14 .. hint::
2e78e255b54e Make a link to the reST source where appropriate to learn about the lexer syntax Franz Glasner <fzglas.hg@dom66.de> parents: 241 diff changeset	15 The reST source of this documentation page can be found
2e78e255b54e Make a link to the reST source where appropriate to learn about the lexer syntax Franz Glasner <fzglas.hg@dom66.de> parents: 241 diff changeset	16 `here <_sources/lexer-algpseudocode.rst.txt>`_.
2e78e255b54e Make a link to the reST source where appropriate to learn about the lexer syntax Franz Glasner <fzglas.hg@dom66.de> parents: 241 diff changeset	17
192 156bcd310596 FIX: duplicate word Franz Glasner <fzglas.hg@dom66.de> parents: 187 diff changeset	18 These lexers are heavily inspired by CTAN’s `Algpseudocodex`_.
201 b6a959c31bed Wording Franz Glasner <fzglas.hg@dom66.de> parents: 194 diff changeset	19 They recognize all sorts of single- and multi-line comments in addition to
b6a959c31bed Wording Franz Glasner <fzglas.hg@dom66.de> parents: 194 diff changeset	20 expressions and commands that are inspired by `Algpseudocodex`_.
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	21
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	22 They are used in `Sphinx`_ using their aliases.
268 ea19b621081d Consistently write code blocks in the documentation text as "code block". Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	23 The code block:
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	24
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	25 .. code-block:: none
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	26
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	27 .. code-block:: algpseudocode
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	28
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	29 \PROGRAM {The Pseudoprogram} \IS
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	30
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	31 \END PROGRAM {The Pseudoprogram}
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	32
186 95754197f5b3 Link to some source code of example pseudocode files Franz Glasner <fzglas.hg@dom66.de> parents: 172 diff changeset	33 will be rendered as:
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	34
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	35 .. code-block:: algpseudocode
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	36
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	37 \PROGRAM {The Pseudoprogram} \IS
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	38
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	39 \END PROGRAM {The Pseudoprogram}
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	40
268 ea19b621081d Consistently write code blocks in the documentation text as "code block". Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	41 And the same code block with the german variant
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	42 (using ``.. code-block:: algpseudocode-de`` as language alias):
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	43
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	44 .. code-block:: algpseudocode-de
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	45
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	46 \PROGRAM {The Pseudoprogram} \IS
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	47
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	48 \END PROGRAM {The Pseudoprogram}
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	49
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	50
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	51 States
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	52 ======
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	53
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	54 The AlgPseudocode lexer and its language variants AlgPseudocodeDE and
208 de7118d299e9 Aliases for states: context or mode Franz Glasner <fzglas.hg@dom66.de> parents: 207 diff changeset	55 AlgPseudocodeFR basically work in three states (aka modes or contexts):
de7118d299e9 Aliases for states: context or mode Franz Glasner <fzglas.hg@dom66.de> parents: 207 diff changeset	56 `default`, `expression` and `text`.
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	57
208 de7118d299e9 Aliases for states: context or mode Franz Glasner <fzglas.hg@dom66.de> parents: 207 diff changeset	58 In `expressions` it automatically recognizes:
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	59
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	60 - Strings (single-quote, double-quote, triple-single-quote,
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	61 triple-double-quote, `Python`_ style)
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	62 - Numbers (also `Python`_ style)
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	63 - (Mathematical) operators and symbols
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	64 - ``\TEXT{...}``
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	65
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	66 Used to switch to a text-mode that prohibits automatic expression
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	67 highlighting.
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	68
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	69 A closing curly brace can be quoted with ``\}`` to not end the
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	70 text mode prematurely.
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	71
212 18553f595b34 Allow nested \TEXT and \EXPR commands. Franz Glasner <fzglas.hg@dom66.de> parents: 209 diff changeset	72 - ``\EXPR`` or ``\EXPRESSION`` as nested construct
18553f595b34 Allow nested \TEXT and \EXPR commands. Franz Glasner <fzglas.hg@dom66.de> parents: 209 diff changeset	73
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	74 - ``\NAME``, ``\CALL`` and ``\GETS``
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	75
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	76 - ``\REM`` and ``\REMARK`` for remarks (aka comments)
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	77
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	78 - Names (`Name.Entity`)
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	79
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	80 - :ref:`explicit-token-types`
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	81
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	82 The `default`-mode is an extension of `expression`:
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	83 in addition to `expressions` it recognizes all sorts of single- and
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	84 multi-line comments and commands that are inspired by `Algpseudocodex`_.
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	85
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	86 In `text` context it recognizes:
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	87
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	88 - ``\EXPR`` or ``\EXPRESSION``
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	89
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	90 Use to switch to expression-mode.
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	91
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	92 A closing curly brace can be quoted with ``\}`` to not end the expression
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	93 mode prematurely.
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	94
212 18553f595b34 Allow nested \TEXT and \EXPR commands. Franz Glasner <fzglas.hg@dom66.de> parents: 209 diff changeset	95 - ``\TEXT`` as nested construct
18553f595b34 Allow nested \TEXT and \EXPR commands. Franz Glasner <fzglas.hg@dom66.de> parents: 209 diff changeset	96
168 bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	97 - ``\REM`` and ``\REMARK`` for remarks (aka comments)
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	98
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	99 - :ref:`explicit-token-types`
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	100
bff8b900713a REFACTOR: All documentation pages refactored: merge intro and details for lexers and filters Franz Glasner <fzglas.hg@dom66.de> parents: 165 diff changeset	101
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	102 Lexer Options
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	103 =============
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	104
160 b4028838e0c8 Implement lexer option "prohibit_raiseonerror_filter". Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	105 .. describe:: prohibit_raiseonerror_filter
b4028838e0c8 Implement lexer option "prohibit_raiseonerror_filter". Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	106
165 88f872c50aae Markup of Python objects in docs Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	107 Type: :py:class:`bool`
160 b4028838e0c8 Implement lexer option "prohibit_raiseonerror_filter". Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	108
172 ad80fcbf7b47 Docs formatting Franz Glasner <fzglas.hg@dom66.de> parents: 169 diff changeset	109 Default: :py:obj:`None`
160 b4028838e0c8 Implement lexer option "prohibit_raiseonerror_filter". Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	110
172 ad80fcbf7b47 Docs formatting Franz Glasner <fzglas.hg@dom66.de> parents: 169 diff changeset	111 If :py:obj:`True` the `raiseonerror` filter is not allowed to be
ad80fcbf7b47 Docs formatting Franz Glasner <fzglas.hg@dom66.de> parents: 169 diff changeset	112 applied by `Sphinx`_ when :py:meth:`Lexer.add_filter` is called.
165 88f872c50aae Markup of Python objects in docs Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	113
160 b4028838e0c8 Implement lexer option "prohibit_raiseonerror_filter". Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	114 This setting does not apply to filters that are set by the standard
b4028838e0c8 Implement lexer option "prohibit_raiseonerror_filter". Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	115 lexer option `filters`.
b4028838e0c8 Implement lexer option "prohibit_raiseonerror_filter". Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	116
142 5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	117 .. describe:: no_end
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	118
165 88f872c50aae Markup of Python objects in docs Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	119 Type: :py:class:`bool`
142 5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	120
172 ad80fcbf7b47 Docs formatting Franz Glasner <fzglas.hg@dom66.de> parents: 169 diff changeset	121 Default: :py:obj:`False`
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	122
172 ad80fcbf7b47 Docs formatting Franz Glasner <fzglas.hg@dom66.de> parents: 169 diff changeset	123 If :py:obj:`True` all the ``\ENDxxx`` commands will be skipped and yield
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	124 no output.
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	125
142 5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	126 .. describe:: gets
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	127
165 88f872c50aae Markup of Python objects in docs Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	128 Type: :py:class:`str` or :py:obj:`None`
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	129
212 18553f595b34 Allow nested \TEXT and \EXPR commands. Franz Glasner <fzglas.hg@dom66.de> parents: 209 diff changeset	130 Default: :py:obj:`None` (yields ``⟵``)
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	131
142 5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	132 The operator symbol to be printed by the command ``\GETS``.
5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	133
5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	134 An often used alternative is ``:=``.
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	135
142 5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	136 .. describe:: remark
5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	137
165 88f872c50aae Markup of Python objects in docs Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	138 Type: :py:class:`str` or :py:obj:`None`
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	139
172 ad80fcbf7b47 Docs formatting Franz Glasner <fzglas.hg@dom66.de> parents: 169 diff changeset	140 Default: :py:obj:`None` (yields ``▷``)
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	141
142 5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	142 The symbol to be printed as when starting comments with
5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	143 ``\REMARK`` or ``\REM``.
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	144
144 b616f9645e37 More referencing with internal and external links Franz Glasner <fzglas.hg@dom66.de> parents: 142 diff changeset	145 To use a lexer with non-default options in `Sphinx`_ see section
b616f9645e37 More referencing with internal and external links Franz Glasner <fzglas.hg@dom66.de> parents: 142 diff changeset	146 :ref:`customized-sphinx-lexers`.
b616f9645e37 More referencing with internal and external links Franz Glasner <fzglas.hg@dom66.de> parents: 142 diff changeset	147
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	148
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	149 Comments
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	150 ========
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	151
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	152 - with the ``\REMARK`` or ``\REM`` keywords
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	153 (until the end of the line; the output includes a leading symbol,
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	154 by default ``▷``)
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	155 - multi-line comments with ``/* ... /``; they can be nested*
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	156 - multi-line comments with ``(* ... )``; they can be nested*
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	157 - single-line comments with ``//`` or ``#`` (until the end of the line)
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	158
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	159 .. code-block:: algpseudocode
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	160
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	161 /*
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	162 * A single multiline comment
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	163 */
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	164
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	165 /*
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	166 * A multiline comment
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	167 *
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	168 * /* This is a nested multi-line comment */
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	169 *
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	170 */
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	171
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	172 (*
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	173 * A multiline comment
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	174 *
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	175 * (* This is a nested multi-line comment *)
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	176 *
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	177 *)
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	178
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	179 // A single-line comment
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	180
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	181 # A single-line comment
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	182
213 d470250f8451 Title/metadata of PDF documentation builds: Franz Glasner <fzglas.hg@dom66.de> parents: 212 diff changeset	183 \REM A remark is a single-line comment with a leading symbol
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	184
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	185
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	186 Literals
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	187 ========
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	188
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	189 Strings and numbers as in `Python`_.
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	190 String prefixes ``u`` and ``b`` are supported---prefixes
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	191 ``r``, ``f`` and ``t`` are not supported.
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	192
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	193 To have non-string-delimiting single- and double-quotes in the output you
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	194 have to escape them using ``\'`` or ``\"``.
274 77cfab93a60e FIX: Example when escaping string delimiters Franz Glasner <fzglas.hg@dom66.de> parents: 269 diff changeset	195 This must be used to typeset something as :algpseudocode:`f\'(x) = 0`.
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	196
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	197 .. code-block:: algpseudocode
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	198
241 7df1fd3bab87 In the number example use 1234567890 also Franz Glasner <fzglas.hg@dom66.de> parents: 237 diff changeset	199 0 1234567890 0xdead 0b100001 0o720 2.7 2.7e-54
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	200
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	201 "A string with an escaped double-quote \" "
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	202
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	203 'Another string with an escaped single-quote \' '
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	204
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	205 """A multiline
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	206 string
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	207 """
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	208
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	209 '''Another multiline string
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	210
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	211 '''
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	212
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	213 b"A \x20 byte string"
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	214
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	215 u'An explicit Unicode \u1234 string'
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	216
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	217 \" a non string
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	218
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	219 \' a non string also
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	220
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	221
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	222 (Mathematical) Symbols and Operators
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	223 ====================================
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	224
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	225 Some ASCII symbol combinations are recognized and replaced by a
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	226 Unicode symbol:
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	227
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	228 .. code-block:: algpseudocode
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	229
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	230 \TEXT{<=>} <=>
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	231 \TEXT{<->} <->
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	232 \TEXT{<-} <-
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	233 \TEXT{->} ->
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	234 \TEXT{=>} =>
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	235 \TEXT{<=} <=
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	236 \TEXT{>=} >=
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	237 \TEXT{<>} <>
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	238 \TEXT{!=} !=
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	239 \TEXT{:=} :=
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	240 \TEXT{=:} =:
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	241 \TEXT{?=} ?=
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	242
277 a5c96fdd1cb3 Wording in docs Franz Glasner <fzglas.hg@dom66.de> parents: 276 diff changeset	243 Unicode codepoints with property ``Sm`` are recognized as mathematical symbols
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	244 and highlighted accordingly.
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	245
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	246
159 4ee0b1536ea6 Handle runs of dots in expressions (., .., ..., ...., ...) Franz Glasner <fzglas.hg@dom66.de> parents: 158 diff changeset	247 Punctuation
4ee0b1536ea6 Handle runs of dots in expressions (., .., ..., ...., ...) Franz Glasner <fzglas.hg@dom66.de> parents: 158 diff changeset	248 ===========
4ee0b1536ea6 Handle runs of dots in expressions (., .., ..., ...., ...) Franz Glasner <fzglas.hg@dom66.de> parents: 158 diff changeset	249
4ee0b1536ea6 Handle runs of dots in expressions (., .., ..., ...., ...) Franz Glasner <fzglas.hg@dom66.de> parents: 158 diff changeset	250 Runs of dots ``.``, ``..``, ``...``, ``....``, ... are handled
4ee0b1536ea6 Handle runs of dots in expressions (., .., ..., ...., ...) Franz Glasner <fzglas.hg@dom66.de> parents: 158 diff changeset	251 properly in expressions and yield a punctuation token.
4ee0b1536ea6 Handle runs of dots in expressions (., .., ..., ...., ...) Franz Glasner <fzglas.hg@dom66.de> parents: 158 diff changeset	252 They are not replaced by corresponding Unicode symbols.
4ee0b1536ea6 Handle runs of dots in expressions (., .., ..., ...., ...) Franz Glasner <fzglas.hg@dom66.de> parents: 158 diff changeset	253
4ee0b1536ea6 Handle runs of dots in expressions (., .., ..., ...., ...) Franz Glasner <fzglas.hg@dom66.de> parents: 158 diff changeset	254
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	255 Commands
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	256 ========
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	257
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	258 - Start with a backslash character ``\``
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	259 - Case-insensitive
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	260 - Yield mostly the :py:class:`pygments.token.Token.Keyword` token type
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	261 - Translated if a translation is found
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	262 - Depending on the command---may have required or optional parameters
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	263
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	264 Parameter handling is as follows:
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	265
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	266 * Parameters are enclosed in curly braces ``{`` and ``}``
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	267 * Escaping within the braces is possible using the backslash ``\`` as
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	268 escape character
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	269 * Parameters are separated from the keyword/command by a (possibly empty) run
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	270 of space or TAB characters.
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	271 This is true for required and optional parameters.
209 f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	272 - Unrecognized commands typically result in a
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	273 :py:class:`pygments.token.Token.Error` token.
162 11ce0903ff8b Yield lone backslash characters in expressions that not really escape anything as "Generic.Error" now. Franz Glasner <fzglas.hg@dom66.de> parents: 160 diff changeset	274
209 f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	275 More on escaping rules you can find in :ref:`this chapter <escaping-rules>`.
162 11ce0903ff8b Yield lone backslash characters in expressions that not really escape anything as "Generic.Error" now. Franz Glasner <fzglas.hg@dom66.de> parents: 160 diff changeset	276
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	277
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	278 Commands With Required Parameters
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	279 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	280
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	281 .. code-block:: algpseudocode
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	282
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	283 \TEXT{\PROGRAM {A Program\} or \PROG {A Program\}} \PROGRAM {A Program}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	284 \TEXT{\ALGORITHM{An Algorithm\} or \ALGO{An Algorithm\}} \ALGORITHM{An Algorithm}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	285 \TEXT{\PROCEDURE{A Procedure\} or \PROC{A Procedure\}} \PROCEDURE{A Procedure}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	286 \TEXT{\FUNCTION{A Function\} or \FUNC{A Function\} or \FN{A Function\}} \FUNCTION{A Function}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	287 \TEXT{\CLASS{A Class\}} \CLASS{A Class}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	288
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	289 \TEXT{\STATEMENT{the expression\} \STATE{the expression\} \BLOCK{the expression\}} \STATEMENT{the expression}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	290
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	291 \TEXT{expr1: \\EXPRESSION{expression a in b\} expr2: \\EXPR{expression b in a\}} \TEXT{expr1: \EXPRESSION{expression a in b} expr2: \EXPR{expression b in a}}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	292
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	293 \TEXT{\TEXTSTATEMENT{the text\} \TEXTSTATE{the text\} \TSTATEMENT{the text\} \TSTATE{the text\} \TEXTBLOCK{the text\} \TBLOCK{the text\}} \TEXTSTATEMENT{the text}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	294
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	295 \TEXT{\INPUT{Input 1\}} \INPUT{Input 1}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	296 \TEXT{\INPUTS{Input 2\}} \INPUTS{Input 2}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	297
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	298 \TEXT{\OUTPUT{Output 1\}} \OUTPUT{Output 1}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	299 \TEXT{\OUTPUTS{Output 2\}} \OUTPUTS{Output 2}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	300
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	301 \TEXT{\ENSURE{Whatever should be ensured!\}} \ENSURE{Whatever should be ensured!}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	302
142 5df4403f9e18 Reformae the description of the lexer options Franz Glasner <fzglas.hg@dom66.de> parents: 127 diff changeset	303 \TEXT{\REQUIRE{Whatever should be required.\}} \REQUIRE{Whatever should be required.}
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	304
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	305 \TEXT{\RETURNS{Return 2\}} \RETURNS{Return 2}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	306
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	307 \TEXT{\CALL{a function\}(p1, p2)} \CALL{a function}(p1, p2)
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	308
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	309 \TEXT{\NAME{an entity name\}} \NAME{an entity name}
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	310
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	311
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	312 Commands With Optional Parameters
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	314
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	315 Some ``END``-commands have optional parameters:
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	316
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	317 .. code-block:: algpseudocode
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	318
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	319 \TEXT{\ENDPROGRAM \ENDPROG} \ENDPROGRAM
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	320 \TEXT{\ENDALGORITHM \ENDALGO} \ENDALGORITHM
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	321 \TEXT{\ENDPROCEDURE \ENDPROC} \ENDPROCEDURE
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	322 \TEXT{\ENDFUNCTION \ENDFUNC \ENDFN} \ENDFUNCTION
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	323 \TEXT{\ENDCLASS} \ENDCLASS
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	324
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	325 They are used like this:
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	326
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	327 .. code-block:: algpseudocode
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	328
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	329 \TEXT{\CLASS{Foo Bar Class\} ... \END CLASS {Foo Bar Class\}} \TEXT{yields} \CLASS{Foo Bar Class} ... \END CLASS {Foo Bar Class}
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	330
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	331 \TEXT{\CLASS{Foo Bar Class\} ... \END CLASS} \TEXT{yields} \CLASS{Foo Bar Class} ... \END CLASS
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	332
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	333 .. seealso:: For other syntax variants concerning `END` see also section
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	334 `END-Commands`_.
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	335
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	336
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	337 Commands Without Parameters
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	338 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	339
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	340 "Normal" Commands
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	341 '''''''''''''''''
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	342
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	343 .. code-block:: algpseudocode
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	344
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	345 \TEXT{\IF} \IF
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	346 \TEXT{\THEN} \THEN
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	347 \TEXT{\ELSE} \ELSE
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	348 \TEXT{\ELSEIF or \ELSIF or \ELIF} \ELSEIF \text{or} \ELSIF \text{or} \ELIF
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	349 \TEXT{\DO} \DO
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	350 \TEXT{\WHILE} \WHILE
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	351 \TEXT{\FORALL} \FORALL
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	352 \TEXT{\FOR} \FOR
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	353 \TEXT{\FROM} \FROM
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	354 \TEXT{\TO} \TO
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	355 \TEXT{\STEP} \STEP
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	356 \TEXT{\IN} \IN
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	357 \TEXT{\LOOP} \LOOP
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	358 \TEXT{\REPEAT} \REPEAT
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	359 \TEXT{\UNTIL} \UNTIL
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	360
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	361 \TEXT{\RETURN} \RETURN
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	362
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	363 \TEXT{\BEGIN} \BEGIN
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	364 \TEXT{\END} \END
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	365
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	366 \TEXT{\IS} \IS
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	367 \TEXT{\WITH} \WITH
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	368
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	369 \TEXT{\GETS} \GETS
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	370
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	371 \TEXT{\\REMARK or \\REM} \REMARK A comment with a leading symbol
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	372
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	373 ``\REMARK`` or ``\REM`` is special: all characters to the end of the
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	374 line are taken as comment; curly braces are not needed---in fact:
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	375 they are interpreted to be part of the comment.
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	376
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	377
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	378 END-Commands
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	379 ''''''''''''
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	380
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	381 The separator character can be empty, a run of ASCII spaces, a run of
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	382 TAB characters, a single underscore ``_`` or a single hyphen ``-``.
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	383
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	384 All of the following examples are equally valid and result in the
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	385 same output:
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	386
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	387 ``\ENDIF``, ``\END IF``, ``\END-IF``, ``\END_IF`` or ``\END IF``
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	388
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	389
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	390 .. code-block:: algpseudocode
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	391
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	392 \text{\ENDIF} \ENDIF \rem empty
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	393
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	394 \text{\END IF} \END IF \rem a single space
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	395
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	396 \text{\END IF} \END IF \rem two spaces
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	397
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	398 \text{\END-IF} \END-IF \rem a single hyphen
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	399
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	400 \text{\END_IF} \END_IF \rem a single underscore
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	401
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	402 \text{\END IF} \END IF \rem a single TAB character
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	403
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	404 The list of END-commands (here always just with ``-`` as separator):
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	405
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	406 .. code-block:: algpseudocode
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	407
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	408 \text{\END-PROGRAM \END-PROG} \END-PROGRAM
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	409 \text{\END-ALGORITHM \END-ALGO} \END-ALGORITHM
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	410 \text{\END-PROCEDURE \END-PROC} \END-PROCEDURE
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	411 \text{\END-FUNCTION \END-FUNC \END-FN} \END-FUNCTION
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	412 \text{\END-CLASS} \END-CLASS
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	413 \text{\END-IF} \END-IF
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	414 \text{\END-WHILE} \END-WHILE
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	415 \text{\END-FOR} \END-FOR
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	416 \text{\END-FORALL} \END-FORALL
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	417 \text{\END-LOOP} \END-LOOP
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	418
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	419 .. note:: The output of these END-commands can be suppressed by setting the
172 ad80fcbf7b47 Docs formatting Franz Glasner <fzglas.hg@dom66.de> parents: 169 diff changeset	420 lexer option ``no_end`` to :py:obj:`True`.
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	421
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	422
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	423 Names and Entities
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	424 ==================
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	425
277 a5c96fdd1cb3 Wording in docs Franz Glasner <fzglas.hg@dom66.de> parents: 276 diff changeset	426 In an `expression` context all other words are interpreted as entity
156 123aeb2de8aa Explicitely call all markup with the domain Franz Glasner <fzglas.hg@dom66.de> parents: 154 diff changeset	427 names (token type :py:class:`pygments.token.Token.Name.Entity`).
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	428
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	429 Allowed characters in the words follow the corresponding `Python`_ rules.
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	430 As such, many Unicode characters are allowed.
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	431
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	432 To highlight entity names with whitespace or other "special" characters in it
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	433 use the ``NAME`` command.
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	434
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	435 .. code-block:: algpseudocode
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	436
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	437 \TEXT{entity_name_1} entity_name_1
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	438
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	439 \TEXT{entity_name_2} entity_name_2
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	440
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	441 \TEXT{\NAME{entity-name 3\}} \NAME{entity-name 3}
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	442
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	443 \TEXT{München} München
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	444
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	445 \TEXT{Genève} Genève
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	446
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	447
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	448 .. _explicit-token-types:
4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	449
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	450 Explicit Token Types
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	451 ====================
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	452
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	453 They allow to handle keywords and operators that are not recognized by default.
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	454 And they allow the user to explicitely highlight some input text at low-level.
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	455
156 123aeb2de8aa Explicitely call all markup with the domain Franz Glasner <fzglas.hg@dom66.de> parents: 154 diff changeset	456 `XX` represents a `value` in the :py:data:`pygments.token.STANDARD_TYPES`
123aeb2de8aa Explicitely call all markup with the domain Franz Glasner <fzglas.hg@dom66.de> parents: 154 diff changeset	457 dict.
123aeb2de8aa Explicitely call all markup with the domain Franz Glasner <fzglas.hg@dom66.de> parents: 154 diff changeset	458 Its corresponding token type (the associated `key` in this `dict`) is
123aeb2de8aa Explicitely call all markup with the domain Franz Glasner <fzglas.hg@dom66.de> parents: 154 diff changeset	459 used as token type.
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	460
237 c4e8c7010ca0 FIX: Syntax description of "Explicit Token Types". Franz Glasner <fzglas.hg@dom66.de> parents: 213 diff changeset	461 ``\tt-XX/SINGLE-CHAR``
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	462
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	463 no escaping needed
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	464
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	465 `SINGLE-CHAR` is a single character and can be every character
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	466 (including a carriage-return or line-feed)
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	467
237 c4e8c7010ca0 FIX: Syntax description of "Explicit Token Types". Franz Glasner <fzglas.hg@dom66.de> parents: 213 diff changeset	468 ``\ttx-XX{CHARACTERS}``
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	469
237 c4e8c7010ca0 FIX: Syntax description of "Explicit Token Types". Franz Glasner <fzglas.hg@dom66.de> parents: 213 diff changeset	470 ``\ttx-XX(CHARACTERS)``
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	471
237 c4e8c7010ca0 FIX: Syntax description of "Explicit Token Types". Franz Glasner <fzglas.hg@dom66.de> parents: 213 diff changeset	472 ``\ttx-XX[CHARACTERS]``
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	473
237 c4e8c7010ca0 FIX: Syntax description of "Explicit Token Types". Franz Glasner <fzglas.hg@dom66.de> parents: 213 diff changeset	474 ``\ttx-XX<CHARACTERS>``
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	475
237 c4e8c7010ca0 FIX: Syntax description of "Explicit Token Types". Franz Glasner <fzglas.hg@dom66.de> parents: 213 diff changeset	476 ``\ttx-XX<SEP>CHARACTERS<SEP>``
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	477
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	478 No escaping possible! There are enough alternatives available!
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	479
276 397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	480 `SEP` is exactly one character of ``/?.,:;%\|=*+!\$~"'_-#@``.
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	481
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	482
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	483 Examples:
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	484
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	485 .. code-block:: algpseudocode
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	486
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	487 \text{• \\tt-kc/C} \tt-kc/C \rem C as Keyword.Constant
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	488 \text{• \\tt-ow/∈} \tt-ow/∈ \rem ∈ as Operator.Word
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	489 \text{• \\ttx-kc{A Constant Keyword\}} \ttx-kc{A Constant Keyword} \rem An explicit Keyword.Constant
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	490 \text{• \\ttx-nv{A Variable Name\}} \ttx-nv{A Variable Name} \rem An explicit Name.Variable
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	491 \text{• \\ttx-ni{An EntityName\}} \ttx-ni{An EntityName} \rem An explicit Name.Entity
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	492 \text{• \\ttx-k(∈ ∌)} \ttx-k(∈ ∌) \rem ∈ and ∌ as (ordinary) Keywords
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	493 \text{• \\ttx-o<∈ ∌>} \ttx-o<∈ ∌> \rem ∈ and ∌ as (ordinary) Operators
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	494 /*
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	495 * The line below has ∈_∌ as (peculiar) function name.
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	496 * Their params are automatic (i.e. a normal expression).
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	497 */
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	498 \text{• \\ttx-nf<∈_∌>(p1, p2)} \ttx-nf<∈_∌>(p1, p2)
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	499 /*
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	500 * The line below has ∈_∌ as (peculiar) decorator name (as used in Python).
150 4acf578ae93f Much more details in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 148 diff changeset	501 * Their params are automatic (i.e. a normal expression).
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	502 */
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	503 \text{• \\ttx-nd[∈_∌](p1, p2)} \ttx-nd[∈_∌](p1, p2)
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	504 /*
276 397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	505 * Normal emphasis ("strong")
397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	506 */
397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	507 \text{• \\ttx-gs$this is strong$} \ttx-gs$this is strong$
397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	508 /*
397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	509 * A strong emphasis.
397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	510 * Note that the backslash is a valid delimiter!
397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	511 */
397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	512 \text{• \\ttx-ges\\strong emphasis!\\} \ttx-ges\strong emphasis!\
397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	513 /*
397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	514 * This is a non-existing token type: you get some generic error markup
88 03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	515 * with a Generic.Error token and no expansion.
03e9031b5eca Some details and examples about \tt-XXX and \ttx-XXX in the docs Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	516 */
276 397ed930a5ba Allow more separator characters for explicit token types. Franz Glasner <fzglas.hg@dom66.de> parents: 274 diff changeset	517 \text{• \\ttx-NON-EXISTING?∈_∌?(p1, p2)} \ttx-NON_EXISTING?∈_∌?(p1, p2)
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	518
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	519 .. note:: Explicit token types are case-sensitive.
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	520
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	521 .. note:: Explicit token types work in all `expression` and `text` contexts.
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	522
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	523
209 f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	524 .. _escaping-rules:
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	525
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	526 Escaping Rules
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	527 ==============
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	528
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	529 The escape character is a backslash ``\``.
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	530
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	531 A backslash can be escaped with ``\\`` and yields a single backslash token.
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	532
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	533 Within parameters a closing curly brace ``}`` ends the current
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	534 parameters environment.
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	535 It must be escaped using ``\}`` if a closing curly brace is part of the
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	536 argument content.
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	537
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	538 A single backslash yields a :py:class:`pygments.token.Token.Generic.Error`
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	539 token when in `default` and `expression` states.
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	540 Contrary---in `text` contexts a single backslash character that does not
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	541 introduce a command yields a normal text token.
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	542
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	543 In all contexts a backslash that would normally introduce a known command
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	544 must be escaped if the content should not recognized as a command.
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	545
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	546 Single- and double-quotes must be escaped also (``\"`` or ``\'``) in
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	547 `default` and `expression` contexts when they should not introduce a
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	548 string token.
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	549
f20177032d21 A chapter about escaping rules Franz Glasner <fzglas.hg@dom66.de> parents: 208 diff changeset	550
144 b616f9645e37 More referencing with internal and external links Franz Glasner <fzglas.hg@dom66.de> parents: 142 diff changeset	551 .. _customized-sphinx-lexers:
b616f9645e37 More referencing with internal and external links Franz Glasner <fzglas.hg@dom66.de> parents: 142 diff changeset	552
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	553 Customized Lexers in Sphinx
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	554 ===========================
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	555
144 b616f9645e37 More referencing with internal and external links Franz Glasner <fzglas.hg@dom66.de> parents: 142 diff changeset	556 Defining lexers with non-default options in `Sphinx`_ can be done in its
153 d475f5e252eb Document an alternate variant to apply options to existing lexers Franz Glasner <fzglas.hg@dom66.de> parents: 150 diff changeset	557 configuration file :file:`conf.py`.
d475f5e252eb Document an alternate variant to apply options to existing lexers Franz Glasner <fzglas.hg@dom66.de> parents: 150 diff changeset	558
d475f5e252eb Document an alternate variant to apply options to existing lexers Franz Glasner <fzglas.hg@dom66.de> parents: 150 diff changeset	559 The first option is to apply the Sphinx config value ``highlight_options``
d475f5e252eb Document an alternate variant to apply options to existing lexers Franz Glasner <fzglas.hg@dom66.de> parents: 150 diff changeset	560 properly. An existing lexer can be customized by options.
d475f5e252eb Document an alternate variant to apply options to existing lexers Franz Glasner <fzglas.hg@dom66.de> parents: 150 diff changeset	561
d475f5e252eb Document an alternate variant to apply options to existing lexers Franz Glasner <fzglas.hg@dom66.de> parents: 150 diff changeset	562 A more flexible alternative is to define a new lexer in the Sphinx
d475f5e252eb Document an alternate variant to apply options to existing lexers Franz Glasner <fzglas.hg@dom66.de> parents: 150 diff changeset	563 application. The very same lexer class can be used with different options:
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	564
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	565 .. code-block:: python
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	566
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	567 from functools import partial
164 a4317957148b Move all lexers into a subpackage pygments_lexer_pseudocode2.lexers. Franz Glasner <fzglas.hg@dom66.de> parents: 162 diff changeset	568 from pygments_lexer_pseudocode2.lexers.algpseudocode import AlgPseudocodeLexer
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	569
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	570 def setup(app):
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	571
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	572 #
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	573 # Add a custom lexer: AlgPseudocodeLexer with custom init
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	574 # option "no_end".
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	575 #
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	576 # In modern Sphinx versions given lexer must be callable and may
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	577 # not be a lexer instance. So use an indirection with "partial"
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	578 # here.
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	579 #
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	580 app.add_lexer("noend-algpseudocode",
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	581 partial(AlgPseudocodeLexer, no_end=True))
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	582
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	583 Similarily it works for custom styles and filters.
3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	584
158 f08d77b8cbf7 Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	585 .. note:: Lexers in Sphinx are instantiated with the `raiseonerror` filter
f08d77b8cbf7 Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	586 applied by default.
f08d77b8cbf7 Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	587 This is also true for custom lexers that are added by
f08d77b8cbf7 Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	588 :py:meth:`Sphinx.add_lexer`.
207 76053daf813e Extend the note in "Customized Lexers in Sphinx" somewhat Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	589 Using the `filters` option the user can associate custom filters
76053daf813e Extend the note in "Customized Lexers in Sphinx" somewhat Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	590 with a lexer.
76053daf813e Extend the note in "Customized Lexers in Sphinx" somewhat Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	591 These filters have precedence over the default `raiseonerror`
76053daf813e Extend the note in "Customized Lexers in Sphinx" somewhat Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	592 filter.
158 f08d77b8cbf7 Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	593
f08d77b8cbf7 Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	594 Lexer instances that are added to
f08d77b8cbf7 Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	595 :py:data:`sphinx.highlighting.lexers` somehow are taken as is by
f08d77b8cbf7 Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	596 Sphinx and are not augmented with any default filters.
f08d77b8cbf7 Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	597
269 9790553d7225 More details on custom filters in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 268 diff changeset	598 For more details see chapter :ref:`filters`.
9790553d7225 More details on custom filters in the documentation Franz Glasner <fzglas.hg@dom66.de> parents: 268 diff changeset	599
125 3629bf09b30d Much more documentation including most details of the AlgPseudocodeLexer Franz Glasner <fzglas.hg@dom66.de> parents: 88 diff changeset	600 For older Sphinx versions your mileage may vary.
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	601
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	602
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	603 Some Examples
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	604 =============
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	605
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	606 .. rubric:: Synthetic Example
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	607
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	608 The first example is a synthetic example with many features.
187 418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	609
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	610 .. only:: builder_html
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	611
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	612 Its source code is in :download:`examples/example-1.pseudocode`.
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	613
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	614 .. raw:: latex
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	615
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	616 Its source code can be found at \url{example-1.pseudocode}.
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	617
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	618 .. literalinclude:: examples/example-1.pseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	619 :language: algpseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	620 :lines: 2-
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	621
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	622 The highlighted output with a customized `AlgPseudocodeLexer` and its `no_end`
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	623 option set to :py:obj:`True`:
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	624
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	625 .. literalinclude:: examples/example-1.pseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	626 :language: NoEndAlgPseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	627 :lines: 2-
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	628
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	629 .. rubric:: Dinic's Algorithm
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	630
186 95754197f5b3 Link to some source code of example pseudocode files Franz Glasner <fzglas.hg@dom66.de> parents: 172 diff changeset	631 The second example is Wikipedia's description of Dinic's Algorithm
95754197f5b3 Link to some source code of example pseudocode files Franz Glasner <fzglas.hg@dom66.de> parents: 172 diff changeset	632 (see https://en.wikipedia.org/wiki/Dinic%27s_algorithm).
187 418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	633
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	634 .. only:: builder_html
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	635
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	636 Its source code is in :download:`examples/algorithm-dinic.pseudocode`.
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	637
187 418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	638 .. raw:: latex
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	639
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	640 Its source code can be found at \url{algorithm-dinic.pseudocode}.
187 418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	641
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	642 .. literalinclude:: examples/algorithm-dinic.pseudocode
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	643 :language: algpseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	644 :lines: 2-
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	645
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	646 .. rubric:: Ford–Fulkerson Algorithm
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	647
186 95754197f5b3 Link to some source code of example pseudocode files Franz Glasner <fzglas.hg@dom66.de> parents: 172 diff changeset	648 The third example is Wikipedia's pseudocode of the Ford–Fulkerson Algorithm
95754197f5b3 Link to some source code of example pseudocode files Franz Glasner <fzglas.hg@dom66.de> parents: 172 diff changeset	649 (see https://en.wikipedia.org/wiki/Ford%E2%80%93Fulkerson_algorithm).
187 418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	650
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	651 .. only:: builder_html
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	652
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	653 Its source code is in
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	654 :download:`examples/algorithm-ford-fulkerson.pseudocode`.
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	655
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	656 .. raw:: latex
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	657
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	658 Its source code can be found at \url{algorithm-ford-fulkerson.pseudocode}.
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	659
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	660 .. literalinclude:: examples/algorithm-ford-fulkerson.pseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	661 :language: algpseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	662 :lines: 2-
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	663
266 50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	664 .. rubric:: Edmonds–Karp Algorithm
50bd1e91b822 Doc enhancements: style, sub-headings, wording, examples, details Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	665
186 95754197f5b3 Link to some source code of example pseudocode files Franz Glasner <fzglas.hg@dom66.de> parents: 172 diff changeset	666 The fourth example is Wikipedia's pseudocode of the Edmonds–Karp Algorithm
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	667 (see https://en.wikipedia.org/wiki/Edmonds%E2%80%93Karp_algorithm)
194 403b500e0ed4 FIX: Syntax Franz Glasner <fzglas.hg@dom66.de> parents: 193 diff changeset	668 with a custom lexer which skips all ``ENDxxx`` keywords.
187 418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	669
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	670 .. only:: builder_html
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	671
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	672 Its source code is in
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	673 :download:`examples/algorithm-edmonds-karp.pseudocode`.
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	674
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	675 .. raw:: latex
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	676
418846a2623c Also link to exampled from the PDF properly Franz Glasner <fzglas.hg@dom66.de> parents: 186 diff changeset	677 Its source code can be found at \url{algorithm-edmonds-karp.pseudocode}.
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	678
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	679 .. literalinclude:: examples/algorithm-edmonds-karp.pseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	680 :language: NoEndAlgPseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	681 :lines: 2-
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	682
186 95754197f5b3 Link to some source code of example pseudocode files Franz Glasner <fzglas.hg@dom66.de> parents: 172 diff changeset	683 And now the Edmonds–Karp Algorithm with french keywords:
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	684
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	685 .. literalinclude:: examples/algorithm-edmonds-karp.pseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	686 :language: algpseudocode-fr
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	687 :lines: 2-
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	688
186 95754197f5b3 Link to some source code of example pseudocode files Franz Glasner <fzglas.hg@dom66.de> parents: 172 diff changeset	689 And again the Edmonds–Karp Algorithm with german keywords:
169 3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	690
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	691 .. literalinclude:: examples/algorithm-edmonds-karp.pseudocode
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	692 :language: algpseudocode-de
3c517c22df9c Much more details and refinements in the docs Franz Glasner <fzglas.hg@dom66.de> parents: 168 diff changeset	693 :lines: 2-

Mercurial > hgrepos > Python > libs > pygments-lexer-pseudocode2

annotate docs/lexer-algpseudocode.rst @ 277:a5c96fdd1cb3