LibreOfficeLogo

Chapter Template Guide 24.2

Chapter 00
LO Chapter Template Instructions

Create LO chapters using this template

Copyright

This document is Copyright © 2024 by the LibreOffice Documentation Team. Contributors are listed below. This document maybe distributed and/or modified under the terms of either the GNU General Public License (https://www.gnu.org/licenses/gpl.html), version 3 or later, or the Creative Commons Attribution License (https://creativecommons.org/licenses/by/4.0/), version 4.0 or later. All trademarks within this guide belong to their legitimate owners.

Contributors

Contributors for this edition:

B. Antonio Fernández

Peter Schofield

Steve Fanning

Contributor 4

Contributors for previous editions:

Flywire

Jean Hollis Weber

Olivier Hallot

Contributor 4

Feedback

Please direct any comments or suggestions about this document to the Documentation Team Forum at https://community.documentfoundation.org/c/documentation/loguides/ (registration is required) or send an email to: loguides@community.documentfoundation.org.

Everything sent to a mailing list, including email addresses and any other personal information that is written in the message, is publicly archived and cannot be deleted.

Publication date and software version

Published February 2024. Based on LibreOffice 24.2 Community.
Other versions of LibreOffice may differ in appearance and functionality.

Using LibreOffice on macOS

Some keystrokes and menu items are different on macOS from those used in Windows and Linux. The table below gives some common substitutions used in this document. For a detailed list, see LibreOffice Help.

Windows or Linux

macOS equivalent

Effect

Tools > Options on Menu bar

LibreOffice > Preferences

Access setup options

Right-click

Control+click, Ctrl+click, or right click depending on computer setup

Open a context menu

Ctrl or Control

⌘ and/or Cmd or Command, depending on keyboard

Used with other keys

Alt

⌥ and/or Alt or Option depending on keyboard

Used with other keys

F11

⌘+T

Open the Styles deck in the Sidebar

Contents

 

Introduction

While the text in this document provides some useful pointers about styling chapters for LibreOffice documentation, it is first and foremost a STYLES template used to create LibreOffice user guide chapters. It is NOT an alternative or a substitute for the Contributors’ Guide.

This chapter provides information and instructions on how to create and format individual chapters as stand-alone documents for LibreOffice documentation. The individual chapters are also used to create a LibreOffice user guide. This chapter template is similar to the template used for LibreOffice user guides.

When creating and updating chapters, ALWAYS use the styles provided in this template. NEVER apply direct manual formatting to text, figures, and tables using the tools that are available on toolbars, the Menu bar, or keyboard shortcuts.

These template instructions also outline what is covered in a chapter. Also, there is additional information to assist a writer in using a standard writing style required so that a chapter has the same format and style as other chapters created by other documentation writers.

All styles used to create a LibreOffice document are located in the All Styles category in the Styles deck on the Sidebar.

Styles already in use in a LibreOffice document are located in the Applied Styles category in the Styles deck.

Any custom styles created are located in the Custom Styles category and the All Styles category. When a custom style is used, it also appears the Applied Styles category.

When copying text for a LibreOffice chapter, always paste the text into the document as unformatted text using the option Edit > Paste Special > Paste Unformatted Text on the Menu bar. This prevents overwriting any formatting used in paragraph and character styles.

Formatting marks

When creating a new chapter or updating a chapter, it is recommended to turn on Formatting Marks so that the paragraph marker is visible. This makes it easier to correctly position text, images and tables.

  1. Go to Tools > Options > LibreOffice Writer > Formatting Aids (macOS LibreOffice > Preferences > LibreOffice Writer > Formatting Aids) to open the Options LibreOffice Writer dialog.
  2. In Display Formatting, make sure the option Paragraph end is selected.
  3. Click on Apply to save the selection.
  4. Click on OK to close the Options LibreOffice Writer dialog.
  5. Go to View on the Menu bar and select Formatting Marks from the submenu, or use the keyboard shortcut Ctrl+F10 (macOS ⌘+F10).

Chapter file properties

Chapter information is entered or updated using the chapter file properties as follows:

  1. Check that the page style being used is First Page. This page style is an Only right page which creates the correct book format when the chapter is printed or added to a user guide.
  2. Go File > Properties on the Menu bar to open the Properties dialog for the user guide being created.
  3. Click on Description and in Title enter the name of the chapter, for example Chapter 1, Introducing Draw.
  4. Click on Custom Properties and in Value enter the following:

Guide Name: name of the user guide, for example Draw Guide.

LibreOffice Version: version number of LibreOffice, for example 24.2.

Month: the month of publication, for example February.

Year: the year of publication, for example 2024.

  1. Click on OK to save the details and close the Properties dialog.

Copyright information

The required copyright information for the chapter is entered onto the Copyright page. This page follows the first page of a chapter. Make sure that the following are correct:

Table of contents

The table of contents (ToC) for a chapter uses the Front Matter page style and the paragraph styles Contents 1, Contents 2, and Contents 3 to create the index from the Heading 1, Heading 2, and Heading 3 paragraph styles. The ToC heading uses the paragraph style Contents Heading, which is not included in the ToC.

After inserting and updating the text, figures and tables in the chapter, use the following steps to update the ToC.

  1. Right click in the ToC to open context menu.
  2. Select Update Index from the drop-down list and the ToC pages are updated using the Heading 1, Heading 2, and Heading 3 paragraph styles.
  3. Save the chapter file before closing.

Creating or updating chapters

Create a new chapter, or update an existing, using this template by including the text, tables, graphics and the ToC. The template text, tables, graphics and table of contents have to be replaced to include the required information for the new chapter, or from the chapter being updated.

The following procedure is recommended as starting point when creating, or updating a LibreOffice user guide chapter.

  1. Open this template file in LO Writer to create an untitled document in LO Writer. The template is a read-only file and cannot be edited.
  2. Save as a new file using the correct filename format, for example DG2401‑IntroducingDraw.odt.
  3. Go File > Properties on the Menu bar to open the Properties dialog.
  4. Click on Description and in Title enter the name of the chapter, for example Chapter 4, Changing Object Attributes.
  5. Click on Custom Properties and in Value for each field enter the following:

Guide Name: name of the user guide, for example Draw Guide.

LibreOffice Version: version number of LibreOffice, for example 24.2.

Month: the month of publication, for example January.

Year: the year of publication, for example 2024.

  1. Click on OK to save the details and close the Properties dialog.
  2. Check the Copyright page in the chapter has changed to show the correct information for the chapter.
  3. Change the chapter number and title to the one required for the chapter being created, for example Chapter 4, Changing Object Attributes.
  4. If required, create a subtitle to match the contents in the chapter being created.
  5. Start entering the required text, tables and graphics for the new chapter. Any text copied is pasted into the document using the option Edit > Paste Special > Paste Unformatted Text on the Menu bar (Ctrl+Shift+Alt+V (macOS ⌘+⌥+Shift+V)).
  6. Format the text, tables and graphics using the correct styles listed in the Styles deck on the Sidebar.

When pasting text into a new chapter file, the command Paste Unformatted Text has to be used to prevent any overwriting of styles formatting already in use in the new chapter file.

The styles required to create or update a chapter using this template are located in the All Styles category in the Styles deck. Any styles already in use in the document are located Applied Styles category in the Styles deck.

Page styles

The following page styles listed in Table 1 are used for creating a new chapter, or updating existing chapters.

Table 1: Page styles

Page Style

Style Description

Default Page Style

Used for all pages, except for the First Page and Front Matter pages.

First Page

Used for the chapter title page and is a right page only. Using a right page only creates the correct book format for printing and creating PDF files. The following page style is Front Matter.

Front Matter

Used for the copyright and table of contents pages when the chapter is being created as a stand alone document. The following page style is Default Style.

First page, front matter, and contents paragraph styles

The following paragraph styles listed in Table 2 are used in the first page, front matter and contents pages.

Table 2: Heading styles for first page, front matter and contents

Paragraph Style

Style Purpose

Contents Heading

Used automatically by LibreOffice to insert the word “Contents” on the Table of Contents page. This style prevents the Contents heading from appearing in the table of contents.

Guide Name

Used to display the name of the user guide on the first page of a chapter. The following paragraph style is Title.

Heading 1, Heading 2, Heading 3

Headings 1, 2, and 3 are included in the ToC. All heading styles inherit attributes from the Heading paragraph style. Heading 1 has an underline using the same color as used for the font.

New Chapter

Inserts a page break before the paragraph and changes the page style to First Page for the start of a new chapter. The graphic used for chapters is inserted at the New Chapter paragraph and the following paragraph style is Guide Name.

Subtitle

Used for the optional chapter subtitle. This paragraph style has a page break after the paragraph to force the Copyright section to start on a new page using the Front Matter page style. If the chapter does not require a subtitle, delete the text, but DO NOT delete the paragraph because Subtitle is used as a page break.

Title

Used for the chapter title in a user guide and is positioned below the guide name. The following paragraph style is Subtitle.

Paragraph styles

ALL paragraph styles, except heading styles, have the option Do not split paragraph selected. This prevents paragraphs from breaking across two pages and creates a document with good format. However, care must be taken when creating paragraphs to prevent them from being too long.

The following guidance should be used for paragraphs:

Table 3 lists in alphabetical order all the paragraph styles that are available for creating and formatting text in a chapter.

Table 3: Paragraph styles

Paragraph Style

Style Purpose

Body Text

The default style for any paragraph that is not formatted using a paragraph style.

Body Text, Indented

The same as Body Text, with a 1cm indentation. This paragraph style is normally used after the Definition Term paragraph style.

Body Text, Indented 2

The same as Body Text, with a 1.5cm indentation. This paragraph style is normally used after the Definition Term 2 paragraph style.

Body Text, List Intro

The same as Body Text with the option Keep with next paragraph selected. This option prevents the paragraph from being separated from the first item in a list when a list starts at the bottom of a page.

Body Text, Note

The same as Body Text with a 1cm indentation before and after the paragraph. Used as a description after the paragraph styles Heading Note, Heading Caution and Heading Tip.

Caption

Used as the basic formatting for caption paragraphs for tables, figures or code listings. The font is Liberation Sans Italic 11pt. Paragraph alignment is left.

Code

Used when an entire paragraph is computer code, for example, lines of computer code. When code examples are entered into a document, there maybe some line wrapping due to the constraints caused by margins. To reduce line wrapping, the style uses Liberation Mono as the font, font size 10pt, and character spacing -1pt.

Contents Heading

Used automatically by LibreOffice to insert the word “Contents” on the Table of Contents page. This style prevents the Contents Heading style from appearing in the table of contents.

Figure

Used for the anchor paragraph for a graphic or image and the caption paragraph for a figure. This paragraph style inherits the formatting from the Caption style. The paragraph alignment is changed to center alignment and positioned below the graphic or image inside the figure frame.

Guide Name

Used for the name of the user guide on the first page of a chapter.

Heading 1, Heading 2, Heading 3

Headings 1, 2, and 3 are included in the Table of Contents. All heading styles inherit attributes from the Heading paragraph style. Heading 1 has an underline using the same color as used for the font.

Heading Note

Used when a note is placed in the text giving necessary information to a LibreOffice user. Heading Note is automatically followed by the Body Text, Note paragraph style.

Heading Tip

Used when a tip is placed in the text giving helpful information to a LibreOffice user. Heading Tip is automatically followed by the Body Text, Note paragraph style.

Legend Numbered

Used when a figure requires extra information as text in column format. It is placed directly below the figure caption and figure frame. Number of columns used depends on how many legend items are required. Normally, only 2 or 3 columns would be used for a legend.

List

Creates a simple list of items that do not require any bullet points or numbering. Each item in the list consists of one line only and there is no paragraph spacing between list items.

List 1

Creates the 1st level of an unordered (bulleted) list using a bullet point and indented text.

List 1 Cont

Continuation of a List 1 item in an unordered list and does not require a bullet point.

List 2

Creates the 2nd level of an unordered list using a bullet point and indented text.

List 2 Cont

Continuation of a List 2 item in an unordered list and does not require a bullet point.

Listing

Used to format a caption paragraph for a code listing. The Listing style inherits from the Caption style. It is left aligned and positioned above a code listing.

New Chapter

Inserts a page break before the paragraph and changes the page style to First Page for the start of a new chapter.

Numbering 1

Creates the 1st level of an ordered (numbered) list using sequential numbering and indented text.

Numbering 1 Cont

Continuation of a Numbering 1 item in an ordered list and does not require any numbering.

Numbering 2

Creates the 2nd level of an ordered list using sequential alpha numbering and indented text.

Numbering 2 Cont

Continuation of a Numbering 2 item in an ordered list and does not require any numbering.

Numbering 3

Creates the 3rd level of an ordered list using sequential Latin numbering and indented text.

Numbering 3 Cont

Continuation of a Numbering 3 item in an ordered list and does not require any numbering.

Subtitle

Used for the optional chapter subtitle. The Subtitle paragraph style has a page break after the paragraph to force the Copyright section to start on a new page using the Front Matter page style. If the chapter does not require a subtitle, delete the text, but DO NOT delete the paragraph because Subtitle is used as a page break.

Table

Used to format a caption paragraph for a table. The Table style inherits from the Caption style. It is left aligned and positioned above a table.

Table Contents

Used for text in table cells. The text size has been reduced to 10pt so that more information can placed inside a table cell.

Table Heading

Used for the cells in the header row of a table. The text size has been reduced to 10pt so that more information can placed inside a table cell.

Title

Used for the chapter title in a user guide and is positioned below the guide name. The following paragraph style is Subtitle.

Character styles

For additional formatting within a paragraph, use one of the character styles described in Table 4. When formatting characters in a paragraph DO NOT use the formatting tools available on the toolbars, Properties deck on the Sidebar, or keyboard shortcuts.

Character styles inherit the font size of the paragraph style. Do not set the font size in the Font options of the Character style dialog.

Table 4: Character styles

Character Style Name

Style Purpose

Code

This character style uses the Liberation Mono font for examples of code words placed in a paragraph. The character spacing has been reduced by -0.5pt to reduce word length.

Emphasis

This italics character style is a default character style in LibreOffice and is used for the following:
Books and user guides referred to, for example Impress Guide.
Second level of options in LibreOffice dialogs, for example As character, Format.
Other terms that are commonly italicized in English usage.

Example

This character style uses the Liberation Mono font. It is a default character style in LibreOffice and used when the following are inserted into a paragraph:
Computer folder path
File name

Keystroke

This custom character style uses Liberation Mono italic font and is used for keyboard shortcuts, key presses, and key combinations, for example Shift+Tab.

Strong Emphasis

This bold character style is a default character style in LibreOffice. Use it for terms that are commonly printed in bold and for the following:
Menu paths, for example File > Save.
Context menu options, for example Font, Style.
First level of options in LibreOffice dialogs, for example Hyphenation, Options.
Dialog buttons, for example Add, OK.
Tool names, for example Gallery, Undo

Lists

When creating ordered and unordered lists, the list points are created using the following guidance:

Ordered (numbered) lists

Ordered lists are also known as numbered lists. The first item of each level of every ordered list in a document, the numbering has to be restarted. The numbering styles that available for use are as follows:

Numbering 1 — 1)

