Skip to content

Commit 628c1c3

Browse files
hosseinnmistmist
authored andcommitted
Updated README.md files
* Updated README.md contents to fix various issues * Fixed source links by using [git:], processed by mkdocs scripts * Added README.md for ios, setup_native, unotest * Fixed issues with "underline" and "less than" sign Change-Id: I3e52a1d3372586c390ee6c42a2ef48bbabc81398 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/114248 Tested-by: Jenkins Reviewed-by: Michael Stahl <[email protected]>
1 parent 1a984f2 commit 628c1c3

File tree

18 files changed

+162
-154
lines changed

18 files changed

+162
-154
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ If you want to use Clang with the LibreOffice compiler plugins, the minimal
5353
version of Clang is 5.0.2. Since Xcode doesn't provide the compiler plugin
5454
headers, you have to compile your own Clang to use them on macOS.
5555

56-
You can find the TDF configure switches in the distro-configs/ directory.
56+
You can find the TDF configure switches in the `distro-configs/` directory.
5757

5858
To setup your initial build environment on Windows and macOS, we provide
5959
the LibreOffice Development Environment

animations/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Containers for the css::animation animation UNO API
1+
# Containers for the css::animation UNO API
22

33
Contains containers for the `css::animation` UNO API, used in `slideshow` and `sd`.

apple_remote/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
The library is used to interact with the "Apple Remote Control" on Mac.
44

5-
This is an early version of Martin Kahr's "Remote Control Wrapper"
6-
library
7-
(http://martinkahr.com/2007/07/26/remote-control-wrapper-20/index.html
8-
) with modifications by Eric Bachard. Unfortunately the exact extent
5+
This is an early version of Martin Kahr's ["Remote Control Wrapper" library](
6+
<http://martinkahr.com/2007/07/26/remote-control-wrapper-20/index.html>)
7+
with modifications by Eric Bachard. Unfortunately the exact extent
98
of (and rationale behind) the modifications done is unknown, at least
109
until the original upstream source version it is based on is
1110
found. Version control of this just starts with the monolithic commit

basegfx/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Algorithms and Data Types for Graphics
22

3-
Algorithms and data types for graphics (e.g. polygons, vectors, matrices and the like - see that used in "canvas").
3+
Algorithms and data types for graphics (e.g. polygons, vectors, matrices and the like - see that used in `canvas`).

bin/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ build, or are simply generally useful. One example is
88
bin/find-german-comments <directory>
99

1010
which will try to detect and extract all the German comments in a
11-
given source code hierarchy / directory.
11+
given source code hierarchy `/` directory.

cli_ure/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
Support assemblies and tools for the MS .NET UNO binding.
44

55
## See also
6-
`git:cli\_ure/readme.txt`
6+
7+
`[git:cli_ure/readme.txt]`

compilerplugins/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ in rewriting mode (during which no object files are generate).
6363

6464
## Code Documentation / HowTos
6565

66-
<http://wiki.documentfoundation.org/Clang_plugins>
66+
<https://wiki.documentfoundation.org/Clang_plugins>

ios/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# LibreOffice for iOS
2+
3+
LibreOffice for iOS

