Skip to content

Commit

Permalink
Minor layout edits
Browse files Browse the repository at this point in the history
  • Loading branch information
flywire committed Nov 2, 2021
1 parent 0abc86b commit ef38ac0
Show file tree
Hide file tree
Showing 29 changed files with 187 additions and 209 deletions.
4 changes: 3 additions & 1 deletion docs/01-Concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,9 @@ your search. For instance, if you're looking for the Text service, type:

Module names are also quite common words, so add "module" to the search. If you
want to reach the "text" module (which implements most of Writer), search for:
lodoc text module

`lodoc text module`

You can call lodoc with Office application names, which are mapped to API module
names. For instance:

Expand Down
9 changes: 4 additions & 5 deletions docs/02-Starting_and_Stopping.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,8 +293,8 @@ XComponent doc =

The frame type is almost always "_blank" which indicates that a new window will be
created for the newly loaded document. (Other possibilities are listed in the
XComponentLoader documentation which you can access with `lodoc
XComponentLoader`.) The search flags are usually set to 0, and document properties
XComponentLoader documentation which you can access with `lodoc XComponentLoader`.)
The search flags are usually set to 0, and document properties
are stored in the PropertyValue array, props.

loadComponentFromURL()'s return type is XComponent, which refers to the
Expand All @@ -308,7 +308,7 @@ array; there are several variants which accept different numbers of property nam
value pairs.

A complete list of document properties can be found in the MediaDescriptor
documentation (accessed with lodoc MediaDescriptor service), but some of the
documentation (accessed with `lodoc MediaDescriptor service`), but some of the
important ones are listed in Table 1.


Expand Down Expand Up @@ -407,8 +407,7 @@ in the Office documentation).
XStorable.storeToURL() takes the name of the output file (in URL format), and an
array of properties, one of which should be "FilterName". Two other useful output
properties are "Overwrite" and "Password". Input and output document properties are
listed in the MediaDescriptor service documentation (lodoc MediaDescriptor
service).
listed in the MediaDescriptor service documentation (`lodoc MediaDescriptor service`).

If "Overwrite" is set to true then the file will be saved without prompting the user if
the file already exists. The "Password" property contains a string which must be
Expand Down
15 changes: 7 additions & 8 deletions docs/03-Examining.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ finding this information, using configuration properties and path settings.

Configuration management is a complex area, which is explained reasonably well in
chapter 15 of the developer's guide and online at
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Config/Configuration_Ma
nagement; I'll only explain the basics here. The easiest way of accessing the relevant
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Config/Configuration_Management;
I'll only explain the basics here. The easiest way of accessing the relevant
online section is by typing:
`loguide "Configuration Management"`

Expand Down Expand Up @@ -96,8 +96,8 @@ whereabouts of the gallery and spellchecker files. A partial list of predefined
accessible from within LibreOffice, via the Tools menu: Tools, Options,
LibreOffice, Paths. But the best source of information is the developer's guide, in the
"Path Organization" section of chapter 6, or at
https://wiki.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Path_Organizat
ion, which can be accessed using:
https://wiki.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Path_Organization,
which can be accessed using:
`loguide "Path Organization"`

One issue is that path settings comes in two forms: a string holding a single directory
Expand Down Expand Up @@ -353,8 +353,8 @@ XTextDocument 's inheritance hierarchy shown in Figure 5.
Figure 5. Inheritance Hierarchy for XTextDocument.


A similar diagram appears on the XTextDocument documentation webpage (`lodoc
XTextDocument`), but is complicated by also including the inheritance hierarchy for
A similar diagram appears on the XTextDocument documentation webpage (`lodoc XTextDocument`),
but is complicated by also including the inheritance hierarchy for
the TextDocument service. Note, the interface hierarchy is also textually represented
in the "Public Member Functions" section of the documentation.

