Hi William

The community is welcome to push this editor forward and make it pretty
(current UI is proof of concept and must be polished).

It is however in its very begining and one must be patient to get all
the files and links to work locally.

From the readme file I already wrote:

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

The editor is in folder

dev-tools/help3/xhpeditor/

To clone the HelpContents2 submodule
-------------------------------------
git clone https://gerrit.libreoffice.org/help helpcontent2

all help files are in helpcontent2/ folder

Other services
--------------
A) A working  apache or nginx webserver at http://localhost
b) PHP support for apache/nginx, include support for XSLT and dependencies

Layout of the folders
---------------------
dev-tools/
------xhpeditor/
-----------helpcontent2/
-----------icons-themes/ (from core/icon-themes/colibre_svg/)
-----------xmlhelp.dtd (linked to hc2/helpers/xmlhelp.dtd
-----------links.txt.xsl (linked to hc2/help3csl/links.txt.xsl)

Setup
-----

*) change to the editor folder

cd <location>/dev-tools/help3/xhpeditor

*) 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

*) 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
ln -s <location>/dev-tools/help3/xhpeditor .

this will create a symbolic link /var/www/html/xhpeditor ->
<location>/dev-tools/help3/xhpeditor

Running the editor
------------------
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

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.

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

Regards
Olivier

Em 18/12/2019 09:49, William Gathoye (LibreOffice) escreveu:
> Hi Olivier,
> 
> The French community received a request from sophi wrt. the ability to
> enhance the design of this page [1].
> 
> Please:
> - precise what are the directions you want us to follow wrt. the design
> you expect
> - give us access to the source repo :)
> 
> A French contributor wanting to provide help on the design is willing to
> help as well. From my side, I'll provide help in this regard as well,
> but will get in charge of the code.
> 
> Regards,
> 
> [1] https://newdesign.libreoffice.org/xhpeditor/index.php
> 

-- 
Olivier Hallot
LibreOffice Documentation Coordinator
Comunidade LibreOffice
Rio de Janeiro - Brasil - Local Time: UTC-03:00
http://tdf.io/joinus

-- 
To unsubscribe e-mail to: [email protected]
Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette
List archive: https://listarchives.libreoffice.org/global/documentation/
Privacy Policy: https://www.documentfoundation.org/privacy

Reply via email to