jvmfwk/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ IMPORTANT: The `<updated>` element in `vmfwk/distributions/OpenOfficeorg/javave
99
should only be updated for incompatible changes, not for compatible ones. As stated in the commit
1010
message of <https://gerrit.libreoffice.org/#/c/69730/> in LibreOffice gerrit:
1111

12-
"**javavendors\_\*.xml \<updated\> should not have been updated...**
12+
javavendors\_\*.xml &lt;updated\> should not have been updated...
1313

1414
Changing `<updated>` causes `jfw_startVM` and `jfw_getSelectedJRE` (both
1515
`jvmfwk/source/framework.cxx`) to fail with `JFW_E_INVALID_SETTINGS`, which in turn causes functionality

libreofficekit/README.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,23 @@ tiled rendering API).
88

99
## Integrating LOK Into Other Software
1010

11-
LOK functionality can be accessed by including LibreOfficeKit.h[xx] in your
11+
LOK functionality can be accessed by including `LibreOfficeKit.h[xx]` in your
1212
program.
1313

14-
LOK initialisation (lok_init) requires the inclusion of LibreOfficeKitInit.h in
15-
your program. If you use the C++ LibreOfficeKit.hxx header, it already includes
16-
LibreOfficeKitInit.h for you.
14+
LOK initialisation (`lok_init`) requires the inclusion of `LibreOfficeKitInit.h` in
15+
your program. If you use the C++ `LibreOfficeKit.hxx` header, it already includes
16+
`LibreOfficeKitInit.h` for you.
1717

18-
(LibreOfficeKit.hxx is a simple and fully inlined C++ wrapper for the same
19-
functionality as in LibreOfficeKit.h.)
18+
(`LibreOfficeKit.hxx` is a simple and fully inlined C++ wrapper for the same
19+
functionality as in `LibreOfficeKit.h`.)
2020

2121
An example program can be seen on:
22-
https://gitlab.com/ojwb/lloconv
22+
<https://gitlab.com/ojwb/lloconv>
2323

2424
## Tiled Rendering
2525

2626
To use LOK Tiled Rendering you will need the following before the LOK includes:
27+
2728
#define LOK_USE_UNSTABLE_API
2829

2930
(This must be define before ANY LOK header, i.e. including the Init header.)
@@ -36,12 +37,12 @@ to bottom-up).
3637
## Tiled Editing
3738

3839
On top of the tiled rendering API, a set of new methods have been added to the
39-
lok::Document class to allow basic editing, too. Communication between the LOK
40+
`lok::Document` class to allow basic editing, too. Communication between the LOK
4041
client and LibreOffice is a two-way channel. The client can initiate an action
4142
by calling the above mentioned methods. The most important methods for the
4243
client -> LibreOffice communication are:
4344

44-
- initializeForRendering(), expected to be called right after
45+
- `initializeForRendering()`, expected to be called right after
4546
`lok::Office::documentLoad()` returned a `lok::Document*`.
4647
- `postKeyEvent()`, expected to be called when the user provides input on the
4748
(soft-)keyboard.
@@ -56,9 +57,9 @@ The other way around (LibreOffice -> LOK client) is implemented using a
5657
callback. A LOK client can register a callback using the registerCallback()
5758
method. Whenever editing requires some action on the client side, a callback
5859
event is emitted. The callback types are described using the
59-
LibreOfficeKitCallbackType enumeration in LibreOfficeKitEnums.h, the callback
60+
`LibreOfficeKitCallbackType` enumeration in `LibreOfficeKitEnums.h`, the callback
6061
function signature itself is provided by the LibreOfficeKitCallback typedef in
61-
LibreOfficeKitTypes.h. The most important callback types:
62+
`LibreOfficeKitTypes.h`. The most important callback types:
6263

6364
- `LOK_CALLBACK_INVALIDATE_TILES`: drop all tiles cached on client-side that
6465
intersect with the provided rectangle
@@ -70,31 +71,31 @@ LibreOfficeKitTypes.h. The most important callback types:
7071

7172
There are currently two known LOK clients supporting tiled editing:
7273

73-
- gtktiledviewer (see below), which allows testing the LOK core implementation
74+
- `gtktiledviewer` (see below), which allows testing the LOK core implementation
7475
on (desktop) Linux
7576
- (LibreOffice on) Android
7677

7778
Core has next to no idea what is the LOK client, so for effective development,
78-
it's recommended that the core part is developed against gtktiledviewer, and
79+
it's recommended that the core part is developed against `gtktiledviewer`, and
7980
once a feature works there, then implement the Android part, with its slower
8081
development iteration (slow uploading to the device, the need to link all
81-
object files into a single .so, etc).
82+
object files into a single `.so`, etc).
8283

83-
* Debugging with gdb and gtktiledviewer
84+
* Debugging with gdb and `gtktiledviewer`
8485

85-
To run gtktiledviewer:
86+
To run `gtktiledviewer`:
8687

8788
bin/run gtktiledviewer --lo-path=$PWD/instdir/program path/to/test.odt
8889

8990
To receive all incoming events from core use `G_MESSAGES_DEBUG=all`
9091

9192
G_MESSAGES_DEBUG=all bin/run gtktiledviewer --lo-path=$PWD/instdir/program ../test.odt
9293

93-
To debug with gdb:
94+
To debug with `gdb`:
9495

9596
export LO_TRACE='gdb --tui --args'
9697

97-
before bin/run, this will run gtktiledviewer in the debugger instead.
98+
before `bin/run`, this will run gtktiledviewer in the debugger instead.
9899

99100
## LibreOfficeKitGtk
100101

o3tl/README.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,21 @@ to boost, but isn't as of now)."
1313

1414
## Class Overview
1515

16-
- `git:o3tl/inc/o3tl/cow_wrapper.hxx`
16+
- `[git:include/o3tl/cow_wrapper.hxx]`
1717

1818
A copy-on-write wrapper.
1919

20-
- `git:o3tl/inc/o3tl/lazy_update.hxx`
20+
- `[git:include/o3tl/lazy_update.hxx]`
2121

2222
This template collects data in input type, and updates the output type with the given update functor,
2323
but only if the output is requested. Useful if updating is expensive, or input changes frequently, but
2424
output is only comparatively seldom used.
2525

26-
- `git:o3tl/inc/o3tl/range.hxx`
27-
28-
Represents a range of integer or iterator values.
29-
30-
- `git:o3tl/inc/o3tl/vector_pool.hxx`
26+
- `[git:include/o3tl/vector_pool.hxx]`
3127

3228
Simple vector-based memory pool allocator.
3329

34-
- `git:o3tl/inc/o3tl/functional.hxx`
30+
- `[git:include/o3tl/functional.hxx]`
3531

3632
Some more templates, leftovers in spirit of STLport's old functional
3733
header that are not part of the C++ standard (STLport has been

oox/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ custom shapes. OpenXML SDK tools might help when fixing
157157

158158
## Export
159159
Here is how LO's enhanced custom shapes are exported:
160+
160161
* Shape name is `ooxml-*` - they are imported from ooxml, export as is.
161162
* Denylist - ODF presets that has OOXML equivalent.
162163
We convert adjustment values case by case. Microsoft Office

setup_native/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Native Code and Scripts for LibreOffice Installer
2+
3+
Contains native code and scripts for LibreOffice installer.

sfx2/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
`SFX` is the "old" framework, used for historical reasons.
44

5-
An attempt of documentation of this module is located in `git:sfx2/doc`.
5+
An attempt of documentation of this module is located in `[git:sfx2/doc]`.
66

77
It contains base classes for document model, view and controller, used
88
by "old" applications like `sw`, `sc`, `sd` (while "new" applications
@@ -16,10 +16,10 @@ subdirectory.
1616
Documentation about SFX dispatch, SDI etc.:
1717
<https://wiki.openoffice.org/wiki/Framework/Article/Implementation_of_the_Dispatch_API_In_SFX2>
1818

19-
Document load/save code is maintained in `git:sfx2/source/doc/docfile.cxx`
19+
Document load/save code is maintained in `[git:sfx2/source/doc/docfile.cxx`]
2020
`SfxMedium` class, which handles all the twisty load and save corner cases.
2121

22-
`git:sfx2/source/appl/sfxhelp.cxx` Start procedure for the online
22+
`[git:sfx2/source/appl/sfxhelp.cxx]` Start procedure for the online
2323
help viewer top level window; handling of help URL creation and
2424
dispatch.
2525

0 commit comments

Comments
 (0)