Numbering 2 — a)

Numbering 3 — i)

The numbering of the first numbered list item in each level of an ordered list has to be restarted each time an ordered list is created. This prevents the numbering of ordered lists for continuing as ordered lists are created in a document. Restarting the numbering can be carried out using the Paragraph dialog or the context menu.

Paragraph dialog restart

  1. Type or paste the required text for list items and select the required level of the numbering style (Numbering 1, Numbering 2, or Numbering 3).
  2. Select the first item in the ordered list and go to Format > Paragraph on the Menu bar to open the Paragraph dialog.
  3. Select Outline & List to open the Outline & List options page.
  4. In Apply List Style, select Restart numbering at this paragraph.
  5. In Apply List Style, select Start with and make sure 1 is displayed in the text box.
  6. Click OK to close the Paragraph dialog and the first list item is set to 1), a), or i).

Numbering restart must be carried out on all levels of numbering used in an ordered list.

Context menu restart

When creating another ordered list in the same chapter, numbering restart can also be carried out as follows using the context menu.

  1. Type or paste the required text for the list item and select the required level of the numbering style (Numbering 1, Numbering 2, or Numbering 3).
  2. Select this first item and go to Format > Lists on the Menu bar select Restart Numbering from the context menu that opens. The context menu automatically closes and the item is renumbered using 1), a), or i).

