diff options
author | Olivier Hallot <olivier.hallot@libreoffice.org> | 2017-05-30 10:19:56 -0300 |
---|---|---|
committer | Olivier Hallot <olivier.hallot@edx.srv.br> | 2017-05-30 16:12:16 +0200 |
commit | 72e210bd694688738bffb6855221e2b1ff0b1e72 (patch) | |
tree | e5d6c3a840b96cf19dd0d7e5c0a0c28d700f9342 /source/help-to-html.sh | |
parent | 6e54fc4fe1c01d4b3b015b9074f0dc8d10257ee9 (diff) |
Rewrite online help contents
I have worked in a new implementation of the Help online. The strategy
was to batch "flatten" all XHP into HTML files with an offline
transformation using xsltproc.
(by "flatten", I mean resolve all embeds in XHP files)
see http://vm173.documentfoundation.org
This way all displayed files are now HTML with minimal javascript. No
more on-line XSLT transformation and their associate issues (delays) and
poor debug.
Advantages:
1) preserve all XHP files as-is, authoring tools, DTD.
2) preserve current translation workflow
3) all files turned to HTML static, with minimum Javascript
4) much faster load times, browser cache used.
5) Honors parameters &System and &DbPAR
6) URL bookmarking in browser (Ctrl-D)
7) Page navigation back and forth with browser buttons
8) preserve current HC2 in LibreOffice (see 1).
9) resolved <switchinline><caseinline> for &System and &DbPAR (aka
module).
10) maintained Fabio's bookmark search solution.
11) index-able by search engines (XHP files were unknown to robots).
12) pages can be directly accessed: e.g.
http://localhost/text/scalc/01/04060106.html?DbPAR=CALC#bm_id3153114
13) hold Google search snippet in TopRight area
Disadvantages (Most are further work):
1) issue with offline use (file://path/to/pages/)
To do:
1) batch create html of localized pages, localized bookmarks
2) Resolve missing images paths (Icons are in core/icon-themes/)
3) Resolve protocol file:// for offline use (hit CORS guideline
restriction for browsers)
4) provide better layout for bookmarks in the left pane
5) work on web CSS to make it beautiful
6) Clean up the XSLT filter, set a debug param.
7) more
Change-Id: I6de74037dbb59da872153f853237afd75b47c917
Reviewed-on: https://gerrit.libreoffice.org/38220
Reviewed-by: Olivier Hallot <olivier.hallot@edx.srv.br>
Tested-by: Olivier Hallot <olivier.hallot@edx.srv.br>
Diffstat (limited to 'source/help-to-html.sh')
-rwxr-xr-x | source/help-to-html.sh | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/source/help-to-html.sh b/source/help-to-html.sh new file mode 100755 index 0000000000..e7be6cbead --- /dev/null +++ b/source/help-to-html.sh @@ -0,0 +1,24 @@ +#/bin/bash + +# This file is part of the LibreOffice project. +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +outdir=html/ +filter=online_transform.xsl +rm -rf $outdir +mkdir $outdir +cp default.css help.js jquery-3.1.1.min.js $outdir +cp -rap media $outdir'media' +./get_bookmark.sh $outdir +for filep in `find text/ -name *.xhp` +do +DIR=${filep%/*} +FILEN=${filep##*/} +name=${FILEN:0:-3} +outfile=$outdir$DIR/$name'html' +xsltproc -o $outfile $filter $filep +done +ln -s text/shared/main0108.html $outdir'index.html' |