On 2017-04-11, Guenter Milde wrote:
> On 2017-04-06, Scott Kostyshak wrote:

>> There is a proposal to reorganize templates and examples folders. If we
>> do want to do it, I think that soon would be a good time.

>> To take a look at the proposal, check out:

>>   http://www.lyx.org/trac/ticket/8715

> Several points:

> * The OP seems to miss the [examples] button in the File>Open dialogue.

The proeblem is, this button is only present in Linux:

UserGuide.lyx:

  Example files This directory will be opened when you use the button
                Examples in the File->Open dialog.

                Note: The Examples button does not exist when using LyX
                on Mac OS and Windows systems.

Customization.lyx: misses this bit and is vague about the dialogue:

  examples/ contains example files that explain how to use some
            features. In the file browser, press the Examples button to
            get there.

TODO: fix the Customization guide (may wait until we get a consensus on
what to do with the examples).

In comment #1, Jürgen says:

   I do not like the mixing of templates and examples, which serve a very
   different purpose.

Generally, I agree:

Templates:
  provide a starting point for documents,
  store settings for a class of documents.
  https://en.wikipedia.org/wiki/Template_%28word_processing%29

   Templates should leave out irrelevant settings to be
   filled with user defaults.

   --- Customization, 5.2.4 Creating templates


Examples:
  document a LyX feature, layout, or module.


OTOH,

* In LyX, there is no special template file type, every LyX document can
  serve as a template, just open it via File>New from template.

* Also templates can be considered part of the documentation:

   A template acts as a kind of tutorial for your layout, showing how it
   might be used, though containing dummy content.

   --- Customization, 5.2.4 Creating templates

* Examples may serve as templates (especially if there is no on-purpose
  template for a special document class).


Hence we should not merge templates and examples but it makes sense to
have them not too far in the File>New from template dialogue.


Suggestion:

* move examples to lib/doc/examples,
* create (and use) language subdirectories,
* add a menu entry Help>Examples...

* create a symlink SYSDIR/templates/examples -> SYSDIR/doc/examples,
* create a symlink SYSDIR/templates/my_templates -> USERDIR/templates
  (alternatively, set USERDIR/templates as default templates path and
  create a symlink to SYSDIR/templates there),
* create (and use) language subdirectories for templates, too.

* Document the [templates] box in the File>Save as dialogue in the user Guide
  as an easy option to create local templates.


Günter

Reply via email to