Re: [libreoffice-documentation] Working with the Markup of an ODF File

[Olivier Hallot]

Hi Regina

Em 03/01/2021 12:05, Regina Henschel escreveu:
> 
> I'm going to write a Wiki article "Working with the Markup of an ODF
> File". Do you have a suggestion, where to put it?

Documentation/ODFMarkup

Later we add an entry in the Documentation entry page of the wiki (and
Development too), do proper categorization for quick search and enable
translation.

Kind regards
-- 
Olivier Hallot
LibreOffice Documentation Coordinator
Rio de Janeiro - Brasil - Local Time: UTC-03:00
LibreOffice – free and open source office suite: https://www.libreoffice.org
Respects your privacy, and gives you back control over your data
http://tdf.io/joinus

-- 
To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org
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

[libreoffice-documentation] Working with the Markup of an ODF File

[Regina Henschel]

Hi all,

I'm going to write a Wiki article "Working with the Markup of an ODF 
File". Do you have a suggestion, where to put it?


The introduction is:
There exist very different reasons why someone wants to use the markup 
of an ODF file, for example:

You want to learn, how the markup looks like.
You want to be sure the file doesn’t contain any hidden confidential 
information.
You want to compare the markup of other producers with the markup 
generated by LibreOffice.

You want to investigate, whether a bug comes from a file format error.
You want to manually repair an error in the markup.
You want to manually do things, for which LibreOffice has no good UI.
You want to directly generate ODF files without using LibreOffice.
You want to apply an XSLT to the document without using LibreOffice.
The following article is a collection of tips, tricks and hints to help 
you in such tasks.


Currently sections are:
Working with ‘Flat XML ODF’-File
Working with zip-Format
Pretty Printing
Special editors
Avoid Noisy Markup in Writer
Valid ODF Files
Other Tools for ODF Files

Kind regards
Regina

--
To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org
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

Re: [libreoffice-documentation] Producing guides - add a "Cleaned" directory

[Olivier Hallot]

HI Milos

Em 03/01/2021 11:18, Milos Sramek escreveu:
> Hi Steve,
> 
> yes, please, use that file.
> 
> I would like to ask you (and anybody else) to help in testing of the
> LoGuidesStyles.oxt extension and document cleaning.
> 
> The extension is available from
> https://github.com/milossramek/translation-scripts/tree/master/odtclean
> and it highlights character styles. I created it to be used in manual
> style checking, but if used during editing it enables full control over
> direct formatting/styles and thus makes additional checking not
> necessary. But, maybe, all these colors are disturbing in editing – I
> would like to know your opinion on that.

Recently I manually cleaned some translated files (before latest
odtclean.py) by changing the color font (instead of the font
background). My personal taste. Of course the font color must absolutely
contrast with normal font color, so for example, I used
Strong Enphasis -> Purple
Emphasis -> Orange
Keystroke -> Light blue
...
Code style has enough visual contrast to be touched

> 
> I have written here several times about using the script odtclean.py. It
> is, however possible, that it is not necessary to use it at all, since
> the Format/Clear Direct Formatting works good enough. I wrote the script
> 5 years ago because the Clear Direct Formatting command corrupted the
> LOGuides documents (mostly lists). I've tested Clear Direct Formatting
> on several documents now and it works without problems (I've noticed
> just insignificant changes in paragraph spacing in some documents). It
> cleans the document nearly as good as the script (does not clean image
> captions and does not merge neighboring styles of the same type, but
> these are not a problem).
> 
> Please, test it, too. One cannot run the command on the whole document
> (CTRL-A) – it is necessary to use it in two steps: first on the text
> before the table of contents and then on the rest after the table of
> contents.
> 
> If these two steps work well, the extra cleaning step in the workflow
> will not be necessary


On a side note, LibreOffice (ODF) can store the user interface tweaks
(menus, toolbars, shortcuts, other) in the document. That means we can
create a special user interface for Guide editing and formatting and
have it available when opening the chapter file. This UI can hide direct
formatting toolbar and replace by a custom toolbar where all templates
styles are available as buttons, just for a start...

