blob: 743af0d90b7c5ebf1da7703f8da48bedea21d6a4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
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://git.libreoffice.org/dev-tools dev-tools
The editor is in folder
dev-tools/help3/xhpeditor/
To clone the HelpContents2 submodule
-------------------------------------
git clone --depth 2 https://git.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
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
|