Example ordered list

An example of a numbered list with three levels of numbering is as follows. Please note, that the Numbering 3 style is only used when really necessary.

  1. The first item in an ordered list using Numbering 1 style. The numbering has to be restarted for the first item at this level.

Use Numbering 1 Cont style if further explanation is required in a Numbering 1 item.

  1. The second item in an ordered list using Numbering 1 style. If the item is a long item, it automatically wraps around to the next line.
  1. The first item in an ordered list using Numbering 2 style. The numbering has to be restarted for the first item at this level.

Use Numbering 2 Cont style if further explanation is required in a Numbering 2 item.

  1. The second item in an ordered list using Numbering 2 style. If the item is a long item, it automatically wraps around to the next line.
  1. The first item in an ordered list using Numbering 3 style. This numbering style is only used when really necessary. The numbering has to be restarted for the first item at this level.

Use Numbering 3 Cont style if further explanation is required in a Numbering 3 item.

  1. The second item in an ordered list using Numbering 3 style. If the item is a long item, it automatically wraps around to the next line.
  2. Another Numbering 3 item in an ordered list.
  1. Another Numbering 2 item in an ordered list.
  1. Another Numbering 1 item in an ordered list.

Unordered (bullet) lists

Unordered lists are also known as bullet lists and there are two levels of list items using the styles List 1 and List 2. An example of an unordered list used in LO chapters is as follows:

