lyx_mirror/lib/doc
2007-12-16 11:34:29 +00:00
..
biblio UserGuide.lyx updates: - Finish the descriptions of the bibliography and the document settings dialog 2007-08-11 01:20:33 +00:00
clipart lib/doc/clipart: Add two new images for the Userguide 2007-08-13 01:35:48 +00:00
cs In last commit I wrote: 2007-09-28 01:02:12 +00:00
da Update documentation to latest file format (for 1.5.0 release) 2007-07-24 17:39:27 +00:00
de French Tutorial.lyx: updates by Siegfried 2007-11-23 00:06:27 +00:00
es EmbeddedObjects.lyx: add info about dissolving notes 2007-11-22 23:53:02 +00:00
eu all UserGuides: fix the broken character "DOTTLESS J WITH HAT", according to r20730 2007-10-06 17:05:17 +00:00
fr French Intro.lyx: updates by Jean-Pierre Chretien 2007-12-13 01:39:33 +00:00
gl xpm -> png 2007-08-30 20:09:12 +00:00
he In last commit I wrote: 2007-09-28 01:02:12 +00:00
hu Hungarian translation updates by Szöke 2007-10-03 21:14:22 +00:00
it Italian UserGuide.lyx: revert wrong translation in last commit 2007-10-06 17:12:33 +00:00
nb Update documentation to latest file format (for 1.5.0 release) 2007-07-24 17:39:27 +00:00
nl In last commit I wrote: 2007-09-28 01:02:12 +00:00
pl Extended manual: fix description of tex2lyx 2007-09-29 12:42:32 +00:00
pt In last commit I wrote: 2007-09-28 01:02:12 +00:00
ro Update documentation to latest file format (for 1.5.0 release) 2007-07-24 17:39:27 +00:00
ru In last commit I wrote: 2007-09-28 01:02:12 +00:00
sk In last commit I wrote: 2007-09-28 01:02:12 +00:00
sl In last commit I wrote: 2007-09-28 01:02:12 +00:00
sv In last commit I wrote: 2007-09-28 01:02:12 +00:00
Customization.lyx remove the manifest section from two doc files 2007-11-01 16:50:51 +00:00
depend.py doc_toc.py: add comment to explain its calling syntax (fixes bug 3798 2007-07-18 19:45:11 +00:00
doc_toc.py Further cleanup, remove encoding since we now use utf-8 for all languages 2007-09-11 09:43:44 +00:00
DocStyle.lyx Update documentation to latest file format (for 1.5.0 release) 2007-07-24 17:39:27 +00:00
DummyDocument1.lyx documentation: apply the last cleanups also to the other languages 2007-08-14 23:09:56 +00:00
DummyDocument2.lyx documentation: apply the last cleanups also to the other languages 2007-08-14 23:09:56 +00:00
DummyTextDocument.txt EmbeddedObjects.lyx: 2007-03-18 03:27:19 +00:00
EmbeddedObjects.lyx EmbeddedObjects.lyx: add info about dissolving notes 2007-11-22 23:53:02 +00:00
Extended.lyx Extended.lyx: remove some Linux-only path descriptions 2007-10-30 21:26:01 +00:00
FAQ.lyx Update documentation to latest file format (for 1.5.0 release) 2007-07-24 17:39:27 +00:00
Intro.lyx Tutorial.lyx: revise the last missing chapter 4 2007-12-14 01:25:29 +00:00
LaTeXConfig.lyx LaTeXConfig.lyx: additions for the Japanese layout files 2007-11-04 00:38:12 +00:00
Makefile.am * lib/doc/Makefile.am: 2007-12-12 09:39:08 +00:00
Makefile.depend big French manual update: 2007-11-12 22:34:10 +00:00
README.Documentation add missing doc files and update makefile 2004-06-02 13:40:06 +00:00
Reference.lyx Update documentation to latest file format (for 1.5.0 release) 2007-07-24 17:39:27 +00:00
Shortcuts.lyx remove the manifest section from two doc files 2007-11-01 16:50:51 +00:00
Tutorial.lyx Tutorial.lyx: revise the last missing chapter 4 2007-12-14 01:25:29 +00:00
UserGuide.lyx Sanitize the way we use abort() and exit(). With this commit, we should never crash in release mode, even when assertions are enabled. In debug mode, we crash with abort in order to get a useful backtrace. 2007-12-16 11:34:29 +00:00

README.Documentation

by John Weiss [3/2000] jpweiss@idsi.net


================
Introduction

    The purpose of this file is *used* *to* *be* to provide a style
    sheet and helpful hints to those wishing to help with the
    LyX Documentation Project.  There's now a separate style-sheet for
    that.

    If you're actually looking for documentation, check out the "Help"
    menu.  Start by reading the Introduction.

================
Why a separate documentation project?  Can't the developers do it?

    In a word, no.  They're too busy adding features and squishing
    bugs.

    Also, g++ is far more forgiving of style changes than a human
    brain.  As long as the code is correct, g++ will happilly compile
    it, and compile it the same way from machine to machine.  Human
    brains are far less forgiving and far more individualized.  So,
    the documentation needs to all be in a uniform style, in addition
    to being grammatically correct and easily readable.  That's a
    pretty big undertaking - which is why I volunteered to
    administrate the docs back in 1997.  Since then, I've passed the
    duty of maintaining the docs on to others.

================
Helping Out

    If you'd like to contribute to the LyX Documentation Project,
    start by reading the file Intro.lyx.  It contains a description of
    the style of the documentation from a reader's perspective.  After
    that, read the LyX Documentation Style Sheet (DocStyle.lyx) and
    commit it to memory!


John Weiss
March, 2000