summaryrefslogtreecommitdiff
path: root/extensions
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-29 21:55:26 +0430
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-04-07 17:47:16 +0200
commitea5641baeef73af60d025d185901a303844e2d85 (patch)
tree94b343b35e7b8805beb9a1745fe1de2f382574fb /extensions
parent33da78c21f4243a3e469fb7df79ed1745df70078 (diff)
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md and now, the contents of these files were changed to use Markdown format. Other than format inconsistency, some README.md files lacked information about modules, or were out of date. By using LibreOffice / OpenOffice wiki and other documentation websites, these files were updated. Now every README.md file has a title, and some description. The top-level README.md file is changed to add links to the modules. The result of processing the Markdown format README.md files can be seen at: https://docs.libreoffice.org/ Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424 Tested-by: Jenkins Reviewed-by: Michael Stahl <michael.stahl@allotropia.de> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'extensions')
-rw-r--r--extensions/README.md46
1 files changed, 26 insertions, 20 deletions
diff --git a/extensions/README.md b/extensions/README.md
index 38df77e37fba..94cf2acbebd6 100644
--- a/extensions/README.md
+++ b/extensions/README.md
@@ -1,45 +1,51 @@
-This module contains a grab-bag of unrelated misc. libraries, *none* of which is an extension.
+# Miscellaneous Modules
-== Application online update checking ==
+This module contains a grab-bag of unrelated miscellaneous libraries, *none* of
+which is an extension.
-When we start LO, first InitUpdateCheckJobThread is created, via
-UpdateCheckJob::execute() (from extensions/source/update/check/updatecheckjob.cxx),
-as a reaction to a "onFirstVisibleTask" event. It waits 25 seconds (so that it
+## Application Online Update Checking
+
+When we start LO, first `InitUpdateCheckJobThread` is created, via
+`UpdateCheckJob::execute()` (from `extensions/source/update/check/updatecheckjob.cxx`),
+as a reaction to a `onFirstVisibleTask` event. It waits 25 seconds (so that it
does not interfere with the startup itself), and then calls
-UpdateCheck::initialize() (from extensions/source/update/check/updatecheck.cxx).
+`UpdateCheck::initialize()` (from `extensions/source/update/check/updatecheck.cxx`).
-This creates one more thread, UpdateCheckThread, that regularly checks whether
+This creates one more thread, `UpdateCheckThread`, that regularly checks whether
we have reached the time when we should ask for the update. If yes, asks for
that, and shows the download button in the menu (if the new update is
available).
-== OLE automation bridge ==
+## OLE Automation Bridge
A bridge between "OLE automation" and UNO, so you can use UNO services
from JScript, VBScript, etc.
-https://www.openoffice.org/udk/common/man/spec/ole_bridge.html
+<https://www.openoffice.org/udk/common/man/spec/ole_bridge.html>
-See udkapi/com/sun/star/bridge/oleautomation/ApplicationRegistration.idl
+See `udkapi/com/sun/star/bridge/oleautomation/ApplicationRegistration.idl`
-This is initialized in Desktop::Main() in Desktop::OpenClients_Impl()
-by creating the service "com.sun.star.bridge.OleApplicationRegistration",
-which is implemented by OleServer_Impl.
+This is initialized in `Desktop::Main()` in `Desktop::OpenClients_Impl()`
+by creating the service `com.sun.star.bridge.OleApplicationRegistration`,
+which is implemented by `OleServer_Impl`.
-See extensions/source/ole/
+See `extensions/source/ole/`
-== ActiveX control ==
+## ActiveX Control
This allows embedding LO into a Win32 application as an ActiveX control.
-See extensions/source/activex/
-== Spotlight provider ==
+See `extensions/source/activex/`
+
+## Spotlight Provider
On macOS, this allows indexing ODF documents with Spotlight.
-See extensions/source/macosx/spotlight/
-== Scanner support ==
+See `extensions/source/macosx/spotlight/`
+
+## Scanner Support
You can scan from LibreOffice, using platform specific backends like TWAIN/SANE.
-See extensions/source/scanner/
+
+See `extensions/source/scanner/`