documentation: remove linuxdoc descriptions (part1), fixes bug 2787 http://bugzilla.lyx.org/show_bug.cgi?id=2787

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19123 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Uwe Stöhr 2007-07-18 23:24:33 +00:00
parent e7fffdc821
commit 82d2a827b5
9 changed files with 42 additions and 1978 deletions

View File

@ -1,5 +1,5 @@
#LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
\lyxformat 274
\lyxformat 276
\begin_document
\begin_header
\textclass book
@ -39,9 +39,10 @@
\paperpagestyle headings
\tracking_changes false
\output_changes false
\author "Richard Heck"
\author "Jean-Marc Lasgouttes"
\author "usti"
\author ""
\author ""
\author ""
\author ""
\end_header
\begin_body
@ -5967,7 +5968,7 @@ DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
\begin_layout Standard
This indicates that your text class uses the foo.sty package.
Finally, it is also possible to declare classes for SGML and DocBook code.
Finally, it is also possible to declare classes for DocBook code.
Typical declarations will look like
\end_layout
@ -5982,20 +5983,6 @@ This indicates that your text class uses the foo.sty package.
\size small
#
\backslash
DeclareSGMLClass{SGML (LinuxDoc)}
\end_layout
\begin_layout Standard
or
\end_layout
\begin_layout LyX-Code
#% Do not delete the line below; configure depends on this
\end_layout
\begin_layout LyX-Code
#
\backslash
DeclareDocBookClass[article]{SGML (DocBook article)}
\end_layout
@ -9472,10 +9459,6 @@ ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
FormatEnd
\end_layout
\begin_layout LyX-Code
Format LinuxDoc
\end_layout
\begin_layout LyX-Code
Product "[XFig: $$FName]"
\end_layout
@ -9666,7 +9649,7 @@ The Format section
\family typewriter
\series medium
Format\InsetSpace ~
LaTeX|PDFLaTeX|PlainText|DocBook|LinuxDoc
LaTeX|PDFLaTeX|PlainText|DocBook
\family default
\series default
The primary document file format that this format definition is for.
@ -9676,8 +9659,7 @@ LaTeX|PDFLaTeX|PlainText|DocBook|LinuxDoc
Format
\family default
section for all formats.
Use a dummy text when no representation is available (see the LinuxDoc
format in the example above).
Use a dummy text when no representation is available.
Then you can at least see a reference to the external material in the exported
document.
\end_layout

View File

@ -26886,20 +26886,8 @@ The option
Generate\InsetSpace ~
hyperlink
\family default
in the URL dialog has only an affect when you export your document to the
format
\begin_inset Quotes eld
\end_inset
\family sans
LinuxDoc
\family default
\begin_inset Quotes erd
\end_inset
.
in the URL dialog does nothing.
This relict will be removed in the next LyX-version.
\end_layout
\begin_layout Standard

View File