Use List 1 Cont style if further explanation is required in a List 1 item.

Use List 2 Cont style if further explanation is required in a List 2 item.

Simple lists

Simple lists use the List paragraph style and do not have bullet points or numbers. Use simple lists only when the list items are no longer than one line of text, as shown by the following example:

List paragraph style

Space below is only added when a different paragraph style is used.

List paragraph style

The spacing below the paragraph is only applied when the following paragraph uses a different paragraph style, for example Body Text.

Definition lists

Definition lists are used mainly for short explanations of terms that may not be familiar to a user, for example, fields or options in dialogs. There are two levels of definition terms because some dialogs have main options and sub-options available for selection. Each item in a definition list consists of two parts as follows:

An example of a definition list is as follows:

Definition Term

Text Body Indent paragraph style

Definition Term 2

Text Body Indent 2 paragraph style

Optimize

Evenly distributes the selected rows and columns in a table either horizontally or vertically. Selecting Optimize opens the Optimize toolbar and contains the following tools. Alternatively, right-click in selected cells and select the appropriate Optimize tool from the context menu.

Minimal Column Width

Defines the minimal column width for selected columns and depends on the shortest entry within a column.

Minimal Row Height

Determines the minimal row height for selected rows and depends on the font size of the smallest character in the row.

Merge Cells

