annotate docs/details-frpseudocode.rst @ 147:df9b4962c203

Remove the Python "code-block" that has been used for development (comparison) reasons
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 07 May 2026 13:26:01 +0200
parents ca5b31a30cea
children 4acf578ae93f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
128
2a653897f31e Prepare a file for docs of FrPseudocodeLexer
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
2a653897f31e Prepare a file for docs of FrPseudocodeLexer
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
2a653897f31e Prepare a file for docs of FrPseudocodeLexer
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 **************
2a653897f31e Prepare a file for docs of FrPseudocodeLexer
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 FrPseudocode
131
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
5 **************
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
6
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
7 This is the pseudocode lexer from the original `pygments-lexer-pseudocode`
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
8 package.
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
9
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
10 It has been changed somewhat:
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
11
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
12 - renamed from ``Pseudocode`` to ``FrPseudocode``
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
13 - changed aliases to ``fr-pseudocode``, ``fr-pseudo``, ``fr-algorithm``
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
14 and ``fr-algo``
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
15 - changed file extension to ``.fr-algo`` and ``.fr-pseudocode``
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
16 - changed some exististing arrows and added some more
146
ca5b31a30cea Wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 145
diff changeset
17 - numbers parsing is more flexible by following the rules of the `Pygments`_
ca5b31a30cea Wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 145
diff changeset
18 lexer for `Python`_
131
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
19 - also allow ``!=`` as inequality operator (in addition to ``<>``)
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
20
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
21 It mostly just recognizes some (french) keywords and highlights them.
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
22
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
23 Comments are supported (``//`` and ``/* ... */`` (single-line only))-
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
24 "Directives" in "special" comments are to be enclosed in curly braces ``{ ... }``.
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
25
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
26 It also implements some symbol replacements/conversions like
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
27 ``<=`` to ``≤``, ``>=`` to ``≥`` or ``<>`` to ``≠``.
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
28
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
29
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
30 .. rubric:: Example:
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
31
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
32 The follwing example
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
33
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
34 .. code-block:: none
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
35
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
36 /* foo bar */
128
2a653897f31e Prepare a file for docs of FrPseudocodeLexer
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37
131
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
38 fonction fonc-1({passage par valeur}param1)
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
39 début
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
40 si param1 <= 0 alors
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
41 b = 0
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
42 sinon
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
43 b = 1
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
44 a = param1
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
45 répéter
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
46 a = a - 1
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
47 b = b * 2
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
48 tantque a <> 0
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
49 fin si
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
50 retourner b
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
51 fin fonction
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
52
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
53 will be highlighted as
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
54
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
55 .. code-block:: fr-algorithm
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
56
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
57 /* foo bar */
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
58
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
59 fonction fonc-1({passage par valeur}param1)
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
60 début
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
61 si param1 <= 0 alors
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
62 b = 0
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
63 sinon
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
64 b = 1
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
65 a = param1
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
66 répéter
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
67 a = a - 1
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
68 b = b * 2
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
69 tantque a <> 0
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
70 fin si
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
71 retourner b
0455294e20c4 First and basic documentation of FrPseudocodeLeser
Franz Glasner <fzglas.hg@dom66.de>
parents: 128
diff changeset
72 fin fonction