[Libreoffice-commits] dev-tools.git: help3/xhpeditor
Olivier Hallot (via logerrit)
logerrit at kemper.freedesktop.org
Tue Dec 17 11:54:10 UTC 2019
help3/xhpeditor/README-EDITOR.txt | 48 +++++++++---
help3/xhpeditor/buttons.php | 75 +++++++++++++++++++
help3/xhpeditor/index.php | 145 ++++++++++++--------------------------
help3/xhpeditor/snippets.php | 29 +++++++
help3/xhpeditor/xhpeditor.css | 1
5 files changed, 191 insertions(+), 107 deletions(-)
New commits:
commit b27322ce05f17161ae308ef45fbec9c54096f715
Author: Olivier Hallot <olivier.hallot at libreoffice.org>
AuthorDate: Tue Dec 17 08:27:19 2019 -0300
Commit: Olivier Hallot <olivier.hallot at libreoffice.org>
CommitDate: Tue Dec 17 12:53:53 2019 +0100
xhpeditor: implement check XHP and refactor
* changed switch selector to radio
* offload index.php of chuncks of HTML
* Implement check DTD (after stackoverflow)
* added companion snippets.php for aux functions
Change-Id: I54bd08f1316227d1b3f1e597cb9a043ca5f4e9c5
Reviewed-on: https://gerrit.libreoffice.org/85291
Reviewed-by: Olivier Hallot <olivier.hallot at libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot at libreoffice.org>
diff --git a/help3/xhpeditor/README-EDITOR.txt b/help3/xhpeditor/README-EDITOR.txt
index be42086..67c8d05 100644
--- a/help3/xhpeditor/README-EDITOR.txt
+++ b/help3/xhpeditor/README-EDITOR.txt
@@ -1,5 +1,14 @@
This file explains how to install the XHP online editor and give some hints
+Summary
+-------
+a) Unzip (or clone) the editor in a webserver path
+b) clone the Help repository in your user area
+c) clone the LibreOffice repository
+ - alternatively, copy the icon-theme/ folder
+d) set the configuration in config.php
+e) open index.php in the webserver
+
To clone the editor
-------------------
git clone https://gerrit.libreoffice.org/dev-tools dev-tools
@@ -17,24 +26,27 @@ all help files are in helpcontent2/ folder
Other services
--------------
A) A working apache or nginx webserver at http://localhost
-b) PHP support for apache, include support for xslt
+b) PHP support for apache/nginx, include support for XSLT and dependencies
Setup
-----
-1) change to the editor folder
+*) change to the editor folder
cd <location>/dev-tools/help3/xhpeditor
-
-3) Set a symbolic link to the core repo
+*) Set a symbolic link to the core repo
ln -s <location>/core core
This will make a symbolic link between core -> <location>/core
Note: the core/ link is needed to get the colibre_svg/ icon theme
-4) Web server
+*) set a symbolic link of the DTD
+
+ls -s helpcontent2/helpers/xmlhelp.dtd .
+
+*) Web server
As root/admin execute a symbolic link, assuming /var/www/html is your webroot
cd /var/www/html
@@ -44,17 +56,33 @@ this will create a symbolic link /var/www/html/xhpeditor -> <location>/dev-tools
Running the editor
------------------
-
-point the browser to
+Point the browser to
http://localhost/xhpeditor/index.php
Open XHP file
-------------
+Click Open to pick a local Help file. You should have cloned the helpcontent2/ repo
-type 'source/text/shared/main0108.xhp' and click Open file to load the file in the editor
+Save XHP file
+------------
+Click Save to save the local file. Note that you must navigate to the right folder because
+the suggested file name does not have the full path.
-Render the edited XHP
---------------------
+Check XHP
+--------
+Click to check the xml with respect to its DTD. Used to verify XHP consistency. DTD viloations are
+reported in the rendering area.
+Render the edited XHP
+---------------------
click on 'Render file' to see the XHP page rendered on the right pane.
+
+NOTE:
+- Links are killed to prevent navigating to invalid pages. The link color is kept blue.
+- Embeds are surrounded with a light grey box and have their link in magenta
+- Images and icons are preceded by their URL in magenta
+- Select the 'System' and 'Module' radio buttons to exercise the <switch*> tags
+
+
+
diff --git a/help3/xhpeditor/buttons.php b/help3/xhpeditor/buttons.php
new file mode 100644
index 0000000..80efa3c
--- /dev/null
+++ b/help3/xhpeditor/buttons.php
@@ -0,0 +1,75 @@
+<?php
+echo '<div class="snip_heading">
+ <div class="snip_div">Open:</div><input type="file" id="file-input" accept=".xhp"/>
+ <div class="snip_div">Save:</div><button onclick="download(editor.getValue(),getFileNameFromXML(),\'text/xml\')" class="snip_buttons">Save local file</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Edit:</div>
+ <button onclick="editor.undo()">Undo</button>
+ <button onclick="editor.redo()">Redo</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Document:</div>
+ <button onclick="startNewXHPDoc()" class="snip_buttons">Start new XHP document</button>
+ <button onclick="docHeading()" class="snip_buttons">DocHeading</button>
+ <button onclick="snippet7()" class="snip_buttons">ahelp</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Bookmarks: </div>
+ <button onclick="bookmarkValue()" class="snip_buttons">bk-value</button>
+ <button onclick="bookmarkBranch()" class="snip_buttons">bk-hid</button>
+ <button onclick="bookmarkIndex()" class="snip_buttons">bk-index</button>
+ <button onclick="bookmarkNoWidget()" class="snip_buttons">bk-nowidget</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Sections: </div>
+ <button onclick="section_div()" class="snip_buttons">Section</button>
+ <button onclick="related_topics()" class="snip_buttons">Related Topics</button>
+ <button onclick="howtoget()" class="snip_buttons">How to get</button>
+ <button onclick="bascode_div()" class="snip_buttons">bascode div</button>
+ <button onclick="pycode_div()" class="snip_buttons">pycode div</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Tables:</div>
+ <button onclick="table2R3C()" class="snip_buttons">Table Full</button>
+ <button onclick="tableRow()" class="snip_buttons">TableRow</button>
+ <button onclick="tableCell()" class="snip_buttons">Table Cell</button>
+ <button onclick="iconTable()" class="snip_buttons">Icon Table</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Paragraph:</div>
+ <button onclick="paragraph(\'paragraph\')" class="snip_buttons">paragraph</button>
+ <button onclick="note()" class="snip_buttons">note</button>
+ <button onclick="warning()" class="snip_buttons">warning</button>
+ <button onclick="tip()" class="snip_buttons">tip</button>
+ <button onclick="bascode_par()" class="snip_buttons">bascode-par</button>
+ <button onclick="pycode_par()" class="snip_buttons">pycode-par</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Characters:</div>
+ <button onclick="emph()" class="snip_buttons">emph</button>
+ <button onclick="c_menuitem()" class="snip_buttons">menuitem</button>
+ <button onclick="_input()" class="snip_buttons">input</button>
+ <button onclick="_literal()" class="snip_buttons">literal</button>
+ <button onclick="_keystroke()" class="snip_buttons">keystroke</button>
+ <button onclick="_widget()" class="snip_buttons">widget</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Headings:</div>
+ <button onclick="heading(\'1\')" class="snip_buttons">H1</button>
+ <button onclick="heading(\'2\')" class="snip_buttons">H2</button>
+ <button onclick="heading(\'3\')" class="snip_buttons">H3</button>
+ <button onclick="heading(\'4\')" class="snip_buttons">H4</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Switches:</div>
+ <button onclick="switchXHP(\'appl\')" class="snip_buttons">Switch appl</button>
+ <button onclick="switchXHP(\'sys\')" class="snip_buttons">Switch sys</button>
+ <button onclick="switchInline(\'appl\')" class="snip_buttons">Switchinline appl</button>
+ <button onclick="switchInline(\'sys\')" class="snip_buttons">Switchinline sys</button>
+ <button onclick="MenuPrefMAC()" class="snip_buttons">Menu MAC</button>
+ <button onclick="KeyMAC()" class="snip_buttons">Key MAC</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Lists:</div>
+ <button onclick="tList(\'unordered\')" class="snip_buttons">UL</button>
+ <button onclick="tList(\'ordered\')" class="snip_buttons">OL</button>
+ <button onclick="listItem()" class="snip_buttons">List Item</button>
+ </div>
+ <div class="snip_heading"><div class="snip_div">Links:</div>
+ <button onclick="tVariable()" class="snip_buttons">Variable</button>
+ <button onclick="tEmbed()" class="snip_buttons">Embed</button>
+ <button onclick="tEmbedvar()" class="snip_buttons">Embedvar</button>
+ <button onclick="tLink()" class="snip_buttons">Link</button>
+ </div>'
+?>
diff --git a/help3/xhpeditor/index.php b/help3/xhpeditor/index.php
index 6be0b34..9ccfb17 100644
--- a/help3/xhpeditor/index.php
+++ b/help3/xhpeditor/index.php
@@ -6,9 +6,9 @@
* 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/.
-->
-<?php
-require_once './class.Diff.php';
+<?php
require_once './config.php';
+require_once './snippets.php';
$xhp = $_POST["xhpdoc"];
?>
<html>
@@ -35,115 +35,33 @@ $xhp = $_POST["xhpdoc"];
<body style="font-family:sans-serif;">
<div class="leftside">
<h2>LibreOffice Documentation XHP Editor</h2>
- <form id="CMtextarea" class="form_area" action="index.php" method="post">
+
+ <form id="CMtextarea" class="form_area" method="post" action="index.php">
<input type="submit" name="render_page" value="Render page"/>
<input type="submit" name="get_patch" value="Generate patch"/>
<input type="submit" name="check_xhp" value="Check XHP"/>
<input type="submit" name="open_master" value="Open Master"/>
- <textarea id="xhpeditor" name="xhpdoc" form="CMtextarea">
-<?php
-if (isset($_POST["render_page"])) {
-echo $xhp;
-}elseif (isset($_POST["get_patch"])) {
-echo "get patch";
-}elseif (isset($_POST["check_xhp"])) {
-echo "check xhp";
-}elseif (isset($_POST["open_master"])) {
-echo "Open in master repository";
-}else{
-echo $xhp;
-}
-?>
- </textarea></br>
+ <textarea id="xhpeditor" name="xhpdoc" form="CMtextarea"><?php echo $xhp;?></textarea></br>
</form>
- <div class="snip_heading">
- <div class="snip_div">Open:</div><input type="file" id="file-input" accept=".xhp"/>
- <div class="snip_div">Save:</div><button onclick="download(editor.getValue(),getFileNameFromXML(),'text/xml')" class="snip_buttons">Save local file</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Edit:</div>
- <button onclick="editor.undo()">Undo</button>
- <button onclick="editor.redo()">Redo</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Document:</div>
- <button onclick="startNewXHPDoc()" class="snip_buttons">Start new XHP document</button>
- <button onclick="docHeading()" class="snip_buttons">DocHeading</button>
- <button onclick="snippet7()" class="snip_buttons">ahelp</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Bookmarks: </div>
- <button onclick="bookmarkValue()" class="snip_buttons">bk-value</button>
- <button onclick="bookmarkBranch()" class="snip_buttons">bk-hid</button>
- <button onclick="bookmarkIndex()" class="snip_buttons">bk-index</button>
- <button onclick="bookmarkNoWidget()" class="snip_buttons">bk-nowidget</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Sections: </div>
- <button onclick="section_div()" class="snip_buttons">Section</button>
- <button onclick="related_topics()" class="snip_buttons">Related Topics</button>
- <button onclick="howtoget()" class="snip_buttons">How to get</button>
- <button onclick="bascode_div()" class="snip_buttons">bascode div</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Tables:</div>
- <button onclick="table2R3C()" class="snip_buttons">Table Full</button>
- <button onclick="tableRow()" class="snip_buttons">TableRow</button>
- <button onclick="tableCell()" class="snip_buttons">Table Cell</button>
- <button onclick="iconTable()" class="snip_buttons">Icon Table</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Paragraph:</div>
- <button onclick="paragraph('paragraph')" class="snip_buttons">paragraph</button>
- <button onclick="note()" class="snip_buttons">note</button>
- <button onclick="warning()" class="snip_buttons">warning</button>
- <button onclick="tip()" class="snip_buttons">tip</button>
- <button onclick="bascode_par()" class="snip_buttons">bascode-par</button>
- <button onclick="pycode_par()" class="snip_buttons">pycode-par</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Characters:</div>
- <button onclick="emph()" class="snip_buttons">emph</button>
- <button onclick="c_menuitem()" class="snip_buttons">menuitem</button>
- <button onclick="_input()" class="snip_buttons">input</button>
- <button onclick="_literal()" class="snip_buttons">literal</button>
- <button onclick="_keystroke()" class="snip_buttons">keystroke</button>
- <button onclick="_widget()" class="snip_buttons">widget</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Headings:</div>
- <button onclick="heading('1')" class="snip_buttons">H1</button>
- <button onclick="heading('2')" class="snip_buttons">H2</button>
- <button onclick="heading('3')" class="snip_buttons">H3</button>
- <button onclick="heading('4')" class="snip_buttons">H4</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Switches:</div>
- <button onclick="switchXHP('appl')" class="snip_buttons">Switch appl</button>
- <button onclick="switchXHP('sys')" class="snip_buttons">Switch sys</button>
- <button onclick="switchInline('appl')" class="snip_buttons">Switchinline appl</button>
- <button onclick="switchInline('sys')" class="snip_buttons">Switchinline sys</button>
- <button onclick="MenuPrefMAC()" class="snip_buttons">Menu MAC</button>
- <button onclick="KeyMAC()" class="snip_buttons">Key MAC</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Lists:</div>
- <button onclick="tList('unordered')" class="snip_buttons">UL</button>
- <button onclick="tList('ordered')" class="snip_buttons">OL</button>
- <button onclick="listItem()" class="snip_buttons">List Item</button>
- </div>
- <div class="snip_heading"><div class="snip_div">Links:</div>
- <button onclick="tVariable()" class="snip_buttons">Variable</button>
- <button onclick="tEmbed()" class="snip_buttons">Embed</button>
- <button onclick="tEmbedvar()" class="snip_buttons">Embedvar</button>
- <button onclick="tLink()" class="snip_buttons">Link</button>
+ <div class-"buttonsdiv">
+ <?php include './buttons.php';?>
</div>
</div>
<div class="rightside">
- <?php
+ <?php
$xhp = $_POST["xhpdoc"];
if (isset($_POST["render_page"])) {
- echo '<h2>Rendered page</h2><div class="buttonrow"><div class="systembuttons">';
+ echo '<h2>Rendered page</h2><div class="buttonrow"><div class="systembuttons"><p>System: ';
$opSys = array("MAC", "WIN", "UNIX");
foreach ($opSys as $value) {
- echo '<button onclick="setSystemSpan(\''.$value.'\')" class="snip_buttons">'.$value.'</button>';
+ echo '<input type="radio" name="sys" onclick="setSystemSpan(\''.$value.'\')" class="snip_buttons">'.$value.' ';
}
- echo '</div><div class="applbuttons">';
+ echo '</p></div><div class="applbuttons"><p> Module: ';
$appModule = array("WRITER", "CALC", "IMPRESS", "DRAW", "BASE", "MATH");
foreach ($appModule as $value){
- echo '<button onclick="setApplSpan(\''.$value.'\')" class="snip_buttons">'.$value.'</button>';
+ echo '<input type="radio" name="app" onclick="setApplSpan(\''.$value.'\')" class="snip_buttons">'.$value.' ';
}
- echo '</div></div><div id="renderedpage">';
+ echo '</p></div></div><div id="renderedpage">';
$xml = new DOMDocument();
$xml->loadXML($xhp);
$xsl = new DOMDocument;
@@ -154,8 +72,41 @@ echo $xhp;
$proc->setParameter("","iconpath",$CONFIG["icon_path"]);
$proc->importStyleSheet($xsl);
echo $proc->transformToXml($xml);
- echo'</div>';
- }
+ echo '</div>';
+ }elseif (isset($_POST["check_xhp"])) {
+ libxml_use_internal_errors(true);
+
+ $root = 'helpdocument';
+
+ $old = new DOMDocument;
+ $old->loadXML($xhp);
+
+ $creator = new DOMImplementation;
+ $doctype = $creator->createDocumentType($root, null, 'xmlhelp.dtd');
+ $new = $creator->createDocument(null, null, $doctype);
+ $new->encoding = "utf-8";
+
+ $oldNode = $old->getElementsByTagName($root)->item(0);
+ $newNode = $new->importNode($oldNode, true);
+ $new->appendChild($newNode);
+
+ echo '<h2>Check XHP:</h2>';
+ if (!$new->validate()) {
+ echo '<p class="bug">This document does not verify the DTD and is NOT VALID!</p>';
+ $errors = libxml_get_errors();
+ foreach ($errors as $error) {
+ echo display_xml_error($error, explode("\n", $new->saveXML()));
+ }
+ libxml_clear_errors();
+ }else{
+ echo '<p>This document verifies the DTD!</p>';
+ };
+ }elseif (isset($_POST["get_patch"])) {
+ echo '<h2>Get Patch:</h2>';
+ echo "<p>get patch</p>";
+ } else {
+ echo '<h2>Boo:</h2>';
+ echo '<p>Aha!!!!!</p>';}
?>
</div>
</body>
diff --git a/help3/xhpeditor/snippets.php b/help3/xhpeditor/snippets.php
new file mode 100644
index 0000000..e9b2ddf
--- /dev/null
+++ b/help3/xhpeditor/snippets.php
@@ -0,0 +1,29 @@
+<?php
+function display_xml_error($error, $xml)
+{
+ $return = '<p>'.$xml[$error->line - 1] . '<br>';
+// $return .= str_repeat('-', $error->column) . "^<br>";
+
+ switch ($error->level) {
+ case LIBXML_ERR_WARNING:
+ $return .= "Warning $error->code: ";
+ break;
+ case LIBXML_ERR_ERROR:
+ $return .= "Error $error->code: ";
+ break;
+ case LIBXML_ERR_FATAL:
+ $return .= "Fatal Error $error->code: ";
+ break;
+ }
+
+ $return .= trim($error->message) .
+ "<br> Line: $error->line" .
+ "<br> Column: $error->column";
+
+ if ($error->file) {
+ $return .= "<br> File: " . $error->file;
+ }
+
+ return $return . "<br>--------------------------------------------</p>";
+}
+?>
diff --git a/help3/xhpeditor/xhpeditor.css b/help3/xhpeditor/xhpeditor.css
index 658a237..cfa21d4 100644
--- a/help3/xhpeditor/xhpeditor.css
+++ b/help3/xhpeditor/xhpeditor.css
@@ -58,6 +58,7 @@
line-height: normal;
clear:left;
}
+.buttonsdiv{}
/* Imported from default css for DisplayArea */
#DisplayArea {
More information about the Libreoffice-commits
mailing list