Merges the selected cells into one cell. The contents of merged cells are also merged. Alternatively, right-click on selected cells and select Merge Cells from the context menu, or go to Format > Table > Merge Cells on the Menu bar.

Figures

Adding figures

To have consistent styling and anchoring for all types of graphics and images shown in LibreOffice documentation, the following steps are the recommended procedure when creating figures. Figure 1 is an example of a correctly inserted figure.

  1. Go to View > Formatting Marks on the Menu bar, or use the keyboard shortcut Ctrl+F10 (macOS ⌘+F10) to turn on formatting marks. This helps in locating the figure paragraph symbol on a page.
  2. Create a blank paragraph where the graphic or image is to be inserted and change the paragraph style to Figure centrally aligning the figure on the page.
  3. Make sure the cursor is on the figure paragraph symbol and paste the copied graphic or image onto the page. By default, the anchoring of the graphic or image to the figure paragraph is To Character.
  4. Right-click on the graphic or image and select Anchor > As Character from the context menu.

Example options dialog

Figure 1: Example figure of a LibreOffice dialog

  1. Right-click on the figure and select Insert Caption from the context menu to open the Insert Caption dialog.
  2. Enter the caption details in the Caption text box.

Figure captions have to be as short as possible and only consist of one line. For example, this caption is too long “Figure 22: Tab Position and Size of the Frame dialog box, showing vertical alignment to Top of the Base line.” The caption should be “Figure 22: Tab Position and Size of the Frame dialog box.”. The extended explanation is placed in a paragraph where the figure cross reference appears.

  1. In Properties, make sure the following options are set:

Category is set Figure.

Numbering is set to Arabic (1,2,3).

Position is set to Below.

  1. Click OK to close the Insert Caption dialog and the caption appears below the inserted figure using the paragraph style Figure.
  2. Right-click again on the graphic or image and select Anchor > As Character from the context menu. DO NOT select the figure frame that appears after inserting a caption.
  3. Position the cursor at the beginning of the caption, in front of the word Figure.
  4. Press the Enter key to create a paragraph for the caption that will be aligned centrally below the graphic or image.
  5. Click outside the figure frame to deselect it.
  6. Open Image properties dialog and click on the Options tab to open the Options page. In Accessibility, enter a Name, Text Alternative, and Description in the text boxes.

For accessibility, graphics and images must have a Name, Text Alternative, and Description defined. Refer to LibreOffice help for more information at https://help.libreoffice.org/7.6/en-GB/text/swriter/01/05060900.html.

Figure formatting

When a figure has been placed into a document, the figure normally consists of three parts:

Depending on the size of the image or graphic used as a figure, the figure may have to be repositioned or resized in the document to achieve a good formatting result leaving no large blank spaces on pages.

Positioning a figure

