diff options
| author | Hossein <hossein.ir@gmail.com> | 2021-03-29 21:55:26 +0430 |
|---|---|---|
| committer | Adolfo Jayme Barrientos <fitojb@ubuntu.com> | 2021-04-07 17:47:16 +0200 |
| commit | ea5641baeef73af60d025d185901a303844e2d85 (patch) | |
| tree | 94b343b35e7b8805beb9a1745fe1de2f382574fb /sfx2 | |
| parent | 33da78c21f4243a3e469fb7df79ed1745df70078 (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 'sfx2')
| -rw-r--r-- | sfx2/README.md | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/sfx2/README.md b/sfx2/README.md index 9726870a6019..58e97d62361d 100644 --- a/sfx2/README.md +++ b/sfx2/README.md @@ -1,28 +1,30 @@ -SFX is the "old" framework, used for historical reasons. +# Legacy Framework -An attempt of documentation of this module is located in [git:sfx2/doc]. +`SFX` is the "old" framework, used for historical reasons. + +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 +by "old" applications like `sw`, `sc`, `sd` (while "new" applications are based on the "new" UNO based framework in "framework"). The SFX framework is based on dispatching slots identified by integers -(SlotIDs) to SfxShells, and there is a dedicated IDL compiler (svidl) -involved that generates C++ slot headers from SDI files in modules' sdi/ +(`SlotIDs`) to `SfxShells`, and there is a dedicated IDL compiler (`svidl`) +involved that generates C++ slot headers from SDI files in modules' `sdi/` subdirectory. Documentation about SFX dispatch, SDI etc.: -https://wiki.openoffice.org/wiki/Framework/Article/Implementation_of_the_Dispatch_API_In_SFX2 +<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] -SfxMedium class, which handles all the twisty load and save corner cases. +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. There are also some UNO services here that could really be implemented -anywhere, e.g. the DocumentProperties or DocumentMetadataAccess. +anywhere, e.g. the `DocumentProperties` or `DocumentMetadataAccess`. Notable files: -sfx2/source/dialog/backingwindow.cxx Startcenter buttons and the corresponding event handler. +`sfx2/source/dialog/backingwindow.cxx` `Startcenter` buttons and the corresponding event handler. |