LyX wiki | DevelDoc / Development of LyX documentation

<< | Page list | >>

Development of LyX documentation.

This group of wiki pages is dedicated to help with the development of LyX documentation, e.g. discussing it's structure and contents.

Table of contents (hide)

1. Tips, important links and InterMap prefixes
2. Pages related to the LyX documentation project

Start by reading DocStyle.lyx. It comes as part of LyX, in the same directory as all of the other documentation. For your convenience, here is an uploaded PDF-version (2005-01-17) and a link to the latest LyX version in the repository,

Here is ??? <what's missing here?>

After the second version of the offical LyX Documentation Style Sheet grew uncomfortably large, the LyX DocTeam decided it needed to lose some excess weight. It seems the Style Sheet began to specify too many special cases, too many points of clarification. On the other hand, contributors to the documents were discovering many creative ways of misinterpreting the Style Sheet specifications. Therefore:

If you have any questions about anything in the Style Sheet, ask first, write second!

Field all questions to the LyX Developer's Mailing List. There are seasoned DocTeam members who can answer your questions. If you have any problems with the Style Sheet itself, also contact the mailing list.

See contributing for the basic "README"-version of getting started contributing to the LyX Documentation Project.

See DocumentFormat for notes on the desired style of the documentation.

Quote from JMarc ?:

Never forget that the primary goal of the user guide is to be usable, and that everybody can just print it without tinkering.

1. Tips, important links and InterMap prefixes

On wiki pages, you can link to a document in the version control system (VCS) with the prefix LyXDoc:, e.g. LyXDoc:UserGuide.lyx.
To link to raw file in the VCS, use the prefix LyXDocRaw:, e.g. LyXDocRaw:UserGuide.lyx

2. Pages related to the LyX documentation project

(Maybe move this to page list or pages ??)

DevelDoc: "Home page" of the wiki group for development of LyX documentation.
Documents: This page (intends to) lists the various documentation of the LyX project. Also see the page what goes where.
User guide ?: Working with the UserGuide
Document format ?: About the general format for the documentation
Page list
Contributing: Contributing to the LyX Documentation Project: A README
What Goes Where: Describes what content go to what documentation (also see documents)
The LyXDoc StyleSheet: The general style of the content of the docs. (As opposed to typographic & notation conventions.)
AboutTheFAQ: About the FAQ

Category: Development, Documentation