When positioning a figure on a page, it is normally placed on the same page as the cross reference in the text for that figure. This figure position can be either at the top or bottom of the page, depending on where the cross reference appears on the page.

To prevent blank spaces appearing in the pages, figures can be placed on the previous or following page to the cross reference. If the cross reference is in the upper half of the page, the figure is placed at the bottom of the previous page. If the cross reference is in the lower half of the page, the figure is placed at the top of the following page.

However, some figures are small in size, for example a small toolbar (Figure 2). These small figures can be placed immediately below the paragraph containing the cross reference. Occasionally, positioning small figures immediately below a paragraph may create a blank space. This can be resolved by positioning the small figure above the paragraph.

Example small toolbar

Figure 2: Example small toolbar

Resizing a figure

Sometimes it is necessary to resize a figure to achieve good page formatting. The graphic or image and figure frame are normally resized as one item. However, the graphic or image and the figure frame can also be resized independently of each other, so care must be taken to make sure the figure frame is selected when resizing. The graphic or image inside the frame automatically resizes when the frame is resized.

  1. Click on the figure frame to select it. The figure frame is visible when a caption has been added to the figure, as shown by Figure 2.
  2. Go to Format > Frame and Object > Properties on the Menu bar, or right-click on the frame and select Properties from the context menu to open the Frame dialog.
  3. Click on Type to open the Type page and access the options available for resizing.
  4. In Size, make sure that Keep ratio is selected. This option maintains the size ratio between the width and height of the frame.
  5. In Size, change the dimension in the text box to the required size for Width or Height.
  6. Click OK to change the frame size and close the Frame dialog. The graphic or image inside the figure frame automatically resizes with the frame.

Figure captions

The captions used for a figure should be meaningful and as short as possible consisting of one line. However, if a caption does extend to multiple lines, the following procedure creates a single line caption. Figure 3 shows an example of a multiple line caption. Figure 4 shows the same caption, but is now a single line.

  1. Select the graphic or image in the figure frame and use one of the following methods to open the Image dialog.
  1. Click on Type to open the Type options page.
  2. In Size, then Width, deselect the option Relative to. This prevents the graphic or image automatically resizing when the figure frame is resized.
  3. Click OK to close the Image dialog.
  4. Deselect the graphic or image.

Image4

Figure 3: Line transparency (0%, 25%, 50%, 75%)

Image6

Figure 4: Line transparency (0%, 25%, 50%, 75%)

  1. Click on the figure frame to select it. The figure frame is visible after a caption has been added.
  2. Click on the left or right selection handle for the frame and drag the frame to expand the frame width.
  3. Stop dragging when the caption becomes a single line and click away from the figure to deselect it. The figure caption should appear centrally located underneath the graphic or image, as shown in Figure 4.

Text in figures

When text (NOT a caption) is added to a graphic or image (Figure 5) and the whole figure is then converted to a graphic format (for example PNG), the text becomes part of the graphic or image. making the text very difficult to translate into another language using modern translation methods.

The solution is to create a numbered legend and place the legend immediately below the figure, as shown by the example in Figure 6. The paragraph style used for a legend is Legend Numbered. Remember to restart numbering when creating a new legend.

The legend shown in Figure 6 is in column format and the number of columns used does depend on how many legend items are required for a figure. Also, the legend text is editable and can been translated into another language using translation software.

Image5

Figure 5: Example of a text legend

Image7

Figure 6: Example of using a numbered legend

  1. Slide number
  2. Information area
  3. Master slide or page
  4. Cursor position
  5. Object size
  6. Unsaved changes
  7. Text language
  8. Fit slide to current window
  9. Zoom slide
  10. Zoom percentage

When multiple columns are required for the legend, the following steps are used to create the column format:

  1. Highlight all the items in the legend, then go to Format > Columns on the Menu bar to open the Columns dialog.
  2. In Settings, make sure the option Evenly distribute contents to all columns is selected.
  3. In Width and Spacing > Spacing enter a width of 12pt to create a space between the columns.
  4. Click OK to close the Columns dialog and the items in the legend are placed into a column format.

When there is more than one legend in a chapter or user guide, the numbering has to be restarted for the first item in each legend. See "Ordered (numbered) lists" on page 1 for information on restarting numbering.

Tables

Tables are used to explain data in a tabular format and an example table is shown in Table 5. This table uses a table style called LO User Guides and is used for all tables in LibreOffice user guide chapters.

Table 5: Sample table using Table paragraph style for this caption

Windows or Linux

macOS equivalent

Effect

Tools > Options
menu selection

LibreOffice > Preferences