Just my EUR 0,02

Olivier


> 
> thanks
> Milos
> 
> 
> On 1/2/21 8:58 PM, Steve Fanning wrote:
>> All,
>>
>> As discussed at a recent Document Team meeting, I am working on an
>> update to Chapter 13 of the 7.0 Calc Guide (Calc as a Database).
>>
>> I have assumed that the best ODT file to start with is the cleaned
>> version in the folder that Milos identified below
>> (https://nextcloud.documentfoundation.org/apps/files/?dir=/Shared/SK%20community/Cleaned=322834).
>>
>> Please advise if this assumption is incorrect!
>>
>> Regards,
>>
>> Steve
>>
>>
>> On 28/12/2020 16:34, Milos Sramek wrote:
>>> Hi Olivier and all,
>>> now that CG70 and MG70 are published I have cleaned the documents
>>> manually and by the script. You can find the archives in
>>> https://nextcloud.documentfoundation.org/apps/files/?dir=/Shared/SK%20community/Cleaned=322834
>>>
>>>
>>> I suggest to replace the chapter files in the Published directory by
>>> their cleaned versions without producing the full odt and pdf book.
>>> Thus, the next version will start from the cleaned document.
>>> If you agree, I will replace them.
>>>
>>> I've created a simple extension, which highlights the character styles
>>> used in the guides:
>>> https://github.com/milossramek/translation-scripts/tree/master/odtclean
>>> https://github.com/milossramek/translation-scripts/blob/master/odtclean/LOGuidesStyles.oxt
>>>
>>>
>>> If highlighted, an author can see if styles are really used instead of
>>> direct formatting - in that case additional manual cleaning would not be
>>> necessary and it would be sufficient only to run the script. I suggest
>>> then to produce the cleaned files after publishing the guide.
>>>
>>> To summarize, I suggest to include two additional steps to the Producing
>>> LO Guides document
>>> - for authors: use the extension and use the character styles
>>> consistently
>>> - for a specific person (me for now): to run the script after publishing
>>> the guide and to replace the chapter files in the published directory
>>>
>>> Milos
>>>
>>> On 12/17/20 8:55 PM, Olivier Hallot wrote:
 Hi Milos, All

 Em 17/12/2020 16:41, Milos Sramek escreveu:
> Hi,
>
> I suggest to include file cleaning in the workflow. In cleaning one
> removes direct formatting, which is necessary for translation.
> Currently
> I do that after a guide is published - the cleaned files can be found
> here:
>
> 

Re: [libreoffice-documentation] Producing guides - add a "Cleaned" directory

[Dan Lewis]

Two questions:

1) What are the OS that this will work with?

2) Where are the directions on how to use it?

Dan

On 1/3/21 9:18 AM, Milos Sramek wrote:

Hi Steve,

yes, please, use that file.

I would like to ask you (and anybody else) to help in testing of the
LoGuidesStyles.oxt extension and document cleaning.

The extension is available from
https://github.com/milossramek/translation-scripts/tree/master/odtclean
and it highlights character styles. I created it to be used in manual
style checking, but if used during editing it enables full control over
direct formatting/styles and thus makes additional checking not
necessary. But, maybe, all these colors are disturbing in editing – I
would like to know your opinion on that.

I have written here several times about using the script odtclean.py. It
is, however possible, that it is not necessary to use it at all, since
the Format/Clear Direct Formatting works good enough. I wrote the script
5 years ago because the Clear Direct Formatting command corrupted the
LOGuides documents (mostly lists). I've tested Clear Direct Formatting
on several documents now and it works without problems (I've noticed
just insignificant changes in paragraph spacing in some documents). It
cleans the document nearly as good as the script (does not clean image
captions and does not merge neighboring styles of the same type, but
these are not a problem).

Please, test it, too. One cannot run the command on the whole document
(CTRL-A) – it is necessary to use it in two steps: first on the text
before the table of contents and then on the rest after the table of
contents.

