extras/README.md

   1 # Extra Modules
   2
   3 Contains templates, clipart galleries, palettes, symbol font, autocorrections, autotexts etc.
   4
   5 + How-to add a new gallery:
   6         + create a directory `extras/source/gallery/foo/`
   7         + create a `.str` file `extras/source/gallery/foo/foo.str`
   8         + add a `foo` section to `extras/source/gallery/share/gallery_names.ulf`
   9         + add a `Gallery_foo.mk` at the top-level (and mention in `Module_extra.mk`)
  10         + add a new `GALLERY_FILELIST` statement in `scp2/`
  11
  12 + How-to add a new autotext category
  13         + create a directory `extras/source/autotext/lang/xx/foo/` where `xx` is your lang code. `xx` must exactly fit with an UI lang code.
  14         + unzip your `foo.bau` autotext file in this directory (excluding an empty mimetype file)
  15         + add `xx/foo.bau` in `extras/AllLangPackage_autotextshare.mk`
  16         + in `extras/CustomTarget_autotextshare.mk`:
  17                 + add all files contained in `foo.bau` (except mimetype) in `extras_AUTOTEXTSHARE_XMLFILES`
  18
  19 + How-to add a new autotext to an existing category
  20         + create a directory `extras/source/autotext/lang/xx/standard/FOO/` to add it in category standard of lang `xx`
  21         + add files of the autotext (at least `FOO.xml` for an unformatted autotext)
  22         + add autotext name in `extras/source/autotext/lang/xx/standard/BlockList.xml`
  23         + add all files of autotext in `extras/source/autotext/lang/xx/standard/META-INF/manifest.xml`
  24         + in `extras/CustomTarget_autotextshare.mk`:
  25                 + add all files of autotext in `extras_AUTOTEXTSHARE_XMLFILES`
  26
  27 + How-to add a new template category
  28         + add long category name in TEMPLATE_LONG_NAMES_ARY in sfx2/inc/doctempl.hrc
  29         + add short category name in TEMPLATE_SHORT_NAMES_ARY in sfx2/source/doc/doctemplates.cxx
  30
  31 + How-to add a new template to an existing category
  32         + clean-up template file as indicated on wiki <https://wiki.documentfoundation.org/Documentation/HowTo/Impress/Make_template_language_independent>
  33         + recommendation for settings.xml are given on wiki <https://wiki.documentfoundation.org/Documentation/CompatibilityFlags#Settings_to_include_in_a_new_template>
  34         + add `<dc:title>Foo</dc:title>` in `meta.xml` to make presentation name translatable
  35         + choose a template category `<Category>`
  36         + unzip `Foo.ot?` (? = p, t, s or g) in `extras/source/templates/<Category>/Foo` (no space allowed in any file names)
  37         + add `<Category>/Foo.ot? /` in `Package_templates.mk` (or `Package_tplpresnt.mk` if it's a presentation)
  38         + in `template_files.mk`:
  39                 + add e.g. `<Category>/Foo/settings.xml` (and all other files which are not automatically added) to `extra_files_COMMON` (or `extra_files_PRESENTATIONS` in case of a presentation template)
  40         + for translation of template name
  41                 + define a new STR_TEMPLATE_NAMExx in include/sfx2/strings.hrc
  42                 + define a new STR_TEMPLATE_NAMExx_DEF in sfx2/inc/strings.hxx
  43                 + in sfx2/source/doc/doctempl.cxx
  44                         + add STR_TEMPLATE_NAMExx_DEF to aTemplateNames
  45                         + add STR_TEMPLATE_NAMExx to STR_TEMPLATE_NAME