Skip to content

Commit

Permalink
Merge pull request #204 from hakonhagland/readme2
Browse files Browse the repository at this point in the history
Updated README.md with information about disabling document comparison option
  • Loading branch information
blattms authored Mar 13, 2024
2 parents 16e7e7a + 0e725c1 commit ab4570b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,21 @@ flow. Each keyword is described in its
own LibreOffice file and referenced as an external link in the subsection file.
An example of such a file is `parts/chapters/subsections/4.3/COLUMNS.fodt`.

## Editing the manual
## Editing the manual/Submitting PRs

Note that any document containing links to external documents should never be
edited directly. If such a document would be saved then LibreOffice would
remove all the links to the external documents and instead embed those documents
into the document that is edited. This would break the above described
structure.

Make sure to disable document comparison mode in LibreOffice. Since we already
use version control with Git, it would make editing the documents more difficult
if LibreOffice saved version information into the files also. The option can be
disabled in LibreOffice by choosing the menu item Tools → Options → LibreOffice Writer → Comparison and then uncheck the box "Store it when changing the document", see [screenshot](assets/option-doc-comparison-store-it-when-changing-the-document.png).

Please note that this setting might influence your whole LibreOffice experience as it is used whenever you open LibreOffice. If you do not want that then you will need to set it back after editing the manual.

## Exporting the manual as PDF

Open `main.fodt`. Select from the menu item `Tools``Update``Indexes and Tables`.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ab4570b

Please sign in to comment.