lyx_mirror/lib/examples
Enrico Forestieri 5be2e3c734 Typo
2020-12-07 22:32:36 +01:00
..
ar
Articles Remove old example, as its mechanisms are now deprecated. 2020-07-02 15:27:20 +02:00
Books
ca
cs
Curricula_Vitae
da
de de/Linguistics: another typo 2019-06-24 13:49:30 +02:00
el
es
eu
External_Material
fa
fr Powerdot examples: work around undefined ref 2020-11-01 13:42:47 -05:00
gl
Graphics_and_Insets Minor fixes to XY-Pic.lyx 2020-08-05 18:48:36 +02:00
Handouts
he
hu
id
it Typo 2020-12-07 22:32:36 +01:00
ja Format incremented to 574: Ruby inset, fixes for Japanese. 2019-05-16 13:48:07 +02:00
ko ctest autotest for #11773 language nesting with lyx2lyx. 2020-03-05 00:24:08 +01:00
Letters
lt Fix lithuanian default font encoding and Xindy name. 2020-11-22 22:16:57 +01:00
Modules Noweb_Listerrors.lyx: do not force ps2pdf 2020-11-13 21:30:22 -05:00
nb
nl Dutch doc updates by Niko 2019-07-06 15:49:16 +02:00
pl
Posters
Presentations Powerdot examples: work around undefined ref 2020-11-01 13:42:47 -05:00
pt_BR
pt_PT
ro
ru Update Russian localization 2020-09-17 07:21:02 +02:00
Scripts
sk
sl
sr
sv
uk
biblioExample.bib
CMakeLists.txt
Example_%28LyXified%29.lyx
Example_%28raw%29.lyx
Localization_Test.lyx
README.new_examples
Welcome.lyx

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).


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).