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 (including an empty mimetype file)
  15         + add `xx/foo.bau` in `extras/AllLangPackage_autotextshare.mk`
  16         + in `extras/CustomTarget_autotextshare.mk`:
  17                 + add `xx/foo` in `extras_AUTOTEXTSHARE_AUTOTEXTS`
  18                 + add all files contained in `foo.bau` (except mimetype) in `extras_AUTOTEXTSHARE_XMLFILES`
  19                 + if `foo.bau` contains files with other extension than `.xml`, `.rdf`, `.svm` and `.png`
  20                         + add a `CPY` call at the end of the file
  21
  22 + How-to add a new autotext to an existing category
  23         + create a directory `extras/source/autotext/lang/xx/standard/FOO/` to add it in category standard of lang `xx`
  24         + add files of the autotext (at least `FOO.xml` for an unformatted autotext)
  25         + add autotext name in `extras/source/autotext/lang/xx/standard/BlockList.xml`
  26         + add all files of autotext in `extras/source/autotext/lang/xx/standard/META-INF/manifest.xml`
  27         + in `extras/CustomTarget_autotextshare.mk`:
  28                 + add all files of autotext in `extras_AUTOTEXTSHARE_XMLFILES`
  29                 + if some files have different extension from `.xml`, `.rdf`, `.svm` and `.png`
  30                         + add a `CPY` call at the end of the file
  31
  32 + How-to add a new Impress template
  33         + clean-up template file as indicated on wiki <https://wiki.documentfoundation.org/Documentation/HowTo/Impress/Make_template_language_independent>
  34         + add `<dc:title>Foo</dc:title>` in `meta.xml` to make presentation name translatable
  35         + unzip `Foo.otp` file in `extras/source/templates/presnt/Foo` (no space allowed in any file names)
  36         + add `Foo.otp` in `Package_tplpresnt.mk`
  37         + in `CustomTarget_tplpresnt.mk`:
  38                 + add `Foo /` in `extras_TEMPLATES_PRESENTATIONS`
  39                 + add files names contained in `Foo.otp` (except mimetype) in `extras_PRESENTATIONS_XMLFILES`
  40                 + if `Foo.otp` contains files with other extension than `.xml`, `.svm`, `.svg`, `.png` and `.jpg`
  41                         + add a `CPY` call at the end of file
  42
  43 + How-to add a new Writer template
  44         + clean-up template file as much as possible, and choose a template category `<Category>`
  45         + unzip `Foo.ott` in `extras/source/templates/<Category>/Foo` (no space allowed in any file names)
  46         + add `Foo.ott` in `Package_<tplCategory>.mk`
  47         + in `CustomTarget_<tplCategory>.mk`:
  48                 + add `Foo /` in `extras_TEMPLATES_<CATEGORY>`
  49                 + add files names contained in `Foo.otp` (except mimetype) in `extras_<CATEGORY>_XMLFILES`
  50                 + if `Foo.ott` contains files with other extension than `.xml`, `.rdf`, `.svm`, `.svg`, `.png` and `.jpg`
  51                         + add a `CPY` call at the end of file
  52
  53 + How-to add a new template category
  54         + create a directory `extras/source/templates/foo/`
  55         + unzip your foo0.ott template files in `extras/source/templates/foo/foo0`
  56         + add `Package_tplfoo` and `CustomTarget_tplfoo` in `Module_extras.mk`
  57         + use other category `Package_tplcategory.mk` to create `Package_tplfoo.mk`
  58         + use other category `CustomTarget_tplcategory.mk` to create `CustomTarget_tplfoo.mk`
  59                 + replace all category by foo and `CATEGORY` by `FOO`
  60                 + add all files contained in `foo0.ott` (except mimetype) in `extras_FOO_XMLFILES`
  61                 + if `foo0.ott` contains files with other extension than `.xml`, `.rdf`, `.svm`, `.svg`, `.png` and `.jpg`
  62                         + add a `CPY` call at the end of the file
  63                 + optionally, replace extension ott (4 places)