loplugin:unusedfields
[LibreOffice.git] / readlicense_oo / README
blobeb6c4482df15d5c28ca78b2f1c2d571df5718bec
1 Contains the stock libreoffice licensing blurb, as distributed in the install
2 directory, and also potentially at run-time.
4 Generating licence files
5 ------------------------
7 License files are generated from a single source file (license/license.xml).
8 Output file formats are plain text and html.
10 - The plain text and the html format is generated with xslt. There are two
11   separate xsl files for plain text and html.
13 Conditional text
14 ----------------
16 The contents of the license file depends on the build configuration. Several
17 externals may or may not be shipped with LibreOffice. Therefore, we need to pass
18 information about build configuration to the xslt processor.
20 Variables used for conditional text:
22 - BUILD_TYPE: A space separated list of libraries/externals. If an external is
23   present in that list, then the related license text should be included.
25 - MPL_SUBSET: If the variable is defined, then GPL and LGPL license text will not
26   be included, because none of the built-in code need it.
28 - OS: The target platform. E.g. MSVC Runtime is packaged and used only on Windows.
30 - WITH_THEMES: A space separated list of icon sets that are used in the build.
32 Conditional text are surrounded by and extra <div> tag. The class attribute of
33 that <div> tag decides which parameter values are taken into consideration.