New XHP editor online for testing and feedback

classic Classic list List threaded Threaded
3 messages Options
Mike Saunders Mike Saunders
Reply | Threaded
Open this post in threaded view
|

New XHP editor online for testing and feedback

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!

--
Mike Saunders, Marketing & PR
The Document Foundation

--
To unsubscribe e-mail to: [hidden email]
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
sophie sophie
Reply | Threaded
Open this post in threaded view
|

Re: New XHP editor online for testing and feedback

Hi Mike, Olivier,
Le 04/01/2019 à 11:39, Mike Saunders a écrit :

> 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 ">".

Autocompletion is working correctly for me. I'm not sure the <br> tag is
needed because often it's placed at the wrong place for translators. We
get a better structure for translation segmentation if it's a new
paragraph.
>
> 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.

the <ahelp> button is not working, otherwise all the others are working
correctly. When the Save changes button will be implemented, will I get
a file to commit?
I didn't check thoroughly the structure, do you want me to check it or
did you already did it?
>
> 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!
>
Thanks a lot for your work, it seems a lot easier to write help files
with this great tool :)
Cheers
Sophie

--
Sophie Gautier [hidden email]
GSM: +33683901545
IRC: sophi
Release coordinator
The Document Foundation

--
To unsubscribe e-mail to: [hidden email]
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
Olivier Hallot-4 Olivier Hallot-4
Reply | Threaded
Open this post in threaded view
|

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

In reply to this post by Mike Saunders
Hello Martin

Em 14/01/2019 14:53, Martin Srebotnjak escreveu:
> Hello Olivier et. al.,
>
> will the editor in any way change underlying string/text
> non-changed-with-editing code (i.e. if a small edit of one word is
> performed, does the whole chunk of help page save/change (regarding also
> xml checks and corrections and beautification?).

Apparently not. Changes are only by lines.

But XML beautification will affect many lines and can generate patches
with many lines changes, although it will not affect translation (which
is controlled by the attribute localize=.


>
> Did you try any tests, how many fuzzy strings does a small edit of one word
> on an average hep page in English cause in git/po files? I am just worried
> that this might cause a lot of fuzzy (not fully translated) strings in l10n
> projects and a lot of collateral damage for l10n teams. But I might just be
> too much worried.

This is independent of the editor. We have not enabled "beautifiers" or
any other plugins that parses the XHP lines. Untouched lines stay untouched.

Any translatable tag (paragraphs mostly, including headings (*)) that is
changed triggers a retranslation (fuzzy), including white space
movements here and there in the paragraph. The list of tags that are
translatable by default is listed in this wiki page:

https://wiki.documentfoundation.org/Documentation/Rules_for_writing_Help_pages_contents#Tips_for_XML_Tags

Better then, change white space position only if the paragraph has a
relevant contents change.

And you are invited to test and evaluate the editor for Help pages. I
just patched a page using the rendering for testing and validating,
without having to build the whole help.

Kind regards

Olivier


>
> Thanks, m.
>
> V V pon., 14. jan. 2019 ob 12:43 je oseba Olivier Hallot <
> [hidden email]> napisala:
>
>> 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
>>
>>
>> --
>> To unsubscribe e-mail to: [hidden email]
>> 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/l10n/
>> Privacy Policy: https://www.documentfoundation.org/privacy
>>
--
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: [hidden email]
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