From 8af986212f7c9e1df236ebc0659d08a54cf6b40b Mon Sep 17 00:00:00 2001 From: Jan Holesovsky Date: Thu, 9 Aug 2018 18:15:12 +0200 Subject: Update the README.txt. Change-Id: Id493d2d1fa21a160b4fc7d2bb160e6cb6a38c93b --- help3xsl/HELP-IN-BROWSER-README.txt | 74 --------------------------------- help3xsl/README.txt | 83 ++++++++++++++++++------------------- 2 files changed, 40 insertions(+), 117 deletions(-) delete mode 100644 help3xsl/HELP-IN-BROWSER-README.txt diff --git a/help3xsl/HELP-IN-BROWSER-README.txt b/help3xsl/HELP-IN-BROWSER-README.txt deleted file mode 100644 index 680f433c7d..0000000000 --- a/help3xsl/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 of #DisplayArea to handle &DbPAR and &System params -2. picks the bookmarks file and displays in #BottomLeft
area. -3. Reads URL params. - ------------------------------------------------------------------ -New ‘Object’ tag ------------------------------------------------------------------ - -The filter online_transform.xsl now support the tag defined for XHP files to allow a generic object in the browser. The tag now maps to the folowing HTML5 tags: -Maps to HTML5