Access setup options

Right-click

Control+click, Ctrl+click, or right-click depending on computer setup

Open a context menu

Ctrl or Control

⌘ and/or Cmd or Command, depending on keyboard

Used with other keys

Alt

⌥ and/or Alt or Option depending on keyboard

Used with other keys

F11

+T

Open the Styles deck in the Sidebar

Table style

The LO User Guides table style sets the alignment, table width, and table borders. The table style is applied as follows:

  1. Create a table using the one of the available methods for creating tables.
  2. Open the Styles deck in the Sidebar and click on Table Styles at the top of the deck.
  3. Position the cursor in the table and click, then select LO User Guides in the Styles deck to set the table format.
  4. Start entering the data required to complete the table.

For clarity when using tables, table rows should not break across pages and columns. If a table cell contains too much data that forces a row onto the next page leaving a large blank space, then rethink the data.

Setting header row and vertical text alignment

A header row is created as follows and automatically repeats on following pages when the table breaks across multiple pages.

  1. Go to Table > Properties on the Menu bar, or right-click on the table and select Table Properties to open the Table Properties dialog.
  2. Click on Text Flow to open the options page Text Flow.
  3. In Text Flow, select Allow table to split across pages and columns.
  4. In Text Flow, make sure that Allow rows to break across pages and columns is deselected.
  5. In Text Flow, select Repeat heading and set how many rows are to be used as header rows.
  6. In Alignment, select the option Centered from the drop-down list in Vertical alignment. All data in the table cells will be vertically centered in the table cells.
  7. Click OK to save the settings and close the Table Properties dialog.

Table caption

  1. Right-click on the table and select Insert Caption from the context menu to open the Insert Caption dialog.
  2. Enter the caption details in the Caption text box.
  3. In Properties, make sure the following options are set:

Category is set Table.

Numbering is set to Arabic (1,2,3).

Position is set to Above.

  1. Click OK to close the Insert Caption dialog and the caption appears above the inserted table.
  2. Click in the caption text and make sure the paragraph style is Table.

Table paragraph styles

Table Contents

This paragraph style uses a slightly smaller font size than the Text Body style. As can be seen in the sample table, character styles can also be used with the paragraph style Table Contents.

Table Heading

This paragraph style is used in the header row of a table and is the same font size as Table Contents, but uses Bold Italic for emphasis.

Table

This is the same as the caption used for figures, but is positioned above the table. The position is automatic when the cursor is placed inside the table and Insert > Caption on the Menu bar is used to create the caption. Table captions are automatically numbered using the category Table.

Notes, Tips, and Cautions

To create a Note, Tip, or Caution:

  1. Type the word Note, Tip, or Caution and apply the Heading Note, Heading Tip, or Heading Caution style.
  2. Press the Enter key and the next paragraph style is Body Text, Note.
  3. Type the text for the paragraph, then press Enter. The next paragraph also uses the Body Text, Note paragraph style.
  4. If the Note, Tip, or Caution does not require another paragraph, change the paragraph style to Body Text or another required style. Changing paragraph style also adds the line (border) below the Body Text, Note paragraph.

A note is used when something has to be drawn to the attention of the user and possibly prevent any user errors. A note begins with the paragraph style Heading Note. The text of a note uses the paragraph style Body Text, Note and automatically follows Heading Note.

A tip is a suggestion that could make it easier for a user to do something easier and better in LibreOffice. A tip begins with the paragraph style Heading Tip. The text of a tip uses the paragraph style Body Text, Note and automatically follows Heading Tip.

A caution is only used when there could be serious damage to the file or software if the user does not follow the correct procedure. Before using a caution in the user guides, make sure that it is really required.

A caution begins with the paragraph style Heading Caution. The text of a caution uses the paragraph style Body Text, Note and automatically follows Heading Caution.

Cross referencing

Always use the cross referencing tool in LibreOffice when there is a requirement to refer to a heading, figure, table, or listing within a document. The cross referencing tool keeps track of where the referenced item is positioned within the document. This is important, especially is a referenced item is moved, additional figures or tables are added to the document, or figures or tables are deleted.

  1. If the cross reference is to a figure or table, type the word Figure, Table or Listing followed by a non‑breaking space. Make sure the cursor is positioned after the non‑breaking space to insert the cross reference.
  2. If the cross reference is to a heading, type “” on page followed by a non‑breaking space. Place the cursor between the quotation marks.

Image3

