New Chapter Template for LO24

Documentation LibreOffice Guides
#61

Hello Antonio

I created that method of adding captions to Listings when Flywire suggested that a procedure for adding code examples into the template is created. I assumed your message hinted that there was a previous method had been created, but was unknown to Flywire or me.

Regards
PeeWee

#62

That method is described in more detail in the Title Adding listing caption on page 17 of the LO-UG-Chapter-Template-7-4.ott template on Nextcloud.
-In which you intervened as I see from the authors of the comments.

#63

There is a new version of the chapter template in the folder Contributor Resources > Chapter Template. The file name is New-UG-Chapter-Template-LO24-03PS.

Please review and let me know your comments.

I shall now update the user guide template to include the new information from the chapter template.

Regards
PeeWee

#64

I have uploaded my template proposal to Nexcloud, in it I detail the properties of all the styles used in the documentation and explain the changes and the reason for those changes.
It doesn’t explain how to use the styles as explained in previous versions of the template but it has all the styles adjusted according to the details included.

I have done several tests with satisfactory results, but I think other collaborators should try it and comment.

Due to the change of names in the styles, it is necessary to rename the following styles before applying the template to other documents (Template changer or load styles from template)

  • Text Note >> Body Text, Note
  • Text Indent 2 >> Body Text, Indented 2
  • Text Body List Intro >> Body Text, List Intro

Ordered and unordered list paragraph styles don’t look right due to the Libre Office bug. 159366 – List styles add paragraph direct formatting on loading Writer document

To see the final effect of the listings:

  1. Place the cursor in the paragraph before a list and insert a paragraph break.
  2. Change the style of that new paragraph (normally Body Text) to the style of the list that we want to see (Numbering X or List X).
  3. Write a few lines for the list.

This template is available whit the name LO_UG_Template_v2X.x-BAFC.ott
on LibreOffice Documentation > English > Contributor Resources > Chapter Template
https://nextcloud.documentfoundation.org/f/1507833

#65

Hello Antonio

I will check your template proposal and let you know the result.

I renamed these styles because they are all based on Body Text. It was better to group them altogether to make them easier to use, instead of havong to search for them.

The best way of using the new template is to copy and paste unformatted text using option Edit > Paste Special > Paste Unformatted Text on the Menu bar or the keyboard shortcut Ctrl+Shift+Alt+V (macOS ⌘+⌄+Shift+V)). Pasting unformatted text is recommended in the new template. However, you have to reapply any character styles that have been used in a paragraph. This is the method I always use when creating or updating user guide chapters.

If you copy text using the Edit > Copy on the Menu bar from a document using the old template then paste using Edit > Paste on the Menu bar into a new document, the old paragraph styles will also be copied into the new document. You can rename the old styles using the new names, but the old styles may have not have the same formatting details. This could create problems in a new document.

I have not used the template changer or loaded styles from a template. I will try this later today. If this method is easy to use, I will add it to the template.

I will check this bug about on list styles because I have noticed a small formatting problem with list items.

Regards
PeeWee

#66

Hello Antonio

My first comment on your proposed template.

There are three definitions for advising users of something important. Notes, Tips and Cautions. Notes and Tips are definitely required and definitely used. However, Cautions are only required if it is something that is very serious.

On the first page you have used a Caution heading and the word Attention. If you use a Caution, then you must use the word Caution in the heading.

In my opinion, your Attention is only a Note.

Hope this helps you for future reviews and comments.

Regards
PeeWee

#67

I know how to use warning headings. I used Caution to further emphasize that my English is very bad.

#68

Hello Antonio

Just trying to help you.

There have been messages about Cautions before indicating that there are too many. Majority of Cautions that have been used in the past should have only been Notes.

The definition of a Caution in international standards is to that carrying out a procedure wrongly may create injury to personnel or damage to equipment. This can be adapted to software where carrying out an action or procedure in software may damage the software and cause future problems. Some people may disagree with this statement, but I have worked where the correct level of notification in a user guide was mandatory.

Regards
PeeWee

#69

Hello Antonio

Where are the files for graphics/images you used for the Notes, Tips and Caution styles. I do not have a copy to update the list styles.

If you have a copy of the files, please send them to me.

Regards

Peter Schofield
psauthor@gmail.com
Technical Writer, LO Documentation Team

#70

Obviously this explanation refers to physical machines or equipment.
What we cover in the guides is the use of a program and it usually does not cause harm to personnel or equipment. I agree with you that it should not be used profusely.
But the use of a caution may be conditioned by the importance that the author of an article gives to a problem that arises.
– Obviously misuse can corrupt a file. Which is very important but does not cause damage to the equipment, nor to the secretary. >> Caution
It depends on the importance you give to an action.
A poorly used function can make you have to review the entire document - This may be a note for you because it does not corrupt the files, but for me it is a caution.

The use of clear and correct language seems essential to me, which is why I have used caution even though I know it is not the most appropriate.
The note is not intended to appear in a final version.