@ -1,5 +1,5 @@
#LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
\lyxformat 274
\lyxformat 276
\begin_document
\begin_header
\textclass book
@ -37,7 +37,8 @@
\paperpagestyle headings
\tracking_changes false
\output_changes false
\author "usti"
\author ""
\author ""
\end_header
\begin_body
@ -15403,675 +15404,6 @@ custom_export_command "mycommand $$FName"
LyX Features needing Extra Software
\end_layout
\begin_layout Section
Using LyX with SGML-Tools (aka LinuxDoc)
\end_layout
\begin_layout Standard
by
\noun on
Paul Evans
\end_layout
\begin_layout Subsection
Overview
\end_layout
\begin_layout Standard
LinuxDoc is a document class available in LyX if you have the
\family typewriter
sgml-tools
\family default
package installed.
You can use it to produce documents in the so-called Standardized General
Mark-up Language (SGML) in the particular format used by the Linux Documentatio
n Project.
That is obviously helpful if you are contributing to that project.
You can use the SGML format with the
\family typewriter
sgml-tools
\family default
package of scripts and programs (to produce other formats, including LaTeX,
HTML, plain text, man pages and\SpecialChar \ldots{}
).
You may therefore prefer to use this document class if you want to write
something that can be easily translated into other formats.
\end_layout
\begin_layout Standard
You will find that LinuxDoc has fewer layout options than the other text
classes in LyX.
This is mainly so that the translations into other formats have a chance
of making some sense.
In this section we describe:
\end_layout
\begin_layout Itemize
how to setup and use a document in LinuxDoc
\end_layout
\begin_layout Itemize
how to use the tags in LinuxDoc to layout your document
\end_layout
\begin_layout Itemize
how to use the SGML packages to produce the various formats
\end_layout
\begin_layout Itemize
how to sort out some problems.
\end_layout
\begin_layout Subsection
Preparing and using a LinuxDoc document
\end_layout
\begin_layout Subsubsection
Getting started
\end_layout
\begin_layout Standard
You start by selecting the LinuxDoc class using the
\family sans
\bar under
D
\bar default
ocument\SpecialChar \menuseparator
\bar under
S
\bar default
ettings
\family default
dialog.
Then you will find that there are fewer paragraph environments than for
most other classes.
You can see them on the pull down box on the left of the tool bar.
How to use them is described in section\InsetSpace ~
\begin_inset LatexCommand ref
reference "sec:sgmlparas"
\end_inset
.
\end_layout
\begin_layout Standard
You
\emph on
must
\emph default
enter a title for the document, followed by an author, marking each with
the appropriate paragraph environment.
If you don't do this, you will get errors when you try to print the file.
You can then enter the date and an abstract.
The document proper must start with a Section paragraph environment rather
than any standard layout.
\end_layout
\begin_layout Standard
After that you can prepare a document as usual using the available range
of paragraph environments.
See section\InsetSpace ~
\begin_inset LatexCommand ref
reference "sec:sgmlparas"
\end_inset
for the full list and their uses.
\end_layout
\begin_layout Subsubsection
Output from LinuxDoc
\end_layout
\begin_layout Standard
You can print and save these documents in the normal way.
To use the other features of the SGML package you need to save your document
as LinuxDoc; this is a version in which the document is translated into
the basic sgml tags.
Use
\family sans
\bar under
F
\bar default
ile\SpecialChar \menuseparator
\bar under
E
\bar default
xport\SpecialChar \menuseparator
Linu
\bar under
x
\bar default
Doc.
\family default
You will get a file with the same name and a
\family typewriter
.sgml
\family default
extension rather than a
\family typewriter
.lyx
\family default
extension.
See\InsetSpace ~
\begin_inset LatexCommand ref
reference "sec:sgmloperate"
\end_inset
on how you than make use of this file.
\end_layout
\begin_layout Subsection
Using the paragraph environments in LinuxDoc
\end_layout
\begin_layout Subsubsection
The Structure of a LinuxDoc Document
\end_layout
\begin_layout Standard
There is a formal structure for LinuxDoc which limits how you can place
tags.
There are two parts to all documents:
\end_layout
\begin_layout Description
Header: this is everything up to the first time you insert a Section layout
marker.
It can include title, author, date, abstract and ToC.
You must include the first two.
\end_layout
\begin_layout Description
Body: from the beginning of the first section onwards.
All other tags are allowed.
\end_layout
\begin_layout Subsubsection
The LinuxDoc Paragraph Environments
\end_layout
\begin_layout Standard
\begin_inset LatexCommand label
name "sec:sgmlparas"
\end_inset
Here is a list of all the tags you will find listed on the layout bar in
the order they come there, with some comments where the purpose or use
is not obvious:
\end_layout
\begin_layout Itemize
\family sans
Standard:
\family default
\family roman
works as described in [cross reference]
\end_layout
\begin_layout Itemize
\family sans
Title
\family default
: This will appear at the top left of the document when printed, above a
heavy horizontal rule, although you will not see this on the LyX screen.
\end_layout
\begin_layout Itemize
\family sans
Section, Subsection, Subsubsection, Paragraph and Subparagraph:
\family default
all do what you would expect and in the usual order.
Whether they are numbered or not is controlled by the
\family sans
Section\InsetSpace ~
number\InsetSpace ~
depth
\family default
setting.
You cannot get the equivalent number free versions in any other way; there
is no
\family sans
Section*
\family default
or similar
\end_layout
\begin_layout Itemize
\family sans
Enumerate:
\family default
As usual this produces a numbered and indented list as described in the
\emph on
User's Guide
\emph default
.
\end_layout
\begin_layout Itemize
\family sans
Itemize:
\family default
\family roman
Again much the same as in the other classes: see the
\family default
\family roman
\emph on
User's Guide
\emph default
.
\end_layout
\begin_layout Itemize
\family sans
Description
\family default
: As explained in the
\emph on
User's Guide
\emph default
.
Remember that if you want the bold element at the start of a description
to be more than one word then you need to put protected spaces between
the words.
\end_layout
\begin_layout Itemize
\family sans
Verbatim:
\family default
As usual.
\end_layout
\begin_layout Itemize
\family sans
Code: similar to the LyX-Code
\family default
\family roman
environment
\end_layout
\begin_layout Itemize
\family sans
Author
\family default
: Anything you mark with this will appear on the left of the heading of
the document, under the heavy rule.
\end_layout
\begin_layout Itemize
\family sans
Date:
\family default
Anything you mark with this will appear on the right of the heading under
the rule.
You do not have to make this a date.
Any text can be entered, e.\InsetSpace ~
g.
a version number.
\end_layout
\begin_layout Itemize
\family sans
Abstract
\family default
: You can use this to produce a free standing paragraph after the author
and date, and before the first section.
You are only allowed one such paragraph.
\begin_inset Foot
status collapsed
\begin_layout Standard
\emph on
Author's note.
\emph default
This needs checking ---
\emph on
pe.
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
\family sans
Displaymath
\family default
:
\begin_inset Foot
status collapsed
\begin_layout Standard
\emph on
Author's note:
\emph default
I have not yet checked this ---
\emph on
pe.
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
Other document features
\end_layout
\begin_layout Standard
You can also use the
\family sans
Layout
\family default
menu to set fonts or to emphasis words.
You can also use the table of contents as usual; see the corresponding
section of the
\emph on
User's Guide
\emph default
.
Although you will find some some other features on the menus e.\InsetSpace ~
g.
inserting footnotes.
There is some doubt about whether these will work correctly.
\begin_inset Foot
status collapsed
\begin_layout Standard
\emph on
Author's note:
\emph default
Again still checking to see whether this is my system
\emph on
---pe.
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
Cross references and HTML
\end_layout
\begin_layout Standard
On the
\family sans
Insert
\family default
menu you will find two new options relating to the inclusion of URL addresses.
If you use either option you will find some highlighted TeX code inserted
into your document in three separate blocks with spaces available between.
The blocks will be:
\end_layout
\begin_layout Quote
\family typewriter
\backslash
htmlurl{
\family default
or
\family typewriter
\backslash
url{
\family roman
\hfill
space
\family default
\family typewriter
\hfill
}{
\family roman
\hfill
space
\hfill
\family typewriter
}
\end_layout
\begin_layout Standard
You insert a full HTML tag between the first and second blocks.
This can be
\begin_inset LatexCommand url
target "http://any.address"
\end_inset
or other valid tags such as
\begin_inset LatexCommand url
target "mailto:me@my.address"
\end_inset
\family typewriter
.
\family default
Then y
\family roman
ou
\family default
insert some description between the second and third blocks.
The differences are:
\end_layout
\begin_layout Itemize
\family sans
URL:
\family default
\family roman
both the HTML tag and the description will appear in the document
\end_layout
\begin_layout Itemize
\family sans
HTML\InsetSpace ~
URL:
\family default
\family roman
only the description appears in the printed version
\end_layout
\begin_layout Subsection
Using the LinuxDoc Sgml scripts
\begin_inset Note Note
status collapsed
\begin_layout Standard
This section is completely outdated.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset LatexCommand label
name "sec:sgmloperate"
\end_inset
You can use LinuxDoc as a text class without any additional scripts or programs,
but there is not much point in doing this.
All you will get is a document that looks like a
\emph on
Linux Documentation Project Howto
\family sans
\emph default
.
\family default
To do the document translation you need to get and install the
\family typewriter
sgml-tools-1.0.x.tar.gz
\family default
(with
\begin_inset Formula $x\geq3$
\end_inset
) package from
\family roman
the SGML-Tools WWW Page
\family default
at
\end_layout
\begin_layout LyX-Code
\family roman
\begin_inset LatexCommand url
target "http://pobox.com/~cg/sgmltools"
\end_inset
\family default
\end_layout
\begin_layout Standard
Alternatively, you can go to the
\family typewriter
sunsite
\family default
archive at
\begin_inset Foot
status collapsed
\begin_layout Standard
Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
has not yet been made available at
\family typewriter
sunsite
\family default
.
\end_layout
\end_inset
\end_layout
\begin_layout LyX-Code
\family roman
\begin_inset LatexCommand url
target "ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz"
\end_inset
\end_layout
\begin_layout Standard
\family roman
The
\family default
file
\family typewriter
sgml-tools-1.0.x.tar.gz
\family default
contains everything that you need to write SGML documents and convert them
to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
\end_layout
\begin_layout Standard
This package was renamed from
\family typewriter
linuxdoc-sgml-1.5.tar.gz
\family default
in January 1997.
\end_layout
\begin_layout Standard
Follow the instructions in that package on how to install it and how to
use it.
All this has to be done outside of LyX, before you can use the
\family sans
\bar under
F
\bar default
ile\SpecialChar \menuseparator
\bar under
E
\bar default
xport\SpecialChar \menuseparator
as\InsetSpace ~
LinuxDoc
\family default
\family roman
option.
\end_layout
\begin_layout Subsection
Troubleshooting LinuxDoc
\end_layout
\begin_layout Standard
When you print or preview a LinuxDoc document some checking is done of the
tags before LaTeX is run.
Some errors are trapped here, especially those concerning the structure
of the document.
LyX may produce an error message, but not leave an error box in the document
for you to open.
You may have to look at the files directly to discover what is wrong.
Most problems seem to come from the use of options that are not fully available
in the text class.
\end_layout
\begin_layout Section
Checking TeX
\end_layout

View File

@ -91,10 +91,11 @@
\paperpagestyle default
\tracking_changes false
\output_changes false
\author "Anonymous"
\author "usti"
\author "Bo Peng"
\author "Uwe Stöhr"
\author ""
\author ""
\author ""
\author ""
\author ""
\end_header
\begin_body
@ -3020,18 +3021,6 @@ Foils is used to make transparencies, but is better than
slides
\end_layout
\begin_layout Description
Linuxdoc Used with the SGML-tools package (formerly known as LinuxDoc).
It allows LyX to produce SGML output.
SGML is a markup language and is the predecessor to HTML\SpecialChar \@.
The SGML-tools
package allows you to convert SGML to HTML or to the format used by
\family typewriter
man
\family default
pages.
\end_layout
\begin_layout Description
Paper for use with the
\family typewriter
@ -3100,7 +3089,7 @@ Each class has a default set of options.
\begin_layout Standard
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="10" columns="5">
<lyxtabular version="3" rows="9" columns="5">
<features>
<column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
<column alignment="center" valignment="top" leftline="true" width="0pt">
@ -3559,97 +3548,6 @@ none
\begin_layout Standard
\series medium
\shape up
\size normal
\emph off
\bar no
\noun off
\color none
linuxdoc
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\family sans
\series medium
\shape up
\size normal
\emph off
\bar no
\noun off
\color none
Plain
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\family sans
\series medium
\shape up
\size normal
\emph off
\bar no
\noun off
\color none
One
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\family sans
\series medium
\shape up
\size normal
\emph off
\bar no
\noun off
\color none
One
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\family sans
\series medium
\shape up
\size normal
\emph off
\bar no
\noun off
\color none
Section
\end_layout
\end_inset
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\series medium
\shape up
\size normal
@ -28479,14 +28377,6 @@ nal keyboard maps and customization.
\begin_layout Itemize
\noun on
Pascal André
\noun default
originally documented the LinuxDoc SGML interface.
\end_layout
\begin_layout Itemize
\noun on
Alejandro Aguilar Sierra
\noun default
@ -28615,12 +28505,6 @@ HowDoI-.lyx
[now defunct].
\end_layout
\begin_layout Itemize
Documentation of LinuxDoc in
\family typewriter
UserGuide.lyx
\end_layout
\end_deeper
\begin_layout Itemize

View File

@ -1,5 +1,5 @@
#LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
\lyxformat 265
\lyxformat 276
\begin_document
\begin_header
\textclass scrbook
@ -42,7 +42,8 @@
\paperpagestyle default
\tracking_changes false
\output_changes false
\author "usti"
\author ""
\author ""
\end_header
\begin_body
@ -6461,26 +6462,12 @@ Dadurch wird angezeigt, daß Ihre Klasse auch das Paket
foo.sty
\family default
verwendet.
Schließlich können Sie auch Klassen für SGML oder DocBook festlegen.
Schließlich können Sie auch Klassen für DocBook festlegen.
Eine typische Deklaration sieht so aus:
\end_layout
\begin_layout LyX-Code
\size small
#% Do not delete the line below; configure depends on this
\end_layout
\begin_layout LyX-Code
\size small
#
\backslash
DeclareSGMLClass{SGML (LinuxDoc)}
\end_layout
\begin_layout Standard
oder
\end_layout
\begin_layout LyX-Code

View File

@ -27891,11 +27891,8 @@ Hyperlink
\family sans
erzeugen
\family default
ist dann von Bedeutung, wenn Sie Ihr Dokument als
\family sans
LinuxDoc
\family default
exportieren.
bewirkt nichts.
Dieses Relikt wird mit der nächsten LyX-Version beseitigt.
\end_layout
\begin_layout Standard

File diff suppressed because it is too large Load Diff

View File

@ -96,10 +96,11 @@
\paperpagestyle default
\tracking_changes false
\output_changes false
\author "Anonymous"
\author "Hartmut Haase" hha4491@atomstromfrei.de
\author "Uwe Stöhr"
\author "usti"
\author ""
\author ""
\author ""
\author ""
\author ""
\end_header
\begin_body
@ -3408,7 +3409,7 @@ name "Dokument!-klassen"
\family sans
\begin_inset Tabular
<lyxtabular version="3" rows="9" columns="5">
<lyxtabular version="3" rows="8" columns="5">
<features>
<column alignment="left" valignment="top" leftline="true" rightline="true" width="0pt">
<column alignment="left" valignment="top" leftline="true" width="0pt">
@ -3753,61 +3754,6 @@ Kapitel
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
SGML (Linuxdoc)
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\family sans
plain
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\family sans
Einseitig
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\family sans
1-spaltig
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\family sans
Abschnitt
\end_layout
\end_inset
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
slides (default)
\end_layout
@ -31550,15 +31496,6 @@ Ivan Schreter
\begin_layout Itemize
\noun on
Pascal André
\noun default
schrieb die ursprüngliche Dokumentation der LinuxDoc SGML-Schnitt\SpecialChar \-
stelle.
\end_layout
\begin_layout Itemize
\noun on
Alejandro Aguilar Sierra
\noun default
@ -31679,12 +31616,6 @@ Paul Evans
Ehemaliger Verwalter der FAQ
\end_layout
\begin_layout Itemize
Dokumentation von LinuxDoc im
\emph on
Benutzerhandbuch
\end_layout
\end_deeper
\begin_layout Itemize

View File

@ -203,7 +203,6 @@
\output_changes false
\author ""
\author ""
\author ""
\end_header
\begin_body
@ -27081,20 +27080,10 @@ La opción
Generar\InsetSpace ~
hiperenlace
\family default
en el diálogo URL sólo tiene efecto al exportar el documento al formato
\begin_inset Quotes eld
\end_inset
\family sans
LinuxDoc
\family default
\begin_inset Quotes erd
\end_inset
.
en el diálogo URL
\lang english
does nothing.
This relict will be removed in the next LyX-version.
\end_layout
\begin_layout Standard