Expand Down Expand Up @@ -513,8 +513,7 @@ documentation. MRI has its own wiki, at https://github.com/hanya/MRI/wiki, and
there are several forum posts about using it for code generation (e.g.
https://forum.openoffice.org/en/forum/viewtopic.php?f=74&t=49294) and for
navigating MRI's object hierarchy
(https://forum.openoffice.org/en/forum/download/file.php?id=17368&sid=373c5d782
40f4093fb3721fe4264dd20).
(https://forum.openoffice.org/en/forum/download/file.php?id=17368&sid=373c5d78240f4093fb3721fe4264dd20).


#### Some Quirks of Using MRI
Expand Down
6 changes: 3 additions & 3 deletions docs/04-Listening.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ I haven't previously mentioned Office's listener interfaces (there are about 140
them), because they work in the same way as listeners in Java.

Probably the easiest way of obtaining a list of them all is to visit the LibreOffice
documentation for XEventListener (use lodoc XEventListener). The tree diagram
documentation for XEventListener (use `lodoc XEventListener`). The tree diagram
at the top of the page shows that every listener interface is a subclass of
XEventListener, and you can click on a subclass box to jump to its documentation.

Expand Down Expand Up @@ -465,8 +465,8 @@ isn't the one for Impress? Do these combination of keys do something deadly in o
of Office's other applications?

One nice feature is that there's lots of documentation on keyboard shortcuts for Office
in its User guides (downloadable from https://th.libreoffice.org/get-
help/documentation/), and these can be easily translated into key presses and releases
in its User guides (downloadable from https://th.libreoffice.org/get-help/documentation/),
and these can be easily translated into key presses and releases
in Robot.


Expand Down
17 changes: 7 additions & 10 deletions docs/05-Text_API_Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,8 @@ are available at http://api.libreoffice.org/examples/examples.html#Java_examples

This chapter (and later ones) assume that you're familiar with Writer, including text
concepts such as paragraph styles. If you're not, then I recommend the "Writer
Guide", a user manual, available at http://www.libreoffice.org/get-
help/documentation/ or
https://wiki.documentfoundation.org/Documentation/Publications.
Guide", a user manual, available at http://www.libreoffice.org/get-help/documentation/
or https://wiki.documentfoundation.org/Documentation/Publications.


## 1. An Overview of the Text Document API
Expand All @@ -62,8 +61,8 @@ Figure 1. The Text Document Services.


I'll be concentrating on the TextDocument service, which is documented at
http://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1text_1_1TextD
ocument.html. Or you can type `lodoc TextDocument service`, which unfortunately
http://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1text_1_1TextDocument.html.
Or you can type `lodoc TextDocument service`, which unfortunately
takes you to the IDL page for TextDocument; to reach the documentation, click on
"TextDocument" under the "Classes" heading.

Expand Down Expand Up @@ -337,8 +336,8 @@ bookmark in a document, extract its text range/position, and move the cursor to
location with gotoRange(). I'll show code for doing this in Chapter 7.

The XTextCursor methods are documented at
http://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1text_1_1XTex
tCursor.html (or type `lodoc XTextCursor`).
http://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1text_1_1XTextCursor.html
(or type `lodoc XTextCursor`).


#### A Problem with Write.getAllText()
Expand Down Expand Up @@ -1071,16 +1070,14 @@ These code fragments are combined together in my ShowBookText.java example.
More details on enumerators and text portions are given in the Developers Guide at
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Text/Iterating_over_Text
(or use loGuide "Iterating over Text").
(or use `loGuide "Iterating over Text"`).
## 9. Appending Documents Together
If you need to write a large multi-part document (e.g. a thesis with chapters,
appendices, contents page, and an index) then you should utilize a master document,
which acts as a repository of links to documents representing the component parts.
You can find out about master documents in Chapter 13 of the Writers Guide, at
https://wiki.documentfoundation.org/Documentation/Publications.
Expand Down
4 changes: 1 addition & 3 deletions docs/06-Text_Styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -979,12 +979,10 @@ XStyleFamiliesSupplier, they employ XChapterNumberingSupplier and
XNumberFormatsSupplier.

For more details, see the development guide:
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Text/Line_Numbering_an
d_Outline_Numbering
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Text/Line_Numbering_and_Outline_Numbering
or type `loGuide "Line Numbering"`.



## 10. Other Style Changes

StoryCreator.java illustrates three other styling effects: the creation of a header,
Expand Down
15 changes: 8 additions & 7 deletions docs/07-Non-text_Content.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,12 @@ String fnm = (String) props.getPropertyValue("GraphicURL");

I know the graphic object's URL is stored in the "GraphicURL" property from looking
at the documentation for the TextGraphicObject service. It can be (almost) directly
accessed by typing `lodoc TextGraphicObject service;` unfortunately
accessed by typing `lodoc TextGraphicObject service`; unfortunately
DuckDuckGo chooses the TextGraphicObjects service, and you need to click on the
"TextGraphicObject" link below the title to get to the required page.

It's possible to call setPropertyValue() to change a property:

`props.setPropertyValue("Transparency", (short)50);`

**What About the Text Content I Don't Cover?**
Expand All @@ -153,8 +154,8 @@ Table 1 has many rows without bold entries, which means I won't be looking at th

except for the very brief descriptions here; for more please consult the Developer's
Guide at
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Text/Working_with_Text_
Documents (or type `loGuide "Working with Text Documents"`). All the examples
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Text/Working_with_Text_Documents
(or type `loGuide "Working with Text Documents"`). All the examples
in that section are in TextDocuments.java at
http://api.libreoffice.org/examples/DevelopersGuide/examples.html#Text.

Expand All @@ -167,8 +168,8 @@ type `loGuide "Text Sections"`).
**Footnotes and Endnotes.** Footnotes and endnotes are blocks of text that appear in the
page footers and at the end of a document. They can be treated as XText objects, so
manipulated using the same techniques as the main document text. See:
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Text/Footnotes_and_Endn
otes (or type `loGuide Footnotes`).
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Text/Footnotes_and_Endnotes
(or type `loGuide Footnotes`).

**Reference Marks.** Reference marks can be inserted throughout a document, and then
jumped to via GetReference text fields:
Expand All @@ -180,8 +181,8 @@ anywhere in a document, but are used to generate indices (collections of informa
inside the document. There are several types of index marks used for generating lists
of chapter headings (i.e. a book's index), lists of key words, illustrations, tables, and a
bibliography. For details see:
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Text/Indexes_and_Index_
Marks (or type `loGuide Indexes`).
https://wiki.openoffice.org/wiki/Documentation/DevGuide/Text/Indexes_and_Index_Marks
(or type `loGuide Indexes`).

**Link Targets.** A link target (sometimes called a jump mark) labels a location inside a
document. These labels can be included as part of a filename so that the document can
Expand Down
Loading

0 comments on commit ef38ac0

Please sign in to comment.