aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/doc_reform/meta/defaults.d
blob: 7abf30a410fe8f95f43efc04adee9cc36e6f0864 (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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
/+
- 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]

+/
/++
  default settings
+/
module doc_reform.meta.defaults;
template spineNode() {
  @safe static string[string] node_metadata_heading_str() {
    string[string] _node = [
        "is"                            : "",
        "ocn"                           : "",
        "marked_up_lev"                 : "",
        "segment_anchor_tag_html"       : "",
        "segment_anchor_tag_epub"       : "",
        "attrib"                        : "",
    ];
    return _node;
  }
  @safe static int[string] node_metadata_heading_int() {
    int[string] _node = [
        "ocn"                           : 0, // decide whether to use or keep?
        "ptr_doc_object"                : 0,
        "ptr_html_segnames"             : 0,
        "ptr_heading"                   : 0,
        "heading_lev_markup"            : 9,
        "heading_lev_collapsed"         : 9,
        "parent_ocn"                    : 0,
        "parent_lev_markup"             : 9,
    ];
    return _node;
  }
  @safe static string[string] node_metadata_para_str() {
    string[string] _node = [
        "is"                            : "",
        "ocn"                           : "",
        "attrib"                        : "",
    ];
    return _node;
  }
  @safe static int[string] node_metadata_para_int() {
    int[string] _node = [
        "ocn"                           : 0,
        "indent_base"                   : 0,
        "indent_hang"                   : 0,
        "bullet"                        : 0, // bool (0|1)
    ];
    return _node;
  }
}
template spineCurateMetadata() {
  @safe auto spineCurateMetadata() {
    struct _Curate {
      struct Curate {
        string   title                = "";
        string[] author_arr           = [];
        string   author               = "";
        string   author_surname       = "";
        string   author_surname_fn    = "";
        string   language             = "";
        string   language_original    = "";
        string   uid                  = "";
        string   date_published       = "";
        string[] topic_register_arr   = [];
        string   path_html_metadata   = "";
        string   path_html_scroll     = "";
        string   path_html_segtoc     = "";
        string   path_epub            = "";
        string   path_abs_html_segtoc = "";
        string   path_abs_html_scroll = "";
        string   path_abs_epub        = "";
        string   url_html_seg         = "";
        string   url_html_scroll      = "";
        string   url_epub             = "";
      }
      Curate curate;
      Curate[] curates;
      Curate[][string][string][string][string] subject_trees;
    }
    return _Curate();
  }
}
template spineBiblio() {
  // required: deemed_author (author || editor); year; fulltitle;
  struct BibJsnStr {
    @safe static auto biblio_entry_tags_jsonstr() {
      string x =  `{
        "is"                               : "",
        "sortby_deemed_author_year_title"  : "",
        "deemed_author"                    : "",
        "author_raw"                       : "",
        "author"                           : "",
        "author_arr"                       : [ "" ],
        "editor_raw"                       : "",
        "editor"                           : "",
        "editor_arr"                       : [ "" ],
        "title"                            : "",
        "subtitle"                         : "",
        "fulltitle"                        : "",
        "language"                         : "",
        "trans"                            : "",
        "src"                              : "",
        "journal"                          : "",
        "in"                               : "",
        "volume"                           : "",
        "edition"                          : "",
        "year"                             : "",
        "place"                            : "",
        "publisher"                        : "",
        "url"                              : "",
        "pages"                            : "",
        "note"                             : "",
        "short_name"                       : "",
        "id"                               : ""
      }`; // is: book, article, magazine, newspaper, blog, other
      return x;
    }
  }
}
template InternalMarkup() {
  import std.array;
  static struct InlineMarkup {
    string en_a_o = "【";      string en_a_c = "】";
    string en_b_o = "〖";      string en_b_c = "〗";
    string quote_o = "“";      string quote_c = "”";
    string ff_i = "⑆";         string ff_o = "┨";         string ff_c = "┣"; // fontface
    string lnk_o = "┥";        string lnk_c = "┝";
    string url_o = "┤";        string url_c = "├";
    string emph = "*";
    string bold = "!";
    string italic = "/";
    string underscore = "_";
    string superscript = "^";
    string subscript = ",";
    string mono = "■";
    string cite = "‖";
    string mark_internal_site_lnk = "¤";
    string nbsp                   = "░";
    string br_line                = "┘";
    string br_line_inline         = "┙";
    string br_line_spaced         = "┚";
    string br_obj                 = "break_obj";
    string br_page_line           = "┼";
    string br_page                = "┿";
    string br_page_new            = "╂";
    string tc_s                   = "┊";
    string tc_o                   = "┏";
    string tc_c                   = "┚";
    string tc_p                   = "┆";
    string img                    = "☼";
    string sep                    = "␣"; // "~";"␣"; // "~";
    string uid_sep                = ":";
    string on_o  = "「";       string on_c  = "」";
    string mk_bullet               = "● ";
    static string indent_by_spaces_provided(int indent, string _indent_spaces ="░░") {
      _indent_spaces = replicate(_indent_spaces, indent);
      return _indent_spaces;
    }
    static string repeat_character_by_number_provided(C,N)(C _character ="-", N number=10) {
      _character = replicate(_character, number);
      return _character;
    }
  }
}
template spineLanguageCodes() {
  /+ language codes +/
  struct Lang {
    @safe static string[string][string] codes() {
      auto _lang_codes = [
        "am":    [ "c": "am",    "n": "Amharic",           "t": "Amharic",                   "xlp": "amharic"      ],
        "bg":    [ "c": "bg",    "n": "Bulgarian",         "t": "Български (Bəlgarski)",     "xlp": "bulgarian"    ],
        "bn":    [ "c": "bn",    "n": "Bengali",           "t": "Bengali",                   "xlp": "bengali"      ],
        "br":    [ "c": "br",    "n": "Breton",            "t": "Breton",                    "xlp": "breton"       ],
        "ca":    [ "c": "ca",    "n": "Catalan",           "t": "catalan",                   "xlp": "catalan"      ],
        "cs":    [ "c": "cs",    "n": "Czech",             "t": "česky",                     "xlp": "czech"        ],
        "cy":    [ "c": "cy",    "n": "Welsh",             "t": "Welsh",                     "xlp": "welsh"        ],
        "da":    [ "c": "da",    "n": "Danish",            "t": "dansk",                     "xlp": "danish"       ],
        "de":    [ "c": "de",    "n": "German",            "t": "Deutsch",                   "xlp": "german"       ],
        "el":    [ "c": "el",    "n": "Greek",             "t": "Ελληνικά (Ellinika)",       "xlp": "greek"        ],
        "en":    [ "c": "en",    "n": "English",           "t": "English",                   "xlp": "english"      ],
        "eo":    [ "c": "eo",    "n": "Esperanto",         "t": "Esperanto",                 "xlp": "esperanto"    ],
        "es":    [ "c": "es",    "n": "Spanish",           "t": "español",                   "xlp": "spanish"      ],
        "et":    [ "c": "et",    "n": "Estonian",          "t": "Estonian",                  "xlp": "estonian"     ],
        "eu":    [ "c": "eu",    "n": "Basque",            "t": "basque",                    "xlp": "basque"       ],
        "fi":    [ "c": "fi",    "n": "Finnish",           "t": "suomi",                     "xlp": "finnish"      ],
        "fr":    [ "c": "fr",    "n": "French",            "t": "français",                  "xlp": "french"       ],
        "ga":    [ "c": "ga",    "n": "Irish",             "t": "Irish",                     "xlp": "irish"        ],
        "gl":    [ "c": "gl",    "n": "Galician",          "t": "Galician",                  "xlp": "galician"     ],
        "he":    [ "c": "he",    "n": "Hebrew",            "t": "Hebrew",                    "xlp": "hebrew"       ],
        "hi":    [ "c": "hi",    "n": "Hindi",             "t": "Hindi",                     "xlp": "hindi"        ],
        "hr":    [ "c": "hr",    "n": "Croatian",          "t": "Croatian",                  "xlp": "croatian"     ],
        "hy":    [ "c": "hy",    "n": "Armenian",          "t": "Armenian",                  "xlp": "armenian"     ],
        "ia":    [ "c": "ia",    "n": "Interlingua",       "t": "Interlingua",               "xlp": "interlingua"  ],
        "is":    [ "c": "is",    "n": "Icelandic",         "t": "Icelandic",                 "xlp": "icelandic"    ],
        "it":    [ "c": "it",    "n": "Italian",           "t": "Italiano",                  "xlp": "italian"      ],
        "ja":    [ "c": "ja",    "n": "Japanese",          "t": "日本語 (Nihongo)",         "xlp": "japanese"      ],
        "ko":    [ "c": "ko",    "n": "Korean",            "t": "Korean",                    "xlp": "korean"       ],
        "la":    [ "c": "la",    "n": "Latin",             "t": "Latin",                     "xlp": "latin"        ],
        "lo":    [ "c": "lo",    "n": "Lao",               "t": "Lao",                       "xlp": "lao"          ],
        "lt":    [ "c": "lt",    "n": "Lithuanian",        "t": "Lithuanian",                "xlp": "lithuanian"   ],
        "lv":    [ "c": "lv",    "n": "Latvian",           "t": "Latvian",                   "xlp": "latvian"      ],
        "ml":    [ "c": "ml",    "n": "Malayalam",         "t": "Malayalam",                 "xlp": "malayalam"    ],
        "mr":    [ "c": "mr",    "n": "Marathi",           "t": "Marathi",                   "xlp": "marathi"      ],
        "nl":    [ "c": "nl",    "n": "Dutch",             "t": "Nederlands",                "xlp": "dutch"        ],
        "no":    [ "c": "no",    "n": "Norwegian",         "t": "norsk",                     "xlp": "norsk"        ],
        "nn":    [ "c": "nn",    "n": "Norwegian Nynorsk", "t": "nynorsk",                   "xlp": "nynorsk"      ],
        "oc":    [ "c": "oc",    "n": "Occitan",           "t": "Occitan",                   "xlp": "occitan"      ],
        "pl":    [ "c": "pl",    "n": "Polish",            "t": "polski",                    "xlp": "polish"       ],
        "pt":    [ "c": "pt",    "n": "Portuguese",        "t": "Português",                 "xlp": "portuges"     ],
        "pt_BR": [ "c": "pt_BR", "n": "Portuguese Brazil", "t": "Brazilian Português",       "xlp": "brazilian"    ],
        "ro":    [ "c": "ro",    "n": "Romanian",          "t": "română",                    "xlp": "romanian"     ],
        "ru":    [ "c": "ru",    "n": "Russian",           "t": "Русский (Russkij)",         "xlp": "russian"      ],
        "sa":    [ "c": "sa",    "n": "Sanskrit",          "t": "Sanskrit",                  "xlp": "sanskrit"     ],
        "se":    [ "c": "se",    "n": "Sami",              "t": "Samin",                     "xlp": "samin"        ],
        "sk":    [ "c": "sk",    "n": "Slovak",            "t": "slovensky",                 "xlp": "slovak"       ],
        "sl":    [ "c": "sl",    "n": "Slovenian",         "t": "Slovenian",                 "xlp": "slovenian"    ],
        "sq":    [ "c": "sq",    "n": "Albanian",          "t": "Albanian",                  "xlp": "albanian"     ],
        "sr":    [ "c": "sr",    "n": "Serbian",           "t": "Serbian",                   "xlp": "serbian"      ],
        "sv":    [ "c": "sv",    "n": "Swedish",           "t": "svenska",                   "xlp": "swedish"      ],
        "ta":    [ "c": "ta",    "n": "Tamil",             "t": "Tamil",                     "xlp": "tamil"        ],
        "te":    [ "c": "te",    "n": "Telugu",            "t": "Telugu",                    "xlp": "telugu"       ],
        "th":    [ "c": "th",    "n": "Thai",              "t": "Thai",                      "xlp": "thai"         ],
        "tk":    [ "c": "tk",    "n": "Turkmen",           "t": "Turkmen",                   "xlp": "turkmen"      ],
        "tr":    [ "c": "tr",    "n": "Turkish",           "t": "Türkçe",                    "xlp": "turkish"      ],
        "uk":    [ "c": "uk",    "n": "Ukranian",          "t": "українська (ukrajins\"ka)", "xlp": "ukrainian"    ],
        "ur":    [ "c": "ur",    "n": "Urdu",              "t": "Urdu",                      "xlp": "urdu"         ],
        "us":    [ "c": "en",    "n": "English (American)","t": "English",                   "xlp": "english"      ],
        "vi":    [ "c": "vi",    "n": "Vietnamese",        "t": "Vietnamese",                "xlp": "vietnamese"   ],
        "zh":    [ "c": "zh",    "n": "Chinese",           "t": "中文",                     "xlp": "chinese"       ],
        "en":    [ "c": "en",    "n": "English",           "t": "English",                   "xlp": "english"      ],
        "xx":    [ "c": "xx",    "n": "Default",           "t": "English",                   "xlp": "english"      ],
      ];
      return _lang_codes;
    }
    @safe static string[] code_arr_ptr() {
      string[] _lang_codes = ["am", "bg", "bn", "br", "ca", "cs", "cy", "da", "de", "el", "en", "eo", "es", "et", "eu", "fi", "fr", "ga", "gl", "he", "hi", "hr", "hy", "ia", "is", "it", "ja", "ko", "la", "lo", "lt", "lv", "ml", "mr", "nl", "no", "nn", "oc", "pl", "pt", "pt_BR", "ro", "ru", "sa", "se", "sk", "sl", "sq", "sr", "sv", "ta", "te", "th", "tk", "tr", "uk", "ur", "us", "vi", "zh", "en", "xx",];
      return _lang_codes;
    }
    @safe static string[] code_arr() {
      string[] _lang_codes = ["am", "bg", "bn", "br", "ca", "cs", "cy", "da", "de", "el", "en", "eo", "es", "et", "eu", "fi", "fr", "ga", "gl", "he", "hi", "hr", "hy", "ia", "is", "it", "ja", "ko", "la", "lo", "lt", "lv", "ml", "mr", "nl", "no", "nn", "oc", "pl", "pt", "pt_BR", "ro", "ru", "sa", "se", "sk", "sl", "sq", "sr", "sv", "ta", "te", "th", "tk", "tr", "uk", "ur", "vi", "zh"];
      return _lang_codes;
    }
    @safe static auto codes_() {
      return "(" ~ join(code_arr,"|") ~ ")";
    }
    static auto codes_regex() {
      return regex(codes_);
    }
  }
}