aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/doc_reform/io_out/html_snippet.d
blob: 843f5416ce6cf80001fb66fe5dd98b5d2a551a27 (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
/+
- 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]

+/
module doc_reform.io_out.html_snippet;
@safe:
template htmlSnippet() {
  import
    std.file,
    std.outbuffer,
    std.format,
    std.uri,
    std.conv : to;
  import
    doc_reform.io_out.rgx,
    doc_reform.meta.rgx_files,
    doc_reform.io_out.rgx_xhtml;
  auto format_html_blank_page_guide_home()(
    string css_style,
    string home_url,
    string collection_home_path
  ) {
    auto html_blank_default = format(q"┃<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/plain; charset=UTF-8" />
    <link href="%s" rel="stylesheet" />
  </head>
  <body>
    <p class="icons">
      <a href="%s" class="lnkicon">⟰&nbsp;</a>&nbsp;
      <a href="%s" class="lnkicon">&nbsp;≅&nbsp;</a>
    </p>
  </body>
</html>┃",
      css_style,
      home_url,
      collection_home_path
    );
    return html_blank_default;
  }
  string special_characters_text(string _txt) {
    mixin spineRgxOut;
    mixin spineRgxXHTML;
    static auto rgx = RgxO();
    static auto rgx_xhtml = RgxXHTML();
    _txt = _txt
      .replaceAll(rgx_xhtml.ampersand,    "&amp;")  // "&#38;"
      .replaceAll(rgx_xhtml.quotation,    "&quot;") // "&#34;"
      .replaceAll(rgx_xhtml.less_than,    "&lt;")   // "&#60;"
      .replaceAll(rgx_xhtml.greater_than, "&gt;")   // "&#62;"
      .replaceAll(rgx.br_line,            "<br />")
      .replaceAll(rgx.br_line_inline,     "<br />")
      .replaceAll(rgx.br_line_spaced,     "<br />\n<br />")
      .replaceAll(rgx.nbsp_char,          " ");
    return _txt;
  }
}