#71

Hello Antonio

My first comments on your proposed template are as follows:

Headings and border colour
The headings have a font and border colour 007C3C hex number.

Heading 1 First
This style is not required.
There is a Page Break After inserted as a blank paragraph at the end of the Table of Contents.
The Subtitle style has a Text Flow setting of Page Break After.

Default Paragraph Style
The font is Liberation Sans 11pt.
Spacing below 6pt.
Language set to English (USA).
Text flow setting “Allow to split paragraph” is not selected.

Regards
PeeWee

Peter Schofield
psauthor@gmail.com
Technical Writer, LO Documentation Team

#72

You should pay more attention to what is written in the introduction and description of styles and try to understand inheritance in the style hierarchy.

All the Headings inherit his properties from the parent style Heading, so the colour for all headings is 007c3c.

  • The two columns of all tables are the properties of the style ; Righ column are the properties inherits from the parent style and left colum are the specifics settings.

The Heading 1 First style is the necessary one, the one that is not necessary is the PAGE BREAK style.
The Subtitle style adds the necessary page break. (Next page = Front Matter – page secuence )
The Contents Heading style adds the necessary break (Next page = Front Matter – text flow)
The Heading 1 First style adds the necessary break (Next page = Default Page Style – text flow )

The PAGE BREAK style adds only one page break of the same style as the previous page, so that after a page with Front Matter page style there is always a page with the same style.

This is due to the change in property setting between versions.

In version 7.5.9.2 the setting is described as Do not split paragraph. The default setting is disabled, and as such does not appear in the organizer page
In version 24.2 The setting is described as Allow to split paragraph. The default setting is enabled and also does not appear on the organizer page.

This setting is indicated on page 13 of the template, in the heading Paragraph styles

  • A more specific view of the template is achieved by testing it in a new document or by applying it to another document.
#73

They are in the TDF Wiki (also in the help files)
https://wiki.documentfoundation.org/File:Note_pin.svg
https://wiki.documentfoundation.org/File:Tip.svg
https://wiki.documentfoundation.org/File:Warning.svg

#74

I had not seen the message in which you tell me “The best Way”

If you paste as unformatted text, you lose all format, Styles format and Character Format and you have to reapply the styles to each paragraph and each word that requires character formatting.

Do not get confused,
Using copy as plain text is used to paste text copied from sources other than guide chapters to prevent adding foreign styling and direct formatting to guide chapters.

and for the rest of the content of the message, I don’t know if you are playing a joke on me or you don’t know how to Writer Works

#75

Hello Antonio

Sorry, but I disagree.

Copy and paste unformatted text prevents any formatting errors from being placed into a chapter that is being created or updated using the new template.

The other alternative is to check the formatting in the LO chapter that is being updated before using the text in the new template.

It is quicker and more accurate to use copy and past unfor5matted text.

Regards

PeeWee

Peter Schofield
psauthor@gmail.com
Technical Writer, LO Documentation Team

#76

What about 2 spaces?
In unnumbered lists, separating with a space looks fine
In numbered lists, the separation between the number and the text is very short
Would this affect HTML formatting?

#77

@PeeWee

Esa es una forma de trabajar como otra cualquiera pero no aprovecha las capacidades de Writer.
–No voy a decirte como tienes que trabajar, pero pienso que te vendría bien una relectura atenta de la guía de writer.
Por otra parte no voy a entrar en mås discusiones porque me consume mucho tiempo la traducción al inglés y ya estoy un poco cansado del tema.

Que decida quien tenga que decidir.

#78

A new version of the chapter template is now available in Contributor Resources > Chapter Template on NextCloud. The filename is New-LO24-UG-Chapter-Template-03PS.

I have taken into account comments from Antonio and Steve Fanning.

The spacing and indents for numbering and bullet lists has been sorted out. There was a mismatch on the version of the template I was working on.

Caption is now the mother file for Figure, Tables and Listing captions.

Some text has changed slightly and errors have been corrected.

Regards
PeeWee

#79

Hi @PeeWee
I think we are getting there. Thanks for your dedication.

2 notes:

  • Please let’s replace the list tab characters with spaces, 1 or 2 spaces
 This is critical if we export the chapter to EPUB or HTML.

  • The Properties of the template file (File - Properties) still mention “7.4”.

And look how nasty is list formatting checks on review
 The image below shows first bullet item with a slight offset, due to direct bullet list applied to List 1 style

image

Cheers
Olivier

#80

Hello Olivier

The List 1 & 2 and List 1 & 2 Cont. styles have been corrected.
The indents & spacing settings for the list bullet styles are now the same as the list styles.
No need to use spaces if the list bullet styles match the list styles.

Regards
PeeWee

Peter Schofield
psauthor@gmail.com
Technical Writer, LO Documentation Team

Impressum (Legal Info) | DatenschutzerklĂ€rung (Privacy Policy)   Content on this site is licensed under a Creative Commons Attribution Share Alike 3.0 license.