diff options
author | Olivier Hallot <olivier.hallot@libreoffice.org> | 2018-04-16 19:19:10 -0300 |
---|---|---|
committer | Jan Holesovsky <kendy@collabora.com> | 2018-08-07 17:55:28 +0200 |
commit | 868873e513d5da6fe6bba265c98fcba2fc014d08 (patch) | |
tree | f49882fbb32bd5d4c07f7c2415b8b2679f594809 /source | |
parent | b06a7ed9e831ef07ba93e683b670c04301d3eb95 (diff) |
Helpcontent2 housekeeping
Deleted spurious file in source/
Change-Id: Ia7417413e615635496398c223a0d95911c994123
Reviewed-on: https://gerrit.libreoffice.org/53012
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Diffstat (limited to 'source')
-rw-r--r-- | source/HELP-IN-BROWSER-README.txt | 74 | ||||
-rw-r--r-- | source/index.html | 50 |
2 files changed, 0 insertions, 124 deletions
diff --git a/source/HELP-IN-BROWSER-README.txt b/source/HELP-IN-BROWSER-README.txt deleted file mode 100644 index 680f433c7d..0000000000 --- a/source/HELP-IN-BROWSER-README.txt +++ /dev/null @@ -1,74 +0,0 @@ ------------------------------------------------------------------ -Helpcontent displayed in a browser directly from XML ------------------------------------------------------------------ - -This README shows how to display Helpcontent2 XML pages (XHP) directly rendered in a modern browser. - ------------------------------------------------------------------ -Background ------------------------------------------------------------------ - -The XML files must be transformed into HTML files with the help of a style sheet file (XSL). - -In the current helpcontent2, the processing is done in xmlhelp/ module, an ancient XSLT processor developed circa 2005 (OpenOffice.org 1.5) - -Modern browsers such as Firefox, Chrome and Rekonq are capable to execute the transformation direcly in the client, by getting an URL that returns a XML file that contains the reference of the necessary XSL style sheet. - -How to display Helpcontent2 in a browser - -1. Open the browser -2. Open the file index.html in source/ folder -3. Navigate in pages - ------------------------------------------------------------------ -File descriptions ------------------------------------------------------------------ - -default.css: -------------- -the cascading style sheet for HTML formatting. - -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. - -help.js -------- -This javascript file: -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. Reads URL params. - ------------------------------------------------------------------ -New ‘Object’ tag ------------------------------------------------------------------ - -The filter online_transform.xsl now support the <object> tag defined for XHP files to allow a generic object in the browser. The <object> tag now maps to the folowing HTML5 tags: -Maps to HTML5 <video> tag: - -<section id="video"> - <object id="1232312" type ="video/ogg" data="movies/testvideo.ogv" height="480px" width="640px"/> -</section> - -Maps to HTML5 <audio> tag: -<section id="audio"> - <object id="1232312" type ="audio/ogg" data="audio/testaudio.wav" height="" width=""/> -</section> - -Maps to HTML5 <object> tag: - - <object id="1232312" type ="{mimetype}" data="object/testobject.swf" height="" width=""/> - ------------------------------------------------------------------ -How to build the LibreOffice Browser help ------------------------------------------------------------------ - -1) run help-to-html.sh in helpcontent2/source/ folder. A previous language build must exist in workdir/HelpTranslatePartHelp/ . -The script will build all existing languages available in this folder. See help-to-html.sh script and adjust path. - - -2) copy folder html/ to your root web server. - - diff --git a/source/index.html b/source/index.html deleted file mode 100644 index 32a2a53029..0000000000 --- a/source/index.html +++ /dev/null @@ -1,50 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -* 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/. -* ---> -<html> -<head> -<title>LibreOffice Help</title> -<link href="default.css" rel="Stylesheet" type="text/css" /> -<script type="text/javascript" src="jquery-3.1.1.min.js"></script> -<script type="text/javascript" src="help.js"></script> -</head> -<body> - <div id="DisplayArea"></div> - <div id="TopLeft"> - <table> - <tr> - <td><p class="topmenu" onclick="displayResult('text/scalc/main0000.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=scalc','calc')">Calc</p></td> - <td><p class="topmenu" onclick="displayResult('text/swriter/main0000.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=swriter','writer')">Writer</p></td> - <td><p class="topmenu" onclick="displayResult('text/simpress/main0000.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=simpress','impress')">Impress</p></td> - <td><p class="topmenu" onclick="displayResult('text/sdraw/main0000.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=sdraw','draw')">Draw</p></td> - <td><p class="topmenu" onclick="displayResult('text/schart/main0000.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=schart','chart')">Chart</p></td> - <td><p class="topmenu" onclick="displayResult('text/sbasic/shared/main0601.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=sbasic','basic')">Basic</p></td> - <td><p class="topmenu" onclick="displayResult('text/smath/main0000.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=smath','math')">Math</p></td> - <td><p class="topmenu" onclick="displayResult('text/shared/explorer/database/main.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=shared','shared')">Base</p></td> - <td><p class="topmenu" onclick="displayResult('text/shared/guide/main.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=shared','shared')">Guide</p></td> - </tr> - </table> - <p>Search: <input type="text" id="search-bar"/></p> - </div> - <div id="BottomLeft"></div> - <div id="NavigationHistory"></div> - <div id="TopRight"></div> -<script type="text/javascript"> -if (window.location.href.indexOf('?') && getParameterByName('page')) { - var module = getParameterByName("DbPAR"); - var language = getParameterByName("Language"); - var system = getParameterByName("System"); - var usedb = getParameterByName("UseDB"); - displayResult('text/' + getParameterByName('page') + '?&DbPAR='+module+'&Language='+language+'&System='+system+'&UseDB='+usedb); -} else { - displayResult('text/shared/main0108.xhp?Language=en-US&System=WIN&UseDB=no&DbPAR=shared','shared'); -} -</script> -</body> -</html> |