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]>

Author: hosseinn

README.md

@@ -53,7 +53,7 @@ If you want to use Clang with the LibreOffice compiler plugins, the minimal
 version of Clang is 5.0.2. Since Xcode doesn't provide the compiler plugin
 headers, you have to compile your own Clang to use them on macOS.
 
-You can find the TDF configure switches in the distro-configs/ directory.
+You can find the TDF configure switches in the `distro-configs/` directory.
 
 To setup your initial build environment on Windows and macOS, we provide
 the LibreOffice Development Environment

animations/README.md

@@ -1,3 +1,3 @@
-# Containers for the css::animation animation UNO API
+# Containers for the css::animation UNO API
 
 Contains containers for the `css::animation` UNO API, used in `slideshow` and `sd`.

apple_remote/README.md

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

basegfx/README.md

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

bin/README.md

@@ -8,4 +8,4 @@ build, or are simply generally useful. One example is
     bin/find-german-comments <directory>
 
 which will try to detect and extract all the German comments in a
-given source code hierarchy / directory.
+given source code hierarchy `/` directory.

cli_ure/README.md

@@ -3,4 +3,5 @@
 Support assemblies and tools for the MS .NET UNO binding.
 
 ## See also
-`git:cli\_ure/readme.txt`
+
+`[git:cli_ure/readme.txt]`

compilerplugins/README.md

@@ -63,4 +63,4 @@ in rewriting mode (during which no object files are generate).
 
 ## Code Documentation / HowTos
 
-<http://wiki.documentfoundation.org/Clang_plugins>
+<https://wiki.documentfoundation.org/Clang_plugins>

ios/README.md

@@ -0,0 +1,3 @@
+# LibreOffice for iOS
+
+LibreOffice for iOS

jvmfwk/README.md

