office-gobmx/extras/README.md
Christian Lohmaier f5ce765d56 simplify autotextshare makefile/only build what's packaged
The multiple indirections/complex nested constructs don't really provide
any benefit here, they certainly don't make the makefile easier to read.

It was building the autotext .bau files for all languages, despite being
packaged only for the requested UI langauges (via AllLagPackage) and the
long list of autotext files was duplicated (even if all .bau files
should be built, the list could be reused from the other makefile)

Also remove the empty mimetype files and just touch them instead of
copying them.

The xml, mimetype and other files are now intermediates and are removed by
make once the .bau is built. (if that's not desired, they can be flagged as
.SECONDARY)

The list of individual files (3.6k lines) could also be cut down if
using e.g. make's wildcard function

Change-Id: I223a49d26d1de1435d62a68a04b3713278a8320c
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/129696
Tested-by: Jenkins
Reviewed-by: Christian Lohmaier <lohmaier+LibreOffice@googlemail.com>
2022-02-10 11:35:04 +01:00

3.5 KiB

Extra Modules

Contains templates, clipart galleries, palettes, symbol font, autocorrections, autotexts etc.

  • How-to add a new gallery:

    • create a directory extras/source/gallery/foo/
    • create a .str file extras/source/gallery/foo/foo.str
    • add a foo section to extras/source/gallery/share/gallery_names.ulf
    • add a Gallery_foo.mk at the top-level (and mention in Module_extra.mk)
    • add a new GALLERY_FILELIST statement in scp2/
  • How-to add a new autotext category

    • create a directory extras/source/autotext/lang/xx/foo/ where xx is your lang code. xx must exactly fit with an UI lang code.
    • unzip your foo.bau autotext file in this directory (excluding an empty mimetype file)
    • add xx/foo.bau in extras/AllLangPackage_autotextshare.mk
    • in extras/CustomTarget_autotextshare.mk:
      • add all files contained in foo.bau (except mimetype) in extras_AUTOTEXTSHARE_XMLFILES
  • How-to add a new autotext to an existing category

    • create a directory extras/source/autotext/lang/xx/standard/FOO/ to add it in category standard of lang xx
    • add files of the autotext (at least FOO.xml for an unformatted autotext)
    • add autotext name in extras/source/autotext/lang/xx/standard/BlockList.xml
    • add all files of autotext in extras/source/autotext/lang/xx/standard/META-INF/manifest.xml
    • in extras/CustomTarget_autotextshare.mk:
      • add all files of autotext in extras_AUTOTEXTSHARE_XMLFILES
  • How-to add a new Impress template

    • clean-up template file as indicated on wiki https://wiki.documentfoundation.org/Documentation/HowTo/Impress/Make_template_language_independent
    • add <dc:title>Foo</dc:title> in meta.xml to make presentation name translatable
    • unzip Foo.otp file in extras/source/templates/presnt/Foo (no space allowed in any file names)
    • add Foo.otp in Package_tplpresnt.mk
    • in CustomTarget_tplpresnt.mk:
      • add Foo / in extras_TEMPLATES_PRESENTATIONS
      • add files names contained in Foo.otp (except mimetype) in extras_PRESENTATIONS_XMLFILES
      • if Foo.otp contains files with other extension than .xml, .svm, .svg, .png and .jpg
        • add a CPY call at the end of file
  • How-to add a new Writer template

    • clean-up template file as much as possible, and choose a template category <Category>
    • unzip Foo.ott in extras/source/templates/<Category>/Foo (no space allowed in any file names)
    • add Foo.ott in Package_<tplCategory>.mk
    • in CustomTarget_<tplCategory>.mk:
      • add Foo / in extras_TEMPLATES_<CATEGORY>
      • add files names contained in Foo.otp (except mimetype) in extras_<CATEGORY>_XMLFILES
      • if Foo.ott contains files with other extension than .xml, .rdf, .svm, .svg, .png and .jpg
        • add a CPY call at the end of file
  • How-to add a new template category

    • create a directory extras/source/templates/foo/
    • unzip your foo0.ott template files in extras/source/templates/foo/foo0
    • add Package_tplfoo and CustomTarget_tplfoo in Module_extras.mk
    • use other category Package_tplcategory.mk to create Package_tplfoo.mk
    • use other category CustomTarget_tplcategory.mk to create CustomTarget_tplfoo.mk
      • replace all category by foo and CATEGORY by FOO
      • add all files contained in foo0.ott (except mimetype) in extras_FOO_XMLFILES
      • if foo0.ott contains files with other extension than .xml, .rdf, .svm, .svg, .png and .jpg
        • add a CPY call at the end of the file
      • optionally, replace extension ott (4 places)