If these two steps work well, the extra cleaning step in the workflow
will not be necessary

thanks
Milos


On 1/2/21 8:58 PM, Steve Fanning wrote:

All,

As discussed at a recent Document Team meeting, I am working on an
update to Chapter 13 of the 7.0 Calc Guide (Calc as a Database).

I have assumed that the best ODT file to start with is the cleaned
version in the folder that Milos identified below
(https://nextcloud.documentfoundation.org/apps/files/?dir=/Shared/SK%20community/Cleaned=322834).

Please advise if this assumption is incorrect!

Regards,

Steve


On 28/12/2020 16:34, Milos Sramek wrote:

Hi Olivier and all,
now that CG70 and MG70 are published I have cleaned the documents
manually and by the script. You can find the archives in
https://nextcloud.documentfoundation.org/apps/files/?dir=/Shared/SK%20community/Cleaned=322834


I suggest to replace the chapter files in the Published directory by
their cleaned versions without producing the full odt and pdf book.
Thus, the next version will start from the cleaned document.
If you agree, I will replace them.

I've created a simple extension, which highlights the character styles
used in the guides:
https://github.com/milossramek/translation-scripts/tree/master/odtclean
https://github.com/milossramek/translation-scripts/blob/master/odtclean/LOGuidesStyles.oxt


If highlighted, an author can see if styles are really used instead of
direct formatting - in that case additional manual cleaning would not be
necessary and it would be sufficient only to run the script. I suggest
then to produce the cleaned files after publishing the guide.

To summarize, I suggest to include two additional steps to the Producing
LO Guides document
- for authors: use the extension and use the character styles
consistently
- for a specific person (me for now): to run the script after publishing
the guide and to replace the chapter files in the published directory

Milos

On 12/17/20 8:55 PM, Olivier Hallot wrote:

Hi Milos, All

Em 17/12/2020 16:41, Milos Sramek escreveu:

Hi,

I suggest to include file cleaning in the workflow. In cleaning one
removes direct formatting, which is necessary for translation.
Currently
I do that after a guide is published - the cleaned files can be found
here:

https://nextcloud.documentfoundation.org/index.php/apps/files?dir=/Shared/SK%20community/Cleaned


The current problem is that nobody knows about them and a new
version of
a guide starts from an uncleaned version in the Published and thus I
have to repeat the laborious manual cleaning part again an again.

BTW, last time I tried odtclean.py in my Linux box it failed, something
related to python version. Actually, is it still of use?


My suggestion is to add another step after step 7 in the "How to
publish
a chapter" section (page 15, 2 - Producing LO Guides.odt): a "Cleaned"
directory, the contents of which will then be used to start a next
version of the guide. I will then produce the cleaned files.


I think the cleaned files should be the published files. In other
words,
only publish cleaned files.

Olivier



--
To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org
Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette
List archive: 

Re: [libreoffice-documentation] Producing guides - add a "Cleaned" directory

[Milos Sramek]

Hi Steve,

yes, please, use that file.

I would like to ask you (and anybody else) to help in testing of the
LoGuidesStyles.oxt extension and document cleaning.

The extension is available from
https://github.com/milossramek/translation-scripts/tree/master/odtclean
and it highlights character styles. I created it to be used in manual
style checking, but if used during editing it enables full control over
direct formatting/styles and thus makes additional checking not
necessary. But, maybe, all these colors are disturbing in editing – I
would like to know your opinion on that.

I have written here several times about using the script odtclean.py. It
is, however possible, that it is not necessary to use it at all, since
the Format/Clear Direct Formatting works good enough. I wrote the script
5 years ago because the Clear Direct Formatting command corrupted the
LOGuides documents (mostly lists). I've tested Clear Direct Formatting
on several documents now and it works without problems (I've noticed
just insignificant changes in paragraph spacing in some documents). It
cleans the document nearly as good as the script (does not clean image
captions and does not merge neighboring styles of the same type, but
these are not a problem).

Please, test it, too. One cannot run the command on the whole document
(CTRL-A) – it is necessary to use it in two steps: first on the text
before the table of contents and then on the rest after the table of
contents.

If these two steps work well, the extra cleaning step in the workflow
will not be necessary

thanks
Milos


On 1/2/21 8:58 PM, Steve Fanning wrote:
> All,
>
> As discussed at a recent Document Team meeting, I am working on an
> update to Chapter 13 of the 7.0 Calc Guide (Calc as a Database).
>
> I have assumed that the best ODT file to start with is the cleaned
> version in the folder that Milos identified below
> (https://nextcloud.documentfoundation.org/apps/files/?dir=/Shared/SK%20community/Cleaned=322834).
>
> Please advise if this assumption is incorrect!
>
> Regards,
>
> Steve
>
>
> On 28/12/2020 16:34, Milos Sramek wrote:
>> Hi Olivier and all,
>> now that CG70 and MG70 are published I have cleaned the documents
>> manually and by the script. You can find the archives in
>> https://nextcloud.documentfoundation.org/apps/files/?dir=/Shared/SK%20community/Cleaned=322834
>>
>>
>> I suggest to replace the chapter files in the Published directory by
>> their cleaned versions without producing the full odt and pdf book.
>> Thus, the next version will start from the cleaned document.
>> If you agree, I will replace them.
>>
>> I've created a simple extension, which highlights the character styles
>> used in the guides:
>> https://github.com/milossramek/translation-scripts/tree/master/odtclean
>> https://github.com/milossramek/translation-scripts/blob/master/odtclean/LOGuidesStyles.oxt
>>
>>
>> If highlighted, an author can see if styles are really used instead of
>> direct formatting - in that case additional manual cleaning would not be
>> necessary and it would be sufficient only to run the script. I suggest
>> then to produce the cleaned files after publishing the guide.
>>
>> To summarize, I suggest to include two additional steps to the Producing
>> LO Guides document
>> - for authors: use the extension and use the character styles
>> consistently
>> - for a specific person (me for now): to run the script after publishing
>> the guide and to replace the chapter files in the published directory
>>
>> Milos
>>
>> On 12/17/20 8:55 PM, Olivier Hallot wrote:
>>> Hi Milos, All
>>>
>>> Em 17/12/2020 16:41, Milos Sramek escreveu:
 Hi,

 I suggest to include file cleaning in the workflow. In cleaning one
 removes direct formatting, which is necessary for translation.
 Currently
 I do that after a guide is published - the cleaned files can be found
 here:

 https://nextcloud.documentfoundation.org/index.php/apps/files?dir=/Shared/SK%20community/Cleaned


 The current problem is that nobody knows about them and a new
 version of
 a guide starts from an uncleaned version in the Published and thus I
 have to repeat the laborious manual cleaning part again an again.
>>> BTW, last time I tried odtclean.py in my Linux box it failed, something
>>> related to python version. Actually, is it still of use?
>>>
 My suggestion is to add another step after step 7 in the "How to
 publish
 a chapter" section (page 15, 2 - Producing LO Guides.odt): a "Cleaned"
 directory, the contents of which will then be used to start a next
 version of the guide. I will then produce the cleaned files.

>>> I think the cleaned files should be the published files. In other
>>> words,
>>> only publish cleaned files.
>>>
>>> Olivier
>>>
>

-- 
email & jabber: sramek.mi...@gmail.com


-- 
To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org
Problems? 

[libreoffice-documentation] Re: Docs wiki

[LibreOfficiant]

Hi Peter

The wiki Macros page is inspired from the  french wiki Macros page
  . Please note it is
incomplete. Observe other language pages are less dense.

Everybody can improve wiki pages content and organosation. All improvements
to their structure are welcome.  



-
cf. Designing and Developing Python Applications  - 
https://wiki.documentfoundation.org/Macros/Python_Design_Guide

--
Sent from: 
http://document-foundation-mail-archive.969070.n3.nabble.com/Documentation-f1645240.html

-- 
To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org
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