@@ -9,7 +9,7 @@ IMPORTANT:  The `<updated>` element in `vmfwk/distributions/OpenOfficeorg/javave
 should only be updated for incompatible changes, not for compatible ones.  As stated in the commit
 message of <https://gerrit.libreoffice.org/#/c/69730/> in LibreOffice gerrit:
 
-"**javavendors\_\*.xml \<updated\> should not have been updated...**
+javavendors\_\*.xml &lt;updated\> should not have been updated...
 
 Changing `<updated>` causes `jfw_startVM` and `jfw_getSelectedJRE` (both
 `jvmfwk/source/framework.cxx`) to fail with `JFW_E_INVALID_SETTINGS`, which in turn causes functionality

libreofficekit/README.md

@@ -8,22 +8,23 @@ tiled rendering API).
 
 ## Integrating LOK Into Other Software
 
-LOK functionality can be accessed by including LibreOfficeKit.h[xx] in your
+LOK functionality can be accessed by including `LibreOfficeKit.h[xx]` in your
 program.
 
-LOK initialisation (lok_init) requires the inclusion of LibreOfficeKitInit.h in
-your program. If you use the C++ LibreOfficeKit.hxx header, it already includes
-LibreOfficeKitInit.h for you.
+LOK initialisation (`lok_init`) requires the inclusion of `LibreOfficeKitInit.h` in
+your program. If you use the C++ `LibreOfficeKit.hxx` header, it already includes
+`LibreOfficeKitInit.h` for you.
 
-(LibreOfficeKit.hxx is a simple and fully inlined C++ wrapper for the same
-functionality as in LibreOfficeKit.h.)
+(`LibreOfficeKit.hxx` is a simple and fully inlined C++ wrapper for the same
+functionality as in `LibreOfficeKit.h`.)
 
 An example program can be seen on:
-https://gitlab.com/ojwb/lloconv
+<https://gitlab.com/ojwb/lloconv>
 
 ## Tiled Rendering
 
 To use LOK Tiled Rendering you will need the following before the LOK includes:
+
     #define LOK_USE_UNSTABLE_API
 
 (This must be define before ANY LOK header, i.e. including the Init header.)
@@ -36,12 +37,12 @@ to bottom-up).
 ## Tiled Editing
 
 On top of the tiled rendering API, a set of new methods have been added to the
-lok::Document class to allow basic editing, too. Communication between the LOK
+`lok::Document` class to allow basic editing, too. Communication between the LOK
 client and LibreOffice is a two-way channel. The client can initiate an action
 by calling the above mentioned methods. The most important methods for the
 client -> LibreOffice communication are:
 
-- initializeForRendering(), expected to be called right after
+- `initializeForRendering()`, expected to be called right after
   `lok::Office::documentLoad()` returned a `lok::Document*`.
 - `postKeyEvent()`, expected to be called when the user provides input on the
   (soft-)keyboard.
@@ -56,9 +57,9 @@ The other way around (LibreOffice -> LOK client) is implemented using a
 callback. A LOK client can register a callback using the registerCallback()
 method. Whenever editing requires some action on the client side, a callback
 event is emitted. The callback types are described using the
-LibreOfficeKitCallbackType enumeration in LibreOfficeKitEnums.h, the callback
+`LibreOfficeKitCallbackType` enumeration in `LibreOfficeKitEnums.h`, the callback
 function signature itself is provided by the LibreOfficeKitCallback typedef in
-LibreOfficeKitTypes.h. The most important callback types:
+`LibreOfficeKitTypes.h`. The most important callback types:
 
 - `LOK_CALLBACK_INVALIDATE_TILES`: drop all tiles cached on client-side that
   intersect with the provided rectangle
@@ -70,31 +71,31 @@ LibreOfficeKitTypes.h. The most important callback types:
 
 There are currently two known LOK clients supporting tiled editing:
 
-- gtktiledviewer (see below), which allows testing the LOK core implementation
+- `gtktiledviewer` (see below), which allows testing the LOK core implementation
   on (desktop) Linux
 - (LibreOffice on) Android
 
 Core has next to no idea what is the LOK client, so for effective development,
-it's recommended that the core part is developed against gtktiledviewer, and
+it's recommended that the core part is developed against `gtktiledviewer`, and
 once a feature works there, then implement the Android part, with its slower
 development iteration (slow uploading to the device, the need to link all
-object files into a single .so, etc).
+object files into a single `.so`, etc).
 
-* Debugging with gdb and gtktiledviewer
+* Debugging with gdb and `gtktiledviewer`
 
-To run gtktiledviewer:
+To run `gtktiledviewer`:
 
     bin/run gtktiledviewer --lo-path=$PWD/instdir/program path/to/test.odt
 
 To receive all incoming events from core use `G_MESSAGES_DEBUG=all`
 
     G_MESSAGES_DEBUG=all bin/run gtktiledviewer --lo-path=$PWD/instdir/program ../test.odt
 
-To debug with gdb:
+To debug with `gdb`:
 
     export LO_TRACE='gdb --tui --args'
 
-before bin/run, this will run gtktiledviewer in the debugger instead.
+before `bin/run`, this will run gtktiledviewer in the debugger instead.
 
 ## LibreOfficeKitGtk
 

o3tl/README.md

@@ -13,25 +13,21 @@ to boost, but isn't as of now)."
 
 ## Class Overview
 
-- `git:o3tl/inc/o3tl/cow_wrapper.hxx`
+- `[git:include/o3tl/cow_wrapper.hxx]`
 
     A copy-on-write wrapper.
 
-- `git:o3tl/inc/o3tl/lazy_update.hxx`
+- `[git:include/o3tl/lazy_update.hxx]`
 
     This template collects data in input type, and updates the output type with the given update functor,
     but only if the output is requested. Useful if updating is expensive, or input changes frequently, but
     output is only comparatively seldom used.
 
-- `git:o3tl/inc/o3tl/range.hxx`
-
-    Represents a range of integer or iterator values.
-
-- `git:o3tl/inc/o3tl/vector_pool.hxx`
+- `[git:include/o3tl/vector_pool.hxx]`
 
     Simple vector-based memory pool allocator.
 
-- `git:o3tl/inc/o3tl/functional.hxx`
+- `[git:include/o3tl/functional.hxx]`
 
     Some more templates, leftovers in spirit of STLport's old functional
     header that are not part of the C++ standard (STLport has been

oox/README.md

@@ -157,6 +157,7 @@ custom shapes. OpenXML SDK tools might help when fixing
 
 ## Export
 Here is how LO's enhanced custom shapes are exported:
+
 * Shape name is `ooxml-*` - they are imported from ooxml, export as is.
 * Denylist - ODF presets that has OOXML equivalent.
   We convert adjustment values case by case. Microsoft Office

setup_native/README.md

@@ -0,0 +1,3 @@
+# Native Code and Scripts for LibreOffice Installer
+
+Contains native code and scripts for LibreOffice installer.

sfx2/README.md

@@ -2,7 +2,7 @@
 
 `SFX` is the "old" framework, used for historical reasons.
 
-An attempt of documentation of this module is located in `git:sfx2/doc`.
+An attempt of documentation of this module is located in `[git:sfx2/doc]`.
 
 It contains base classes for document model, view and controller, used
 by "old" applications like `sw`, `sc`, `sd` (while "new" applications
@@ -16,10 +16,10 @@ subdirectory.
 Documentation about SFX dispatch, SDI etc.:
 <https://wiki.openoffice.org/wiki/Framework/Article/Implementation_of_the_Dispatch_API_In_SFX2>
 
-Document load/save code is maintained in `git:sfx2/source/doc/docfile.cxx`
+Document load/save code is maintained in `[git:sfx2/source/doc/docfile.cxx`]
 `SfxMedium` class, which handles all the twisty load and save corner cases.
 
-`git:sfx2/source/appl/sfxhelp.cxx` Start procedure for the online
+`[git:sfx2/source/appl/sfxhelp.cxx]` Start procedure for the online
 help viewer top level window; handling of help URL creation and
 dispatch.