Figure 7: Cross-references page in Fields dialog

  1. Go to Insert > Cross-reference on the Menu bar to the Fields dialog. This dialog opens automatically at the Cross-references page (Figure 7)
  2. Select the category of cross reference in Type.
  3. Select the required reference from the list in Selection.
  4. Select the type of cross-reference from the list in Refer using as follows:

Numbering for figures, tables, and listings.

Referenced text for headings.

Page number (unstyled) for page numbers, if required.

  1. Click on Insert to insert the cross reference.
  2. Click on Close to close the Fields dialog.

A cross reference to a page number is required if the item being referred to is not on the same page, the immediate page before, or the immediate page after, and for all cross references to headings.

DO NOT use the terms “above” or “below” for a cross reference. The position of a referenced item can easily change when chapters are amended or updated.

Inserting code

Listing 1 is an example of code with the Code paragraph style applied after insertion into a user guide chapter. The spacing below a code paragraph is not applied until there is a paragraph style change, for example Body Text.

When examples of code listing are inserted into a document, there maybe some line wrapping. Allow the line of code to wrap to the next line. DO NOT insert line breaks because line breaks prevent the code from operating correctly.

The Code paragraph style changes the font to Liberation Mono reducing the font size to 10pt and character spacing by -0.5pt. This change allows for longer lines of code to be inserted into a document reducing the amount of line wrapping.

Listing 1: Example of a code listing

sub EnterMyName

rem -------------------------------------------------------------

rem define variables

dim document   as object

dim dispatcher as object

rem -------------------------------------------------------------

rem get access to the document

document   = ThisComponent.CurrentController.Frame

dispatcher = createUnoService("com.sun.star.frame.DispatchHelper")

rem -------------------------------------------------------------

dim args1(0) as new com.sun.star.beans.PropertyValue

args1(0).Name = "Text"

args1(0).Value = "Your name"

dispatcher.executeDispatch(document, ".uno:InsertText", "", 0, args1())

end sub

Image1

Figure 8: Insert Table dialog

Image2

Figure 9: Table Properties dialog

Inserting a code listing

Use the following procedure to insert a blank table cell and a code listing into a user guide chapter:

  1. Place the cursor at a blank paragraph where the code listing is going to be inserted.
  2. Go to Table > Insert Table on the Menu bar to open the Insert Table dialog (Figure 8).
  3. Select 1 column and 1 row for the blank table and click on Insert to create the table.
  4. Position the cursor inside the table cell, then right click and select Table Properties from the context menu to open the Table Properties dialog (Figure 9).
  5. In Text Flow, select the options Allow table to split across pages and columns and Allow row to break across pages and columns, then click OK to close the Table Properties dialog.
  6. Select and copy all the lines of code required from the source document.
  7. Place the cursor in the blank table cell and paste the copied code using one of the following methods:
  1. Select all the lines of code and apply the Code paragraph style.

The paragraph spacing below a line of code is not applied until there is a paragraph style change, for example from Code to Body Text.

Code word highlighting

If required, the words in a code example can be highlighted to indicate the function of the code words. To format the characters, the Code Highlighter extension has to be used. This extension is not installed during the installation of LibreOffice application and has to be downloaded from the LibreOffice website.

Installing Code Highlighter extension

  1. Download the latest version of the Code Highlighter 2 extension from the LibreOffice website (https://extensions.libreoffice.org/en/extensions/show/5814) and save to the computer.
  2. Go to Tools > Extensions on the Menu bar to open the Extensions dialog.
  3. Click on Add and navigate to the location where the Code Highlighter extension has been saved.
  4. Click on Open and the extension is installed into LibreOffice in the Format menu on the Menu bar.
  5. Click OK to close the Extension Manager, then restart LibreOffice to activate the extension.

Highlighting code words

  1. Select the code lines that require formatting, then go to Format > Code Highlighter 2 on the Menu bar to open the Code Highlighter dialog (Figure 10).
  2. In Language, select the computer language (for example LibreOffice Basic) from the drop‑down list.
  3. In Style, select a style from the drop-down list (for example libreoffice-classic).
  4. Deselect the options Set background color and Add line numbering.

Image8

Figure 10: Code Highlighter dialog

Image9

Figure 11: Code Highlighter dialog — More page

  1. Select the option Use character styles in Writer.
  2. Click on More and set the Parent character style to Code, as shown in Figure 11.
  3. Click OK and the code character formatting is applied to the selected code.

The code character styles that have been applied will appear in the Custom Styles section in the Character Styles panel of the Styles deck on the Sidebar.