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>

1 files changed, 4 insertions, 40 deletions

diff --git a/source/HELP-IN-BROWSER-README.txt b/source/HELP-IN-BROWSER-README.txt
index ab8f49a5df..159c134827 100644
--- a/source/HELP-IN-BROWSER-README.txt
+++ b/source/HELP-IN-BROWSER-README.txt
@@ -28,24 +28,18 @@ default.css:
 -------------
 the cascading style sheet for HTML formatting.
 
-index.html: 
------------
-The entry web page in the root folder of the server. Displays the #TopLeft <div> with links to LibreOffice modules help libraries.
-
 online_transform.xsl:
 --------------------
 the XSL transform file. Transform XHP files into HTML files.
 
 This file is a modification of xmlhelper/util/main_transform.xsl, which was designed for xmlhelp XSL processor.
 
-The XSLT online_transform.xsl is used inside help.js. 
-
 help.js
 -------
 This javascript file: 
-1. takes XHP files and online_transform.xsl and generates the HTML contents to be displayed in #DisplayArea <div>. 
+1. modifies href attributes in <a> of #DisplayArea to handle &DbPAR and &System params
 2. picks the bookmarks file and displays in #BottomLeft <div> area.
-3. displays the XHP file patch and bookmark in the #TopRight <div> area
+3. Reads URL params.
 
 -----------------------------------------------------------------
 New ‘Object’ tag
@@ -71,39 +65,9 @@ Maps to HTML5 <object> tag:
 How to build the LibreOffice Browser help 
 ----------------------------------------------------------------- 
 
-1) Media files: Media files in helpcontent2 are located in module 
-icons-themes/ . It is necessary to copy core/icon-themes/galaxy into the media/ folder 
+1) run help-to-html.sh 
 
-Note: For the moment, only Galaxy icon them is fully supported.
 
-2) Run the getbookmark.sh script to generate the bookmark index for the
-LibreOffice Modules
+2) copy folder html/ to your root web server.
 
------------------------------------------------------------------ 
-Folder layout.
------------------------------------------------------------------ 
 
-Root folder:source/
-			default.css
-			online_transform.xsl
-			index.html
-			help.js
-			jquery<version>-min.js
-			media/
-				movies/
-				screenshots/
-			text/
-
-
-Notes:
-1. the online_transform.xsl is main_transform.xsl of HC2 modified to accomodate the layout of the screen, It has 4 <div> hooked in each of the 4 corners of the browser screen to allow resizing.
-2. the lower-right <div> displays the help content
-3. the upper-left <div> has entries to change help books/modules
-4. the upper right <div> is available to place a search mechanism
-5. the lower-left <div> is available to inser a index with javascript
-6. index.html is just a top landing page.
-7. default.css is the css used in helpconten2/languages
-8. plenty of simplification/tweak is possible in the XSLT.
-9. The whole HC can be tranformed in html with XSLTPROC or any other XSL processor, provided the reference to the XSL file is fixed, and the xsl file be aware of the specifics of the XSL processor.
-10. Works with Firefox, Chrome, Rekonq.
-11. References to media are incomplete. That will require a change in the urls of the media inside the help pages, thus forking from HC2