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

annotate README.rst @ 137:d43d66060819

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Wording in docs
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 07 May 2026 09:22:13 +0200
parents f713190c6c0b
children 69283c05ba48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
1 .. -*- coding: utf-8 -*-
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
2
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
3 *****************************************
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
4 README -- Pseudocode Lexer for Pygments
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
5 *****************************************
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
6
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
7 This package contains Pygments lexers for some basic pseudocode.
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
8
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
9 Initially a fork of `pygments-lexer-pseudocode` it has been considerably
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
10 changed and expanded.
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
12 It now contains the following lexers:
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
13
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
14 .. list-table::
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
15 :align: left
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
16 :header-rows: 1
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
17
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
18 * - Name
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
19 - Description
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
20 - Extension(s)
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
21 - Aliases / Short Name(s)
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
23 * - AlgPseudocode
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
24 - Pseudocode with inspirations from CTAN's "Algpseudocodex"
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
25 - \*.algpseudocode, \*.algpseudo
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
26 - algpseudocode, algpseudo
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
27
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
28 * - AlgPseudocodeFR
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
29 - AlgPseudocode with french keyword expansion
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
30 - \*.algpseudo-fr, \*.algpseudocode-fr
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
31 - algpseudocode-fr, algpseudo-fr
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
33 * - AlgPseudocodeDE
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
34 - AlgPseudocode with german keyword expansion
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
35 - \*.algpseudo-de, \*.algpseudocode-de
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
36 - algpseudocode-de, algpseudo-de
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
37
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
38 * - FrPseudocode
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
39 - The original lexer (slightly changed) from `pygments-lexer-pseudocode`
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
40 - \*.fr-algo, \*.fr-pseudocode
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
41 - fr-pseudocode, fr-pseudo, fr-algorithm, fr-algo
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
42
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
43
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
44 Installation
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
45 ============
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
46
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
47 The lexers are available as a Python wheel package::
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48
8
5812e7f3bc13 Rename the project the implementing class to "pygments-lexer-pseudocode2".
Franz Glasner <fzglas.hg@dom66.de>
parents: 1
diff changeset
49 pip install pygments-lexer-pseudocode2
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
51 Alternatively, to build from the source code repository::
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52
8
5812e7f3bc13 Rename the project the implementing class to "pygments-lexer-pseudocode2".
Franz Glasner <fzglas.hg@dom66.de>
parents: 1
diff changeset
53 python -m build
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
56 Usage
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
57 =====
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
59 After installation the Pseudocode lexers automatically register itself
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
60 within the plugin system of Pygments. All aliases and filename extensions
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
61 from above are made known to Pygments.
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
63 Usage is easy.
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
64
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
65 Pygmentizing a file with a known file extension::
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
66
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
67 pygmentize document.algpseudocode
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
68
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
69 Or you can manally select the Pseudocode lexer you want to use by
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
70 using a command line flag::
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
71
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
72 pygmentize -l algpseudocode somefile
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
73
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
74 Within Sphinx use a lexer like this::
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
75
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
76 .. code-block:: algpseudocode
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
77
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
78
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
79 License
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
80 =======
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
81
136
f713190c6c0b Also mention that some code snippets are licensed under the terms of BSD-2-Clause
Franz Glasner <fzglas.hg@dom66.de>
parents: 133
diff changeset
82 The package is licensed under the terms of the MIT Licence.
f713190c6c0b Also mention that some code snippets are licensed under the terms of BSD-2-Clause
Franz Glasner <fzglas.hg@dom66.de>
parents: 133
diff changeset
83
f713190c6c0b Also mention that some code snippets are licensed under the terms of BSD-2-Clause
Franz Glasner <fzglas.hg@dom66.de>
parents: 133
diff changeset
84 Some code snippets are licensed under the terms of the
f713190c6c0b Also mention that some code snippets are licensed under the terms of BSD-2-Clause
Franz Glasner <fzglas.hg@dom66.de>
parents: 133
diff changeset
85 BSD 2-Clause "Simplified" License as they are taken from the Python
f713190c6c0b Also mention that some code snippets are licensed under the terms of BSD-2-Clause
Franz Glasner <fzglas.hg@dom66.de>
parents: 133
diff changeset
86 lexer that is included in Pygments.