Seth Chaiklin
a689cf1672
* Update helpcontent2 from branch 'master'
to 79d9996623c1896170aec53c788f9623df7731e0
- Mostly resolved: tdf#135668 - Help for Navigator context menus in Content View
1. Placed under "Content View" control, because seems most closely
linked to that.
2. Separate rows for general categories (e.g., "Headings", "Tables")
and specific items in the categories (because (a) there are
context menus for both and (b) they are different).
3. Provide links to items already explained in the Navigator page
(e.g., Outline Level).
4. Collected Frames, Images, OLE Objects, Bookmarks together,
because they have identical context menus, but the ones that
follow are different.
5. Collected "References" and "Indexes" together, because they
have identical context menus.
6 Provide links to other pages when relevant (e.g., Send
Outline to Clipboard).
7. Make new page for Outline Content Visibility (separate patch),
with link from Context Menu.
8. "Outline Tracking" (new feature in 7.0) - add a heading and
explanation at end of help page (Thanks to Jim Raykowski for
advice and accuracy control).
Design decisions:
1. Do not explain "Go to", "Select", "Edit", "Delete", "Rename"
(because it is contextual; should be easy to understand their
meaning in context)
2. Do not explain "Collapse/Expand All" (should be understandable
from use/context)
Result: Handles all context menus for Categories in Navigator.
Added: "Related Topics" Section, with links to:
Arranging Chapters in Navigator
Navigator for Document Overview
Inserting Hyperlinks with Navigator
Showing, Docking and Hiding Windows
Changed: <note> about context menus to <paragraph> and moved from
top of page down to heading on Content View.
Moved: <note> about hidden items to end of "Content View" section.
Revised: <paragraph> about searching with Navigate by, which
replaced a tearaway Navigation toolbar.
Change-Id: I965753234b9faec32fdf6d75766023b2f4b36643
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/104596
Tested-by: Jenkins
Reviewed-by: Seth Chaiklin <sdc.blanco@youmail.dk>
LibreOffice
LibreOffice is an integrated office suite based on copyleft licenses and compatible with most document formats and standards. Libreoffice is backed by The Document Foundation, which represents a large independent community of enterprises, developers and other volunteers moved by the common goal of bringing to the market the best software for personal productivity. LibreOffice is open source, and free to download, use and distribute.
A quick overview of the LibreOffice code structure.
Overview
You can develop for LibreOffice in one of two ways, one recommended and one much less so. First the somewhat less recommended way: it is possible to use the SDK to develop an extension, for which you can read the API docs here and here. This re-uses the (extremely generic) UNO APIs that are also used by macro scripting in StarBasic.
The best way to add a generally useful feature to LibreOffice is to work on the code base however. Overall this way makes it easier to compile and build your code, it avoids any arbitrary limitations of our scripting APIs, and in general is far more simple and intuitive - if you are a reasonably able C++ programmer.
The build chain and runtime baselines
These are the current minimal operating system and compiler versions to run and compile LibreOffice, also used by the TDF builds:
- Windows:
- Runtime: Windows 7
- Build: Cygwin + Visual Studio 2019 version 16.4
- macOS:
- Runtime: 10.10
- Build: 10.14.4 + Xcode 11.3
- Linux:
- Runtime: RHEL 7 or CentOS 7
- Build: either GCC 7.0.0; or Clang 5.0.2 with libstdc++ 7.3.0
- iOS (only for LibreOfficeKit):
- Runtime: 11.4 (only support for newer i devices == 64 bit)
- Build: Xcode 9.3 and iPhone SDK 11.4
- Android:
- Build: NDK r19c and SDK 22.6.2
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.
To setup your initial build environment on Windows and macOS, we provide the LibreOffice Development Environment (LODE) scripts.
For more information see the build instructions for your platform in the TDF wiki.
The important bits of code
Each module should have a README file inside it which has some
degree of documentation for that module; patches are most welcome to
improve those. We have those turned into a web page here:
However, there are two hundred modules, many of them of only peripheral interest for a specialist audience. So - where is the good stuff, the code that is most useful. Here is a quick overview of the most important ones:
| Module | Description |
|---|---|
| sal/ | this provides a simple System Abstraction Layer |
| tools/ | this provides basic internal types: 'Rectangle', 'Color' etc. |
| vcl/ | this is the widget toolkit library and one rendering abstraction |
| framework | UNO framework, responsible for building toolbars, menus, status bars, and the chrome around the document using widgets from VCL, and XML descriptions from /uiconfig/ files |
| sfx2/ | legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc. |
| svx/ | drawing model related helper code, including much of Draw/Impress |
Then applications
| Module | Description |
|---|---|
| desktop/ | this is where the 'main' for the application lives, init / bootstrap. the name dates back to an ancient StarOffice that also drew a desktop |
| sw/ | Writer |
| sc/ | Calc |
| sd/ | Draw / Impress |
There are several other libraries that are helpful from a graphical perspective:
| Module | Description |
|---|---|
| basegfx/ | algorithms and data-types for graphics as used in the canvas |
| canvas/ | new (UNO) canvas rendering model with various backends |
| cppcanvas/ | C++ helper classes for using the UNO canvas |
| drawinglayer/ | View code to render drawable objects and break them down into primitives we can render more easily. |
Rules for #include directives (C/C++)
Use the "..." form if and only if the included file is found next to the
including file. Otherwise, use the <...> form. (For further details, see the
mail Re: C[++]: Normalizing include syntax ("" vs
<>).)
The UNO API include files should consistently use double quotes, for the benefit of external users of this API.
loplugin:includeform (compilerplugins/clang/includeform.cxx) enforces these rules.
Finding out more
Beyond this, you can read the README files, send us patches, ask
on the mailing list libreoffice@lists.freedesktop.org (no subscription
required) or poke people on IRC #libreoffice-dev on irc.freenode.net -
we're a friendly and generally helpful mob. We know the code can be
hard to get into at first, and so there are no silly questions.