lyx_mirror/lib/examples
2023-09-01 20:51:27 +02:00
..
ar Update doc format 2022-12-25 12:48:19 -05:00
Articles Update doc format 2022-12-25 12:48:19 -05:00
Books Fix "origin" in KOMA-Script_Book.lyx 2023-01-05 16:24:00 +01:00
ca * ca/es Welcome.lyx updates by Dan. 2023-08-22 21:55:48 +02:00
cs Update doc format 2022-12-25 12:48:19 -05:00
Curricula_Vitae Update doc format 2022-12-25 12:48:19 -05:00
da Update doc format 2022-12-25 12:48:19 -05:00
de Current covington requires varwidth 2023-07-21 14:34:22 +02:00
el Update doc format 2022-12-25 12:48:19 -05:00
es * es Welcome.lyx from Daniel 2023-09-01 20:51:27 +02:00
eu Update doc format 2022-12-25 12:48:19 -05:00
External_Material Update doc format 2022-12-25 12:48:19 -05:00
fa Update doc format 2022-12-25 12:48:19 -05:00
fr Update doc format 2022-12-25 12:48:19 -05:00
gl Update doc format 2022-12-25 12:48:19 -05:00
Graphics_and_Insets Update doc format 2022-12-25 12:48:19 -05:00
Handouts Update doc format 2022-12-25 12:48:19 -05:00
he Update doc format 2022-12-25 12:48:19 -05:00
hu Update doc format 2022-12-25 12:48:19 -05:00
id Update doc format 2022-12-25 12:48:19 -05:00
it Update doc format 2022-12-25 12:48:19 -05:00
ja Move some example files to proper location 2023-02-10 16:24:10 +01:00
ko Fix moved examples's \origin 2023-02-10 16:31:33 +01:00
Language_Support Fix moved examples's \origin 2023-02-10 16:31:33 +01:00
Letters Update doc format 2022-12-25 12:48:19 -05:00
lt Update doc format 2022-12-25 12:48:19 -05:00
Modules Current covington requires varwidth 2023-07-21 14:34:22 +02:00
nb Update doc format 2022-12-25 12:48:19 -05:00
nl Update doc format 2022-12-25 12:48:19 -05:00
pl Update doc format 2022-12-25 12:48:19 -05:00
Posters Update doc format 2022-12-25 12:48:19 -05:00
Presentations Update doc format 2022-12-25 12:48:19 -05:00
pt_BR Update doc format 2022-12-25 12:48:19 -05:00
pt_PT Update doc format 2022-12-25 12:48:19 -05:00
ro Update doc format 2022-12-25 12:48:19 -05:00
ru Update doc format 2022-12-25 12:48:19 -05:00
Scripts Update doc format 2022-12-25 12:48:19 -05:00
sk Update doc format 2022-12-25 12:48:19 -05:00
sl Update doc format 2022-12-25 12:48:19 -05:00
sr Update doc format 2022-12-25 12:48:19 -05:00
sv Update doc format 2022-12-25 12:48:19 -05:00
uk Update doc format 2022-12-25 12:48:19 -05:00
biblioExample.bib
CMakeLists.txt Replace unnecessary ampersand in folder name 2019-03-22 09:38:05 +01:00
Example_%28LyXified%29.lyx Update doc format 2022-12-25 12:48:19 -05:00
Example_%28raw%29.lyx Update doc format 2022-12-25 12:48:19 -05:00
README.new_examples Move some example files to proper location 2023-02-10 16:24:10 +01:00
Welcome.lyx * Welcome.lyx - few small fixes by Dan. 2023-08-22 21:50:46 +02: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).

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