lib/examples/README.new_examples

   1 DIRECTORY STRUCTURE & FILE NAMING
   2 ==================================
   3
   4 The examples directory has the following structure
   5
   6 examples/[language/]category/[subcategory]
   7
   8 Please use the layout category (with identical spelling to assure translation)
   9 as category subdirectory (e.g., "Letters"). See \DeclareCategory entry of the
  10 layout which corresponds to your example. Substitute blanks by '_'.
  11
  12 If your example consists of one file only, and if there are no further examples
  13 relating to your layout yet, use the layout name, as defined in \DeclareLaTeXClass,
  14 as file name. Substitute blanks by '_' (e.g., My_Layout.lyx). In any case, use
  15 a verbose, transparent name (do not use insider acronyms as file names).
  16
  17 If your example consists of multiple files, use an additional subdirectory.
  18 Use the layout name, as defined in \DeclareLaTeXClass, as subcategory subfolder
  19 name. Substitute blanks by '_' (e.g., My_Layout). Give the files verbose,
  20 transparent names that clarify the function of the respective file in the examples
  21 bundle. Use '_' instead of blanks.
  22
  23 The optional language subdirectory that immediately follows examples/ uses the
  24 language code (e.g., 'de' for German). Use this if you provide a translation of
  25 an existing English example.
  26 The language subdirectory expands to the same subfolders than the English version
  27 and uses the same [English) filename (e.g., examples/Letters/myletter.lyx >
  28 examples/fr/Letters/myletter.lyx).
  29
  30 If you add a new (sub)folder, you must create a new entry in Makefile.am.
  31