[libreoffice-documentation] New XHP editor online for testing and feedback

[Olivier Hallot]

Hi Help Authors, L10n Translators and developers

Following Mike's announcement, I have improved and fixed a bit the XHP
editor, and changed the page address (*) (apologies)

The editor is still work in progress, but starts to become interesting
for creating and editing Help pages.

What's new

----------

+ Mike's implementation of the autocompletion of XHP tags

+ The left and right panes are now fixed in browser screen and scrollable

+ The right pane uses 99% of the current Help transformation rendering, plus

+ some visual debug information left intentionally to help Author in
adjusting <embed>s, <link>s and <image>s

+ You can now open a Help page directly from the interface. The help
page is normally

source/text/<module>/AAA/BBB/myHelpPage.xhp

Type <module>/AAA/BBB/myHelpPage.xhp in the text box and click "Open
File" to load in the editor

Press "Render page" to see it on the right.

+ A set of buttons with XHP snippets to shorten editing workload:

- For paragraphs, notes, headings, emph, menuitems, etc... select the
raw text or contents and click the corresponding button. The raw text
will be wrapped with the opening and closing tag. For paragraph-like
contents, an unique id will be created automatically.

- Other snippets builds fragments of XHP tags, such as tables, tablerow,
lists, sections, and more, including the

- just play with and do not forget to render the page on the right.

Restrictions

-------------

+ The editor works with Firefox only. Issues with Chrome and Edge. Other
browsers not yet tested.

+ saving files not implemented. However you can copy the editor contents
and finish the patch in you preferred editor

+ More XHP checking are under development, specially id's unicity and
DTD checking

+ If you get a blank page on the right, this is because you hit a bug in
the browser transformation. Unfortunately debugging the browser
transformation is very hard, support is almost none. We will have to
address these issues.


Invitation for developers and testers

-------------------------------------

You are invited to test the editor and report bugs and suggest improvements.

The user interface is simple HTML and Javascript. If you have skills in
these technologies you are a potential developer for the editor, but we
know that PHP will be the right tech choice in near future.

The source code is in the dev-tool repository. To clone the dev-tool
repository :

git clone https://gerrit.libreoffice.org/dev-tools dev-tools

The editor is in dev-tools/help3/html/

If you have a web server working in your computer (Apache, Nginx, etc...) you can run the editor locally:

create a link between the web server root and the editor. For example, under Debian-like Linux:

sudo cd /var/www/html
sudo ln -s help-editor <path>/dev-tools/help3/html

and point your browser to 

http://localhost/help-editor

Seeking Help and discussion on the editor
-----------------------------------------

+ Please use this list, the developer list and our IRC channels to get in touch with the development of the editor.

Kind regards

(*) https://newdesign.libreoffice.org/help_editor/index.html

Olivier

Em 04/01/2019 08:39, Mike Saunders escreveu:
> Hello everyone,
>
> Olivier and I have been working on a new XHP editor, to simplify the
> editing of help documentation. The goals of this editor are:
>
> * Ease of use -- with syntax highlighting and autocompletion
> * Web-based -- so it can be used immediately
> * Integrated -- into the Gerrit/Git workflow
>
> We're still working on that final point, but for now, you can try the
> editor here:
>
> https://newdesign.libreoffice.org/new_help_editor/index.html
>
> To test the autocompletion, start with a blank document and type a "<"
> character. You'll see that "helpdocument" is suggested as a top-level
> tag. Hit enter to complete it, then add ">".
>
> Now go to another line and add "<" again, and you'll see child tags
> suggested: "meta" and "body". You can also close the "helpdocument" tag.
> For some tags that have parameters, the editor will show them as well.
>
> Underneath, you see various buttons: undo/redo, starting a new document
> (with the basic structure), and various tags/sections. Rendering on the
> right-hand pane doesn't work yet, but Olivier is looking at that.
>
> Anyway, play around with it, see what you think, and if you want the
> full code to test changes, Olivier can show you how to get it!
>
-- 
Olivier Hallot
LibreOffice Documentation Coordinator
Comunidade LibreOffice 
Rio de Janeiro - Brasil - Local Time: UTC-03:00
http://tdf.io/joinus 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/libreoffice/attachments/20190114/6c8352d7/attachment.html>