lyx_mirror/lib/examples
Scott Kostyshak 1aa4987b2f Address failures of Seminar examples on new TL20
Compilation of our Seminar example file fails on updated TL20. The
maintainer of "Seminar" is not planning to fix the core issue and
states the following (in a private email with permission to quote):

  it is a problem with the new hook management of the current latex.ltx
  seminar is a quite old package and there is no reason to use it with a
  new LaTeX format. It won't be fixed, so the usual way is to use the
  package latexrealease to get the old hook management.

This commit adds a note to the example files explaining the
workaround of exporting to a .tex file and prepending the following
line:

  \RequirePackage[2020-02-02]{latexrelease}

We now invert the relevant tests.
2020-10-29 23:29:26 -04:00
..
ar Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
Articles Remove old example, as its mechanisms are now deprecated. 2020-07-02 15:27:20 +02:00
Books Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
ca Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
cs Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
Curricula_Vitae Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
da Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
de de/Linguistics: another typo 2019-06-24 13:49:30 +02:00
el Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
es Set inputenc for Spanish documentation to utf8 2019-04-20 21:39:49 +02:00
eu Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
External_Material Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
fa remove buildlyxdir again 2019-03-25 16:46:04 +01:00
fr Address failures of Seminar examples on new TL20 2020-10-29 23:29:26 -04:00
gl Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
Graphics_and_Insets Minor fixes to XY-Pic.lyx 2020-08-05 18:48:36 +02:00
Handouts Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
he Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
hu Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
id Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
it Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02: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 Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
Modules Fancy_Colored_Boxes.lyx: add section about references 2019-07-21 01:27:43 +02:00
nb Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
nl Dutch doc updates by Niko 2019-07-06 15:49:16 +02:00
pl Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
Posters Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
Presentations Address failures of Seminar examples on new TL20 2020-10-29 23:29:26 -04:00
pt_BR Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
pt_PT Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
ro Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
ru Update Russian localization 2020-09-17 07:21:02 +02:00
Scripts Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
sk Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
sl Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
sr Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
sv Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01:00
uk Fix #10600: XeTeX with 8-bit TeX fonts requires input encodings "utf8" or "ascii". 2019-04-03 15:32:44 +02: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 Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
Example_%28raw%29.lyx Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
Localization_Test.lyx Use utf8 as inputenc for documentation, examples, and templates. 2019-05-08 21:29:01 +02:00
README.new_examples remove buildlyxdir again 2019-03-25 16:46:04 +01:00
Welcome.lyx Use LaTeX input encoding "utf8", part 1/many. 2019-03-27 16:24:14 +01: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).