summaryrefslogtreecommitdiffstats
path: root/solenv/bin/mkdocs_portal.sh
blob: 852e3448179d4e4bcde1ce0f6f20a9cfb174d27c (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
#!/bin/bash

if [ -n "$debug" ] ; then
    set -x
fi

SRCDIR="$1"
BASE_OUTPUT="$2"

pushd "$SRCDIR" > /dev/null


function header
{
    local title="$1"
    local breadcrumb="$2"
    local output="$3"

    cat - > $output <<EOF
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
        <title>$title</title>

        <style>
        * { margin: 0; padding: 0; }
        body { font-family: sans-serif; font-size: 12px; }
        #head { padding: 20px; background: #00A500; }
        #head a { color: #000; }
        #body { padding: 20px; }
        #foot { padding: 10px; font-size: 9px; border-top: 1px #18A303 solid; margin-top: 25px; }
        p { line-height: 1.7em; margin-bottom: 1em; }
        pre { margin-bottom: 0.5em; }
        .multi-col { -moz-column-width: 20em; -webkit-column-width: 20em; -moz-column-gap: 1em; -webkit-column-gap: 1em; }
        h1 { margin-bottom: 0.5em; }
        h2,h3,h4 { margin: 1.3em 0 0.5em 0; }
        ul, ol { margin: 0.5em 1.5em; }
        </style>
</head>
<body>
        <div id="head">
        <h1>${title}</h1>
        <p>${breadcrumb}</p>
        </div>
        <div id="body" style="multi-col">
EOF
}

function footer
{
local output="$1"

  cat - >> $output <<EOF

</div>
<div id="foot">
  <small>
    <p>Generated by Libreoffice CI on $(hostname)</p>
    <p>Last updated:
EOF

date '+%F %T' >> $output
cat - >> $output <<EOF
    | <a href="http://www.documentfoundation.org/privacy">Privacy Policy</a> | <a href="http://www.documentfoundation.org/imprint">Impressum (Legal Info)</a>
    </p>
  </small>
</div>
</body>
</html>
EOF

}

function proc_text
{
    # Local links: [[...]]
    # Git links: [git:...]
    # Other remote links: [...]
    # Headings: == bleh ==
    # Paragraphs: \n\n
    sed -re ' s/\[\[([-_a-zA-Z0-9]+)\]\]/<a href="\1.html">\1<\/a>/g' - \
        | sed -re ' s/\[git:([^]]+)\]/<a href="https:\/\/cgit.freedesktop.org\/libreoffice\/core\/tree\/\1">\1<\/a>/g' \
        | sed -re ' s/\[([^]]+)\]/<a href="\1">\1<\/a>/g' \
        | sed -re ' s/====([^=]+)====/<h4>\1<\/h4>/g' \
        | sed -re ' s/===([^=]+)===/<h3>\1<\/h3>/g' \
        | sed -re ' s/==([^=]+)==/<h2>\1<\/h2>/g' \
        | sed -re ':a;N;$!ba;s/\n\n/<\/p><p>/g' \
        | awk 'BEGIN { print "<p>" } { print } END { print "</p>" }'
}

# generate entry page

echo "generating index page"
header "LibreOffice Modules" " " "$BASE_OUTPUT/index.html"

for module_name in *; do
    if [ -d $module_name ]; then
        cur_file=
        if [ -f $module_name/readme.txt ] ; then
            cur_file="$module_name/readme.txt"
        elif [ -f $module_name/README ] ; then
            cur_file="$module_name/README"
        fi
        if [ -n "$cur_file" ]; then
            # write index.html entry
            text="<h2><a href=\"${module_name}.html\">${module_name}</a></h2>\n"
            text="${text}$(head -n1 $cur_file | proc_text )"
            echo -e $text >> "$BASE_OUTPUT/index.html"

            # write detailed module content
            header "$module_name" "<a href=\"index.html\">LibreOffice</a> &raquo; ${module_name}" "$BASE_OUTPUT/${module_name}.html"
            text="<p><b>View module in:</b>"
            text="${text} &nbsp; <a href=\"https://cgit.freedesktop.org/libreoffice/core/tree/${module_name}\">cgit</a>"
            if [ -d ./docs/${module_name} ] ; then
                text="${text} &nbsp; <a href=\"${module_name}/html/classes.html\">Doxygen</a>"
            fi
            text="${text} </p><p>&nbsp;</p>"
            echo -e $text >> "$BASE_OUTPUT/${module_name}.html"
            proc_text < $cur_file >> "$BASE_OUTPUT/${module_name}.html"
            footer "$BASE_OUTPUT/${module_name}.html"
        else
            empty_modules[${#empty_modules[*]}]=$module_name
        fi
    fi
done

if [ ${#empty_modules[*]} -gt 0 ]; then
    echo -e "<p>&nbsp;</p><p>READMEs were not available for these modules:</p><ul>\n" >> "$BASE_OUTPUT/index.html"
    for module_name in "${empty_modules[@]}"; do
        echo -e "<li><a href=\"https://cgit.freedesktop.org/libreoffice/core/tree/${module_name}\">${module_name}</a></li>\n" >> "$BASE_OUTPUT/index.html"
    done
    echo -e "</ul>\n" >> "$BASE_OUTPUT/index.html"
fi

footer "$BASE_OUTPUT/index.html"

popd > /dev/null

## done