lyx_mirror/lib/examples
Scott Kostyshak 357bc2576c Noweb.lyx: correct reference of script
Thanks to Kornel.
2021-06-03 12:41:49 -04:00
..
ar Update documentation 2020-12-29 12:03:05 -05:00
Articles –Stop using \vdag in AASTeX 6.2 example 2021-01-16 20:42:14 +01:00
Books Update documentation 2020-12-29 12:03:05 -05:00
ca Update documentation 2020-12-29 12:03:05 -05:00
cs Update documentation 2020-12-29 12:03:05 -05:00
Curricula_Vitae Update documentation 2020-12-29 12:03:05 -05:00
da Update documentation 2020-12-29 12:03:05 -05:00
de Update documentation 2020-12-29 12:03:05 -05:00
el Update documentation 2020-12-29 12:03:05 -05:00
es Update documentation 2020-12-29 12:03:05 -05:00
eu Update documentation 2020-12-29 12:03:05 -05:00
External_Material Update documentation 2020-12-29 12:03:05 -05:00
fa Update documentation 2020-12-29 12:03:05 -05:00
fr Update documentation 2020-12-29 12:03:05 -05:00
gl Update documentation 2020-12-29 12:03:05 -05:00
Graphics_and_Insets Instant_Preview.lyx: document ps2pdf flag 2021-05-29 22:22:45 -04:00
Handouts Update documentation 2020-12-29 12:03:05 -05:00
he Update documentation 2020-12-29 12:03:05 -05:00
hu Update documentation 2020-12-29 12:03:05 -05:00
id Update documentation 2020-12-29 12:03:05 -05:00
it Update documentation 2020-12-29 12:03:05 -05:00
ja Update documentation 2020-12-29 12:03:05 -05:00
ko Update documentation 2020-12-29 12:03:05 -05:00
Letters Update documentation 2020-12-29 12:03:05 -05:00
lt Update documentation 2020-12-29 12:03:05 -05:00
Modules Noweb.lyx: correct reference of script 2021-06-03 12:41:49 -04:00
nb Update documentation 2020-12-29 12:03:05 -05:00
nl Update documentation 2020-12-29 12:03:05 -05:00
pl Update documentation 2020-12-29 12:03:05 -05:00
Posters Update documentation 2020-12-29 12:03:05 -05:00
Presentations Update documentation 2020-12-29 12:03:05 -05:00
pt_BR Update documentation 2020-12-29 12:03:05 -05:00
pt_PT Update documentation 2020-12-29 12:03:05 -05:00
ro Update documentation 2020-12-29 12:03:05 -05:00
ru Update Russian localization 2021-02-26 23:56:51 +02:00
Scripts Update documentation 2020-12-29 12:03:05 -05:00
sk Update documentation 2020-12-29 12:03:05 -05:00
sl Update documentation 2020-12-29 12:03:05 -05:00
sr Update documentation 2020-12-29 12:03:05 -05:00
sv Update documentation 2020-12-29 12:03:05 -05:00
uk Update documentation 2020-12-29 12:03:05 -05:00
biblioExample.bib - moderncv.layout: add missing separator style 2012-01-21 12:05:07 +00:00
CMakeLists.txt Replace unnecessary ampersand in folder name 2019-03-22 09:38:05 +01:00
Example_%28LyXified%29.lyx Update documentation 2020-12-29 12:03:05 -05:00
Example_%28raw%29.lyx Update documentation 2020-12-29 12:03:05 -05:00
Localization_Test.lyx Update documentation 2020-12-29 12:03:05 -05:00
README.new_examples remove buildlyxdir again 2019-03-25 16:46:04 +01:00
Welcome.lyx Update documentation 2020-12-29 12:03:05 -05:00

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