aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/doc_reform/meta/rgx.d
blob: aace769efc863c858ea730edc45466923afd04c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
/+
- Name: Spine, Doc Reform [a part of]
  - Description: documents, structuring, processing, publishing, search
    - static content generator

  - Author: Ralph Amissah
    [ralph.amissah@gmail.com]

  - Copyright: (C) 2015 - 2024 Ralph Amissah, All Rights Reserved.

  - License: AGPL 3 or later:

    Spine (SiSU), a framework for document structuring, publishing and
    search

    Copyright (C) Ralph Amissah

    This program is free software: you can redistribute it and/or modify it
    under the terms of the GNU AFERO General Public License as published by the
    Free Software Foundation, either version 3 of the License, or (at your
    option) any later version.

    This program is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
    more details.

    You should have received a copy of the GNU General Public License along with
    this program. If not, see [https://www.gnu.org/licenses/].

    If you have Internet connection, the latest version of the AGPL should be
    available at these locations:
    [https://www.fsf.org/licensing/licenses/agpl.html]
    [https://www.gnu.org/licenses/agpl.html]

  - Spine (by Doc Reform, related to SiSU) uses standard:
    - docReform markup syntax
      - standard SiSU markup syntax with modified headers and minor modifications
    - docReform object numbering
      - standard SiSU object citation numbering & system

  - Homepages:
    [https://www.doc_reform.org]
    [https://www.sisudoc.org]

  - Git
    [https://git.sisudoc.org/projects/?p=software/spine.git;a=summary]

+/
/++
  regex: regular expressions used in sisu document parser
+/
module doc_reform.meta.rgx;
static template spineRgxIn() {
  static struct RgxI {
    /+ misc +/
    static flag_action                                    = ctRegex!(`^(--[a-z][a-z0-9-]+)$`);
    static within_quotes                                  = ctRegex!(`"(.+?)"`, "m");
    static make_heading_delimiter                         = ctRegex!(`[;][ ]*`);
    static arr_delimiter                                  = ctRegex!(`[ ]*[;][ ]*`);
    static name_delimiter                                 = ctRegex!(`^([^,]+)[ ]*,[ ]+(.+?)$`);
    static book_index_go                                  = ctRegex!("(?P<link>(?P<ocn>[0-9]+)(?:-[0-9]+)?)");
    static trailing_comma                                 = ctRegex!(",[ ]*$");
    static trailing_linebreak                             = ctRegex!(",[ ]{1,2}\\\\\\\\\n[ ]{4}$","m");
    static newline_eol_strip_preceding                    = ctRegex!("[ ]*\n");
    static newline_eol_delimiter_only                     = ctRegex!("^\n");
    static markup_inline_linebreak                        = ctRegex!(`\s*\\\\s*`, "m");
    static para_delimiter                                 = ctRegex!("\n[ ]*\n+");
    static table_col_delimiter                            = ctRegex!("[ ]*\n+", "mg");
    static table_row_delimiter                            = ctRegex!("\n[ ]*\n+", "mg");
    static table_row_delimiter_special                    = ctRegex!("[ ]*\n", "mg");
    static table_col_delimiter_special                    = ctRegex!("[ ]*[|][ ]*", "mg");
    static levels_numbered                                = ctRegex!(`^[0-9]$`);
    static levels_numbered_headings                       = ctRegex!(`^[0-7]$`);
    static numeric_col                                    = ctRegex!(`^[ 0-9,.%$£₤Є€€¥()-]+$`);
    /+ comments +/
    static comment                                        = ctRegex!(`^%+ `);
    /+ header +/
    /+ header +/
    static variable_doc_title_author_date           = ctRegex!(`@title-author-date`);
    static variable_doc_title_author                = ctRegex!(`@title-author`);
    static variable_doc_title                       = ctRegex!(`@title`);
    static variable_doc_author                      = ctRegex!(`@author|@creator`);
    static variable_doc_date                        = ctRegex!(`@date`);
    static raw_author_munge                         = ctRegex!(`(?P<last>\S.+?),\s+(?P<first>.+)`,"i");
    static yaml_config                              = ctRegex!(`^[a-z]+\s*:\s*(?:"?\w|$)`, "m");
    /+ heading operators +/
    static heading_a                                = ctRegex!(`^:?[A][~] `, "m");
    static heading                                  = ctRegex!(`^:?([A-D1-4])[~]([a-z0-9_.-]*[?]?)\s+`,"i");
    static headings                                 = ctRegex!(`^:?(?P<level>[A-D1-4])[~](?:[a-z0-9_.-]*[?]?|[!](?:glossary|bibliogrphy|biblio|references?|blurb))(?:\s|$)`,"i");
    static heading_seg_and_above                    = ctRegex!(`^:?([A-D1])[~]([a-z0-9_.-]*[?]?)\s+`,"i");
    static heading_anchor_tag                       = ctRegex!(`^:?[A-D1-4][~](?P<anchor>[a-z0-9_.-]+) `,"i");
    static heading_identify_anchor_tag              = ctRegex!(`^:?[A-D1-4][~]\s+(?:(?:(?:chapter|article|section|clause)\s+[0-9.]+)|(?:[0-9]+))`,"i");
    static heading_extract_named_anchor_tag         = ctRegex!(`^:?[A-D1-4][~]\s+(chapter|article|section|clause)\s+((?:[0-9]+[.:])*[0-9]+)(?=[.:;, ]|$)`,"i");
    static heading_extract_unnamed_anchor_tag       = ctRegex!(`^:?[A-D1-4][~]\s+((?:[0-9]+.)*[0-9]+)(?=[.:;, ]|$)`);
    static heading_marker_missing_tag               = ctRegex!(`^:?([A-D1-4])[~] `);
    static heading_anchor_tag_plus_colon            = ctRegex!(`^:?([A-D1-4][~])([a-z0-9_.:-]+) `,"i");
    static heading_marker_tag_has_colon             = ctRegex!(`([:])`);
    static heading_biblio                           = ctRegex!(`^1[~][!](biblio(?:graphy)?|references?)`);
    static heading_glossary                         = ctRegex!(`^1[~][!](glossary)`);
    static heading_blurb                            = ctRegex!(`^1[~][!](blurb)`);
    /+ paragraph operators +/
    static para_bullet                              = ctRegex!(`^_[*] `);
    static para_bullet_indent                       = ctRegex!(`^_(?P<indent>[1-9])[*] `);
    static para_indent                              = ctRegex!(`^_(?P<indent>[1-9])[ ]`);
    static para_indent_hang                         = ctRegex!(`^_(?P<hang>[0-9])_(?P<indent>[0-9])[ ]`);
    static para_attribs                             = ctRegex!(`^_(?:(?:[0-9])(?:_([0-9]))?|(?:[1-9])?[*]) `);
    static para_inline_link_anchor                  = ctRegex!(`\*[~](?P<anchor>[a-z0-9_.-]+)(?= |$)`,"i");
    /+ blocked markup +/
    static block_open                               = ctRegex!("^((code(?:[.][a-z][0-9a-z#+_]+)?|(?:poem|group|block|quote)(?:[.][a-z][0-9a-z_]+)?|table)(?:[(][ a-zA-Z0-9;:,]*[)])?[{][ ]*$)|^`{3} (code(?:[.][a-z][0-9a-z#+_]+)?|(?:poem|group|block|quote)(?:[.][a-z][0-9a-z_]+)?|table)(?:[(][ a-zA-Z0-9;:,]*[)])?|^[{]table[(](?:h;)?(?P<columns>(?:[ ,]+[0-9]+)+)[)][}]");
    static block_poem_open                          = ctRegex!("^((poem(?:[(][ a-zA-Z0-9;:,]*[)])?[{][ ]*$)|`{3} poem(?:[(][ a-zA-Z0-9;:,]*[)])?)");
    /+ blocked markup tics +/
    static block_tic_code_open                      = ctRegex!("^`{3} code(?:[.](?P<syntax>[a-z][0-9a-z#+_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?");
    static block_tic_poem_open                      = ctRegex!("^`{3} poem(?:[.](?P<lang>[a-z][0-9a-z_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?");
    static block_tic_group_open                     = ctRegex!("^`{3} group(?:[.](?P<lang>[a-z][0-9a-z_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?");
    static block_tic_block_open                     = ctRegex!("^`{3} block(?:[.](?P<lang>[a-z][0-9a-z_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?");
    static block_tic_quote_open                     = ctRegex!("^`{3} quote(?:[.](?P<lang>[a-z][0-9a-z_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?");
    static block_tic_table_open                     = ctRegex!("^`{3} table(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?"); // ctRegex!("^`{3} table(?:\(.*?\))?");
    static block_tic_close                          = ctRegex!("^(`{3})$","m");
    /+ blocked markup curly +/
    static block_curly_code_open                    = ctRegex!(`^(?:code(?:[.](?P<syntax>[a-z][0-9a-z_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?[{][ ]*$)`);
    static block_curly_code_close                   = ctRegex!(`^([}]code)`);
    static block_curly_poem_open                    = ctRegex!(`^(poem(?:[.](?P<lang>[a-z][0-9a-z_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?[{][ ]*$)`);
    static block_curly_poem_close                   = ctRegex!(`^([}]poem)`);
    static block_curly_group_open                   = ctRegex!(`^(group(?:[.](?P<lang>[a-z][0-9a-z_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?[{][ ]*$)`);
    static block_curly_group_close                  = ctRegex!(`^([}]group)`);
    static block_curly_block_open                   = ctRegex!(`^(block(?:[.](?P<lang>[a-z][0-9a-z_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?[{][ ]*$)`);
    static block_curly_block_close                  = ctRegex!(`^([}]block)`);
    static block_curly_quote_open                   = ctRegex!(`^(quote(?:[.](?P<lang>[a-z][0-9a-z_]+))?(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?[{][ ]*$)`);
    static block_curly_quote_close                  = ctRegex!(`^([}]quote)`);
    static block_curly_table_open                   = ctRegex!(`^table(?:[(](?P<attrib>[ a-zA-Z0-9;:,]*)[)])?[{][ ]*$`);
    static block_curly_table_close                  = ctRegex!(`^([}]table)`);
    static block_curly_table_special_markup         = ctRegex!(`^[{]table[(](?P<attrib>(?:(h);)?(?P<columns>(?:[, ]+[0-9]+)+))[)][}]`, "mg");
    static code_numbering                           = ctRegex!(`(?P<number>\blinenumber\b|\bnumber\b|\blnr\b)`);
    static table_head_instructions                  = ctRegex!(`(?:(?P<c_heading>h);)?(?:[ ]+c(?P<c_num>[0-9]):)?(?P<c_widths>(?:[, ]+[0-9]+[lr]?)+)`);
    static table_col_widths_and_alignment           = ctRegex!(`(?P<width>[0-9]+)(?P<align>[lr]?)`);
    static table_col_widths                         = ctRegex!(`(?P<widths>[0-9]+)`);
    static table_col_align_match                    = ctRegex!(`(?P<align>[lr])`);
    static table_col_separator_nl                   = ctRegex!(`[┊]$`, "mg");
    /+ inline markup footnotes endnotes +/
    static inline_notes_curly_gen                   = ctRegex!(`~\{.+?\}~`, "m");
    static inline_notes_curly                       = ctRegex!(`~\{\s*(.+?)\}~`, "mg");
    static inline_notes_curly_sp_asterisk           = ctRegex!(`~\{[*]+\s+(.+?)\}~`, "m");
    static inline_notes_curly_sp_plus               = ctRegex!(`~\{[+]+\s+(.+?)\}~`, "m");
    static note_ref                                 = ctRegex!(`^\S+?noteref_(?P<ref>[0-9]+)`, "mg");     // {^{73.}^}#noteref_73
    static smid_inline_url_generic                        = ctRegex!(`(?:^|[}(\[ ])(?:(?:https?|git):\/\/|¤?\.\.\/|¤?\.\/|¤|#)[a-zA-Z0-9_#]`, "mg");
    static smid_inline_url                                = ctRegex!(`((?:(?:https?|git):\/\/|¤?\.\.\/|¤?\.\/|¤|#)[a-zA-Z0-9_]\S*)`, "mg");
    static smid_inline_link_naked_url                     = ctRegex!(`(?P<pre>^|[ (\[])(?P<link>(?:(?:https?|git):\/\/|¤?\.\.\/|¤?\.\/|¤)\S+?)(?=[.,;:?!'"]?([ )\]]|$))`, "mg");
    static smid_inline_link_markup_regular                = ctRegex!(`(?P<pre>^|[ (\[])\{\s*(?P<content>.+?)\s*\}(?P<link>(?:(?:https?|git):\/\/|¤?\.\.\/|¤?\.\/|¤|#)\S+?)(?=[;:!,?.]?([ )\]]|$))`, "mg");
    static smid_inline_link_endnote_url_helper_punctuated = ctRegex!(`\{~\^\s+(?P<content>.+?)\}(?P<link>(?:(?:https?|git):\/\/|¤?\.\.\/|¤?\.\/|¤|#)\S+?)(?=[.,;:?!]?([ ]|$))`, "mg");
    static smid_inline_link_endnote_url_helper            = ctRegex!(`\{~\^\s+(?P<content>.+?)\}(?P<link>(?:(?:https?|git):\/\/|¤?\.\.\/|¤?\.\/|¤|#)\S+)`, "mg");
    static image                                    = ctRegex!(`([a-zA-Z0-9._-]+?\.(?:png|gif|jpg))`, "mg");
    static smid_image                               = ctRegex!(`(?P<pre>(?:^|[ ])[{┥](?:~\^\s+|\s*))(?P<image>[a-zA-Z0-9._-]+?\.(?:png|gif|jpg))(?P<post>(?:.*?)\s*[}┝](?:image|┤.*?├|(?:(?:https?|git):\/\/|¤?\.\.\/|¤?\.\/|¤|#)\S+?)(?=[;:!,?.]?([ )\]]|$)))`, "mg");
    static smid_image_generic                       = ctRegex!(`(?:^|[ ])[{┥](?:~\^\s+|\s*)\S+\.(?:png|gif|jpg).*?[}┝](?:image|┤.*?├|(?:(?:https?|git):\/\/|¤?\.\.\/|¤?\.\/|¤|#)\S+?)(?=[;:!,?.]?([ )\]]|$))`, "mg");
    static smid_image_with_dimensions               = ctRegex!(`(?P<pre>(?:^|[ ])[{┥](?:~\^\s+|\s*))(?P<image>[a-zA-Z0-9._-]+?\.(?:png|gif|jpg))\s+(?P<width>\d+)x(?P<height>\d+)\s*(?P<post>(?:.*?)\s*[}┝](?:image|┤.*?├|(?:(?:https?|git):\/\/|¤?\.\.\/|¤?\.\/|¤|#)\S+?)(?=[;:!,?.]?([ )\]]|$)))`, "mg");
    static smid_mod_image_without_dimensions        = ctRegex!(`[{┥](?:~\^\s+|\s*)☼\S+\.(?:png|gif|jpg),w0h0.*[}┝](?:image|┤.*?├|(?:https?|git):\/\/\S+?)(?=[;:!,?.]?([ )\]]|$))`, "mg");
    static smid_image_delimit                       = ctRegex!(`(?P<pre>^|[ ])\{\s*(?P<text>.+?)\s*\}(?:image)(?=[;:!,?.]?([ )\]]|$))`, "mg");
    /+ inline markup book index +/
    static book_index_item                          = ctRegex!(`^=\{\s*(?P<bookindex>.+?)\}$`, "m");
    static book_index_item_open                     = ctRegex!(`^=\{\s*([^}]*?)$`);
    static book_index_item_close                    = ctRegex!(`^(.*?)\}$`, "m");
    static auto_heading_numbering_lv1               = ctRegex!(`^1~`, "m");
    static auto_heading_numbering_off_lv1           = ctRegex!(`^1~\S*?-\s`, "m");
    static auto_heading_numbering_off_lv2           = ctRegex!(`^2~\S*?-\s`, "m");
    static auto_heading_numbering_off_lv3           = ctRegex!(`^3~\S*?-\s`, "m");
    static auto_heading_numbering_off_lv4           = ctRegex!(`^4~\S*?-\s`, "m");
    /+ no object_number object +/
    static object_number_off                        = ctRegex!(`~#[ ]*$`, "m");
    static object_number_off_dummy_heading          = ctRegex!(`-#$`, "m");
    static object_number_off_all                    = ctRegex!(`[~-]#$`, "m");
    static repeated_character_line_separator        = ctRegex!(`^(?:[ ]*(?:(?:[.][ ]*){4,}|(?:[-][ ]*|[~][ ]*|[*][ ]*|[$][ ]*|[#][ ]*|[\\][ ]*|[/][ ]*){2,})\s*?)+$`);
    /+ no object_number block +/
    static object_number_off_block                  = ctRegex!(`^--~#$`);
    static object_number_off_block_dummy_heading    = ctRegex!(`^---#$`);
    static object_number_off_block_close            = ctRegex!(`^--\+#$`);
    static object_number_block_marks                = ctRegex!(`^--[+~-]#$`);
    /+ ignore outside code blocks +/
    static skip_from_regular_parse                  = ctRegex!(`^(--[+~-]#|-[\\]{2}-|=[.\\]{2}=)$`);
    /+ line & page breaks +/
    static break_string                             = ctRegex!(`』`);
    /+ biblio tags +/
    static biblio_tags                              = ctRegex!(`^(is|au|author_raw|author|author_arr|editor_raw|ed|editor_arr|ti|title|subtitle|fulltitle|lng|language|trans|src|jo|journal|in|vol|volume|edn|edition|yr|year|pl|place|pb|pub|publisher|url|pg|pages|note|short_name|id):\s+(.+)`);
    static biblio_abbreviations                     = ctRegex!(`^(au|ed|ti|lng|jo|vol|edn|yr|pl|pb|pub|pg|pgs|sn)$`);
    /+ bookindex split +/
    static bi_main_terms_split                            = ctRegex!(`\s*;\s*`);
    static bi_main_term_plus_rest_split                   = ctRegex!(`\s*:\s*`);
    static bi_sub_terms_plus_object_number_offset_split   = ctRegex!(`\s*\|\s*`);
    static bi_term_and_object_numbers_match               = ctRegex!(`^(.+?)\+(\d+)`);
    static topic_register_main_terms_split          = ctRegex!(`\s*;\s*`);
    static topic_register_main_term_plus_rest_split = ctRegex!(`\s*:\s*`);
    static topic_register_sub_terms_split           = ctRegex!(`\s*\|\s*`);
    static topic_register_multiple_sub_terms_split  = ctRegex!(`␣([^|␣]+(?:\|[^|␣]+)+)`);
    static newline                                  = ctRegex!("\n", "mg");
    static space                                    = ctRegex!(`[ ]`, "mg");
    static spaces_keep                              = ctRegex!(`(?P<keep_spaces>^[ ]+|[ ]{2,})`, "mg"); // code, verse, block
    static spaces_line_start                        = ctRegex!(`^(?P<opening_spaces>[ ]+)`, "mg");
    static nbsp_char                                = ctRegex!(`░`, "mg");
    static nbsp_chars                               = ctRegex!(`[░]+`, "mg");
    static middle_dot                               = ctRegex!(`·`, "mg");
    static src_pth_sst_or_ssm                       = ctRegex!(`^(?P<path>[/]?(?:[a-zA-Z0-9._-]+/)*)(?P<filename>[a-zA-Z0-9._-]+[.](?P<extension>ss[tm]))$`);
    static src_pth_pod_sst_or_ssm                   = ctRegex!(`^(?P<podpath>[/]?(?:[a-zA-Z0-9._-]+/)*)media/text/[a-z]{2}/(?P<filename>[a-zA-Z0-9][a-zA-Z0-9._-]*?[.]ss[tm])$`);
    static src_pth_contents                         = ctRegex!(`^(?P<path>[/]?(?:[a-zA-Z0-9._-]+/)*)(?P<filename>[a-zA-Z0-9][a-zA-Z0-9._-]*)/pod[.]manifest$`);
    static src_pth_zip                              = ctRegex!(`^(?P<path>[/]?(?:[a-zA-Z0-9._-]+/)*)(?P<filename>[a-zA-Z0-9._-]+[.]zip)$`);
    static src_pth_types                            = ctRegex!(`^(?P<path>[/]?[a-zA-Z0-9._-]+/)*(?P<gotfile>(?P<filename>[a-zA-Z0-9._-]+[.]ss[tm])|(?P<filelist>[a-zA-Z0-9._-]+/pod[.]manifest)|(?P<filezip>[a-zA-Z0-9._-]+[.]zip))$`);
    static src_fn                                   = ctRegex!(`^([/]?(?:[a-zA-Z0-9._-]+/)*)(?P<fn_src>(?P<fn_base>[a-zA-Z0-9._-]+)[.](?P<fn_src_suffix>ss[tm]))$`);
    static src_fn_master                            = ctRegex!(`^(?P<path>/?(?:[a-zA-Z0-9._-]+/)*)(?P<filename>[a-zA-Z0-9._-]+[.]ssm)$`);
    static src_fn_find_inserts                      = ctRegex!(`^(?P<path>/?(?:[a-zA-Z0-9._-]+/)*)(?P<filename>[a-zA-Z0-9._-]+[.]ss[im])$`);
    static insert_src_fn_ssi_or_sst                 = ctRegex!(`^<<\s*(?P<path>[a-zA-Z0-9._-]+/)*(?P<filename>[a-zA-Z0-9._-]+[.]ss[ti])$`);
    static src_base_parent_dir_name                 = ctRegex!(`[/](?P<dir>(?:[a-zA-Z0-9._-]+))(?:/media/text/[a-z]{2})$`); // formalizes dir structure
    static src_formalised_file_path_parts           = ctRegex!(`(?P<pth>(?:[/a-zA-Z0-9._-]+?)(?P<dir>[a-zA-Z0-9._-]+))(?:/media/text/[a-z]{2})$`); // formalizes dir structure
    /+ line breaks +/
    static br_empty_line                            = ctRegex!(`\n[ ]*\n`, "mg");
    static br_linebreaks_newlines                   = ctRegex!(`[\n┘┙]`, "mg");
    static br_linebreaks                            = ctRegex!(`[┘┙]`, "mg");
    static br_line                                  = ctRegex!(`┘`, "mg");
    static br_line_inline                           = ctRegex!(`┙`, "mg");
    static br_line_spaced                           = ctRegex!(`┚`, "mg");
    /+ inline markup footnotes endnotes +/
    static inline_notes_al                          = ctRegex!(`【(?:[*+]\s+|\s*)(.+?)】`, "mg");
    static inline_notes_al_special                  = ctRegex!(`【(?:[*+]\s+)(.+?)】`, "mg"); // TODO remove match when special footnotes are implemented
    static inline_notes_al_gen                      = ctRegex!(`【.+?】`, "m");
    static inline_notes_al_gen_text                 = ctRegex!(`【(?P<text>.+?)】`, "m");
    static inline_notes_al_all_note                 = ctRegex!(`【(?P<num>\d+|(?:[*]|[+])+)\s+(?P<note>.+?)\s*】`, "mg");
    static inline_notes_al_regular_number_note      = ctRegex!(`【(?P<num>\d+)\s+(?P<note>.+?)\s*】`, "mg");
    static inline_notes_al_special_char_note        = ctRegex!(`【(?P<char>(?:[*]|[+])+)\s+(?P<note>.+?)】`, "mg");
    static inline_al_delimiter_open_regular         = ctRegex!(`【\s`, "m");
    static inline_al_delimiter_open_symbol_star     = ctRegex!(`【[*]\s`, "m");
    static inline_al_delimiter_open_symbol_plus     = ctRegex!(`【[+]\s`, "m");
    static inline_text_and_note_al_                 = ctRegex!(`(.+?(?:【[*+]*\s+.+?】|.+))`, "mg");
    /+ inline markup links +/
    static inline_image                             = ctRegex!(`(?P<pre>┥)☼(?P<imginf>(?P<img>[a-zA-Z0-9._-]+?\.(?:jpg|gif|png)),w(?P<width>\d+)h(?P<height>\d+))\s*(?P<post>.*?┝┤.*?├)`, "mg");
    static inline_image_without_dimensions          = ctRegex!(`(?P<pre>┥)☼(?P<imginf>(?P<img>[a-zA-Z0-9._-]+?\.(?:jpg|gif|png)),w(?P<width>0)h(?P<height>0))\s*(?P<post>.*?┝┤.*?├)`, "mg");
    static inline_image_info                        = ctRegex!(`☼?(?P<img>[a-zA-Z0-9._-]+?\.(?:jpg|gif|png)),w(?P<width>\d+)h(?P<height>\d+)`, "mg");
    static inline_link_anchor                       = ctRegex!(`┃(?P<anchor>\S+?)┃`, "mg"); // TODO *~text_link_anchor
    static inline_link                              = ctRegex!(`┥(?P<text>.+?)┝┤(?P<link>#?(\S+?))├`, "mg");
    static inline_link_empty                        = ctRegex!(`┥(?P<text>.+?)┝┤├`, "mg");
    static inline_link_number                       = ctRegex!(`┥(?P<text>.+?)┝┤(?P<num>[0-9]+)├`, "mg"); // not used
    static inline_link_number_only                  = ctRegex!(`(?P<linked_text>┥.+?┝)┤(?P<num>[0-9]+)├`, "mg");
    static inline_link_stow_uri                     = ctRegex!(`┥(?P<text>.+?)┝┤(?P<link>[^ 0-9#┥┝┤├][^ 0-9┥┝┤├]+)├`, "mg"); // will not stow (stowed links) or object number internal links
    static inline_link_hash                         = ctRegex!(`┥(?P<text>.+?)┝┤(?P<link>#(?P<hash>\S+?))├`, "mg");
    static inline_link_seg_and_hash                 = ctRegex!(`┥(?P<text>.+?)┝┤(?P<link>(?P<seg>[^/#├]*)#(?P<hash>.+?))├`, "mg");
    static inline_link_clean                        = ctRegex!(`┤(?:.+?)├|[┥┝]`, "mg");
    static inline_link_toc_to_backmatter            = ctRegex!(`┤#(?P<link>endnotes|bibliography|bookindex|glossary|blurb)├`, "mg");
    static url                                      = ctRegex!(`https?://`, "mg");
    static uri                                      = ctRegex!(`(?:https?|git)://`, "mg");
    static uri_identify_components                  = ctRegex!(`(?P<type>(?:https?|git)://)(?P<path>\S+?/)(?P<file>[^/]+)$`, "mg");
    static inline_link_subtoc                       = ctRegex!(`^(?P<level>[5-7])~ ┥(?P<text>.+?)┝┤(?P<link>.+?)├`, "mg");
    static inline_link_fn_suffix                    = ctRegex!(`¤(.+?)(\.fnSuffix)`, "mg");
    static inline_seg_link                          = ctRegex!(`(¤)(?:.+?)\.fnSuffix`, "mg");
    static mark_internal_site_lnk                   = ctRegex!(`¤`, "mg");
    static quotation_mark_sql_insert_delimiter      = ctRegex!("[']", "mg");
    /+ inline markup font face mod +/
    static inline_mark_emphasis                     = ctRegex!(`(?P<mark>[*])\{(?P<text>.+?)\}[*]`, "mg");
    static inline_mark_bold                         = ctRegex!(`(?P<mark>[!])\{(?P<text>.+?)\}[!]`, "mg");
    static inline_mark_underscore                   = ctRegex!(`(?P<mark>[_])\{(?P<text>.+?)\}[_]`, "mg");
    static inline_mark_italics                      = ctRegex!(`(?P<mark>[/])\{(?P<text>.+?)\}[/]`, "mg");
    static inline_mark_superscript                  = ctRegex!(`(?P<mark>\^)\{(?P<text>.+?)\}\^`, "mg");
    static inline_mark_subscript                    = ctRegex!(`(?P<mark>[,])\{(?P<text>.+?)\}[,]`, "mg");
    static inline_mark_strike                       = ctRegex!(`(?P<mark>[-])\{(?P<text>.+?)\}[-]`, "mg");
    static inline_mark_insert                       = ctRegex!(`(?P<mark>[+])\{(?P<text>.+?)\}[+]`, "mg");
    static inline_mark_mono                         = ctRegex!(`(?P<mark>[#])\{(?P<text>.+?)\}[#]`, "mg");
    static inline_mark_cite                         = ctRegex!(`(?P<mark>["])\{(?P<text>.+?)\}["]`, "mg");
    static inline_faces_line                        = ctRegex!(`^[*!/_]_ (?P<text>.+?)((?: [\\]{2}|[~]#){0,2}$)`);
    static inline_emphasis_line                     = ctRegex!(`^\*_ (?P<text>.+?)(?P<tail>(?: [\\]{2}|[~]#){0,2}$)`);
    static inline_bold_line                         = ctRegex!(`^!_ (?P<text>.+?)(?P<tail>(?: [\\]{2}|[~]#){0,2}$)`);
    static inline_italics_line                      = ctRegex!(`^/_ (?P<text>.+?)(?P<tail>(?: [\\]{2}|[~]#){0,2}$)`);
    static inline_underscore_line                   = ctRegex!(`^__ (?P<text>.+?)(?P<tail>(?: [\\]{2}|[~]#){0,2}$)`);
  }
}