mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-09 18:31:04 +00:00
61 lines
2.8 KiB
Plaintext
61 lines
2.8 KiB
Plaintext
DIRECTORY STRUCTURE & FILE NAMING
|
|
==================================
|
|
|
|
The examples directory has the following structure
|
|
|
|
examples/[language/]category/[subcategory]
|
|
|
|
Please use the layout category (with identical spelling to assure translation)
|
|
as category subdirectory (e.g., "Letters"). See \DeclareCategory entry of the
|
|
layout which corresponds to your example. Note the handling of special characters
|
|
below.
|
|
|
|
If your example consists of one file only, and if there are no further examples
|
|
relating to your layout yet, use the layout name, as defined in \DeclareLaTeXClass,
|
|
as file name. In any case, use a verbose, transparent name (do not use insider acronyms
|
|
as file names). Note the handling of special characters below.
|
|
|
|
If your example consists of multiple files, use an additional subdirectory.
|
|
Use the layout name, as defined in \DeclareLaTeXClass, as subcategory subfolder
|
|
name. Give the files verbose, transparent names that clarify the function of the respective
|
|
file in the examples bundle. Note the handling of special characters below.
|
|
|
|
The optional language subdirectory that immediately follows examples/ uses the
|
|
language code (e.g., 'de' for German). Use this if you provide a translation of
|
|
an existing English example.
|
|
The language subdirectory expands to the same subfolders than the English version
|
|
and uses the same [English) filename (e.g., examples/Letters/myletter.lyx >
|
|
examples/fr/Letters/myletter.lyx).
|
|
|
|
NOTE: The language subdirectory is for translations in the respective language. If you
|
|
want to provide a document in English _about_ a specific language (e.g., about how to
|
|
write a Turkish article), put it in the main directory in the "Language_Support" folder.
|
|
|
|
|
|
NB: SPECIAL CHARACTERS IN FILE AND DIRECTORY NAMES:
|
|
===================================================
|
|
|
|
The following characters in file and directory names must be substituted, since they break
|
|
LyX building with autotools:
|
|
|
|
* Blanks by '_' (e.g., My_Layout.lyx)
|
|
* Parentheses by %28 and %29 (e.g., My_Layout_%28v._1%29.lyx)
|
|
* Apersands by %26 (e.g., Journal_of_This_%26_That.lyx)
|
|
|
|
The substitution characters will be replaced again for LyX for translation and GUI display.
|
|
|
|
|
|
THINGS TO CHECK BEFORE COMMITTING:
|
|
==================================
|
|
|
|
New files must be added to Makefile.am. If you add a new (sub)folder, you must also create a new category
|
|
in Makefile.am (cf. dehandoutexamplesdir and dist_phdthesistemplates_DATA as example).
|
|
|
|
Please make sure before you commit (in a text editor) that the example that the file has the correct
|
|
\origin specification. It should begin with /systemlyxdir/ and then point towards the subdirectory
|
|
your file is in, e.g.
|
|
\origin /systemlyxdir/templates/es/Presentations/
|
|
This is particularly important if your file includes other files (such as graphics, bibliographies,
|
|
children).
|
|
|