X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fexamples%2Fdocbook_article.lyx;h=76cd13b0da8e78d480245f28d03313c0f25f0ec2;hb=f36359c7f1abd15d0ca86667ff0adfae050832ed;hp=2699fcee8ff4cc0e6c55e3cd49ee92f9dff51f4f;hpb=970386d4a80f1949bcaa1817eaa9c9617a469521;p=lyx.git
diff --git a/lib/examples/docbook_article.lyx b/lib/examples/docbook_article.lyx
index 2699fcee8f..76cd13b0da 100644
--- a/lib/examples/docbook_article.lyx
+++ b/lib/examples/docbook_article.lyx
@@ -1,250 +1,261 @@
-#LyX 1.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 221
+#LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
+\lyxformat 252
+\begin_document
+\begin_header
\textclass docbook
\language english
\inputencoding default
-\fontscheme default
+\font_roman default
+\font_sans default
+\font_typewriter default
+\font_default_family default
+\font_sc false
+\font_osf false
+\font_sf_scale 100
+\font_tt_scale 100
\graphics default
\paperfontsize default
\spacing single
-\papersize Default
-\paperpackage a4
-\use_geometry 0
+\papersize default
+\use_geometry false
\use_amsmath 0
-\use_natbib 0
-\use_numerical_citations 0
+\cite_engine basic
+\use_bibtopic false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
-\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle default
+\tracking_changes false
+\output_changes true
+\author "Jose' Matos"
+\end_header
-\layout SGML
+\begin_body
-
-\begin_inset Note
-collapsed true
-
-\layout Standard
-
-Here goes the information about the article:
-\layout Standard
-
-* title
-\layout Standard
-
-* date
-\layout Standard
-
-* author
-\layout Standard
-
-+ first name
-\layout Standard
-
-+ last name
-\layout Standard
-
-* abstract
-\end_inset
-
-
-\layout Title
-\added_space_top vfill \added_space_bottom vfill
+\begin_layout Title
Docbook with LyX
-\layout Date
+\end_layout
+\begin_layout Date
24 September 1999
-\layout Author
-
-\begin_deeper
-\layout SGML
-\align center
-
-\size normal
+\end_layout
-\begin_inset Note
-collapsed true
+\begin_layout Author
+\begin_inset CharStyle Firstname
+show_label true
+status inlined
-\layout Standard
+\begin_layout Standard
+José
+\end_layout
-The author name is always composed of:
-\layout Standard
+\end_inset
-* first name
-\layout Standard
-* surname
-\layout Standard
-
-It is always possible to have more than one author.
-\end_inset
+\begin_inset CharStyle Surname
+show_label true
+status inlined
+\begin_layout Standard
+Matos
+\end_layout
-\layout FirstName
+\end_inset
-Jose'
-\layout Surname
-Matos
-\end_deeper
-\layout Abstract
+\end_layout
+\begin_layout Abstract
This is a small illustration of lyx's features using DocBook.
-\layout Abstract
+\end_layout
+\begin_layout Abstract
The abstract can span several paragraphs.
-\layout Section
-
+\end_layout
-\begin_inset LatexCommand \label{first-section}
+\begin_layout Section
+\begin_inset LatexCommand label
+name "first-section"
-\end_inset
+\end_inset
Introduction
-\layout Standard
+\end_layout
+\begin_layout Standard
This file ilustrates the generation of docbook documents with LyX.
-\layout Standard
+\end_layout
+\begin_layout Standard
This will improve as soon as new features are available.
-\layout Section
+\end_layout
+\begin_layout Section
Standard layouts
-\layout Standard
+\end_layout
+\begin_layout Standard
One of the goals is the support, as much as possible, of layouts used in
other textclass, for compatibility purposes.
-\layout Standard
+\end_layout
+\begin_layout Standard
Remember that this is work in progress, I would like to hear any comments,
good or
\begin_inset Quotes eld
-\end_inset
+\end_inset
bad
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Lists
-\layout Standard
+\end_layout
+\begin_layout Standard
This is an example with several nested lists.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
item 1
-\begin_deeper
-\layout Enumerate
+\end_layout
+\begin_deeper
+\begin_layout Enumerate
item 2
-\layout Description
+\end_layout
+\begin_layout Description
new item
-\begin_deeper
-\layout Enumerate
+\end_layout
+\begin_deeper
+\begin_layout Enumerate
collection
-\end_deeper
-\end_deeper
-\layout Itemize
+\end_layout
+\end_deeper
+\end_deeper
+\begin_layout Itemize
new set
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Code
-\layout Standard
+\end_layout
+\begin_layout Standard
Required steps to have a running lyx.
-\layout Quotation
+\end_layout
+\begin_layout Quotation
Be carefull with your own code.
-\layout Quotation
+\end_layout
+\begin_layout Quotation
The debugger.
-\layout Code
+\end_layout
+\begin_layout Code
cat > env.out
-\layout Code
+\end_layout
+\begin_layout Code
tar xvzf lyx.tgz
-\layout Code
+\end_layout
+\begin_layout Code
cd lyx-1_0_x
-\layout Code
+\end_layout
+\begin_layout Code
./configure
-\layout Code
+\end_layout
+\begin_layout Code
make
-\layout Code
+\end_layout
+\begin_layout Code
make install
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Labels
-\layout Standard
+\end_layout
+\begin_layout Standard
If a label is the first element in any layout, that label will be merged
with that element.
See as an example
-\begin_inset LatexCommand \ref[first-section]{first-section}
+\begin_inset LatexCommand ref
+name "first-section"
+reference "first-section"
-\end_inset
+\end_inset
.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Fonts
-\layout Standard
+\end_layout
+\begin_layout Standard
The only fonts supported are
-\emph on
+\emph on
Emphasis
-\emph default
+\emph default
and
-\begin_inset ERT
-status Collapsed
+\begin_inset CharStyle Literal
+show_label true
+status inlined
-\layout Standard
-SGML
-\end_inset
+\begin_layout Standard
+SGML
+\end_layout
+
+\end_inset
.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Figures
-\layout Standard
+\end_layout
+\begin_layout Standard
One of the major changes in the docbook when compared with the linuxdoc
support are the figures support.
LyX only allows to view eps figures.
So you should have one of these if you want to take advantage of this feature.
-\layout Standard
+\end_layout
+\begin_layout Standard
Notice that when the docbook code is exported the filename extension is
stripped.
This enables that when the several backends are processed in sgmltools,
the corresponding extensions are added.
The default extension are eps for the print and gif for the html backend.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset Float figure
placement htbp
wide false
-collapsed false
-
-\layout Standard
-
+sideways false
+status open
+\begin_layout Standard
\begin_inset Graphics
filename ../doc/platypus.eps
display grayscale
@@ -252,29 +263,33 @@ collapsed false
height 3cm
rotateAngle 45
rotateOrigin center
-\end_inset
+
+\end_inset
-\layout Caption
+\end_layout
+\begin_layout Caption
Nice platypus
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
Wide figures are treated as normal figures.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset Float figure
placement htbp
wide true
-collapsed false
-
-\layout Standard
-
+sideways false
+status open
+\begin_layout Standard
\begin_inset Graphics
filename ../doc/platypus.eps
display grayscale
@@ -282,31 +297,37 @@ collapsed false
height 3cm
rotateAngle 45
rotateOrigin center
-\end_inset
+
+\end_inset
-\layout Caption
+\end_layout
+\begin_layout Caption
long, very long...
:-)
-\end_inset
+\end_layout
+\end_inset
-\layout Subsection
+\end_layout
+
+\begin_layout Subsection
Tables
-\layout Standard
+\end_layout
+\begin_layout Standard
There is also basic support for tables.
\begin_inset Float table
placement htbp
wide false
-collapsed false
-
-\layout Standard
-\added_space_top 0.3cm \added_space_bottom 0.3cm \align center
+sideways false
+status open
-\begin_inset Tabular
+\begin_layout Standard
+\align center
+\begin_inset Tabular
@@ -318,273 +339,351 @@ collapsed false
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
Software 1
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
Software 2
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
Software 3
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
Software 4
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
Plataform 1
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
25 MB
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
10 MB
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
34 MB
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
+\begin_layout Standard
+
+\end_layout
-\end_inset
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
Plataform 2
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
12 MB
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
30 MB
-\end_inset
+\end_layout
+
+\end_inset
|
\begin_inset Text
-\layout Standard
-
+\begin_layout Standard
35 MB
-\end_inset
+\end_layout
+
+\end_inset
|
-\end_inset
+\end_inset
-\layout Caption
+\end_layout
+\begin_layout Caption
Nice Formal Table
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
As it happens with the figures the wide tables are treated as normal tables.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Margins
-\layout Standard
+\end_layout
+\begin_layout Standard
There are some restrictions when using margins.
For further information on docbook allowed syntax consult the
-\begin_inset LatexCommand \url[docbook reference manual]{http://www.oasis-open.org/docbook/documentation/reference/}
+\begin_inset LatexCommand url
+name "docbook reference manual"
+target "http://www.oasis-open.org/docbook/documentation/reference/"
-\end_inset
+\end_inset
.
-\layout Quotation
+\end_layout
+\begin_layout Quotation
It is also possible to insert margin notes inside some environments.
-\begin_deeper
-\layout SGML
+\end_layout
+\begin_deeper
+\begin_layout Standard
+\begin_inset ERT
+status inlined
-\begin_inset Marginal
-collapsed true
+\begin_layout Standard
-\layout Standard
+\begin_inset Marginal
+status collapsed
+\begin_layout Standard
margin note
-\layout Standard
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
second par -> margin note
-\layout Standard
+\end_layout
+
+\begin_layout Standard
third par -> margin note
-\end_inset
+\end_layout
+
+\end_inset
-\end_deeper
-\layout Quotation
+\end_layout
+\end_deeper
+\begin_layout Quotation
Notice that the previous layout is at level 1
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
This comes from a docbook restriction.
Sidebar can only appear inside "MSGTEXT", "CAUTION", "IMPORTANT", "NOTE",
"TIP", "WARNING", "BLOCKQUOTE".
-\layout Standard
+\end_layout
+\begin_layout Standard
These environments are easily added to the docbook layout.
-\end_inset
+\end_layout
+
+\end_inset
and so is the follow:
-\begin_deeper
-\layout SGML
+\end_layout
+\begin_deeper
+\begin_layout Standard
+\begin_inset ERT
+status inlined
-\begin_inset Marginal
-collapsed true
+\begin_layout Standard
-\layout Standard
+\begin_inset Marginal
+status collapsed
+\begin_layout Standard
too marginal ;-)
-\end_inset
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
-\end_deeper
-\layout Section
+\end_layout
+\end_deeper
+\begin_layout Section
The road map
-\layout Standard
+\end_layout
+\begin_layout Standard
This is a small list of the remaining tasks:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Expand the number of layouts
-\begin_deeper
-\layout Itemize
+\end_layout
+\begin_deeper
+\begin_layout Itemize
example
-\layout Itemize
+\end_layout
+\begin_layout Itemize
note
-\layout Itemize
+\end_layout
+\begin_layout Itemize
warning
-\layout Itemize
+\end_layout
+\begin_layout Itemize
tip
-\layout Itemize
+\end_layout
+\begin_layout Itemize
caution
-\layout Itemize
+\end_layout
+\begin_layout Itemize
important
-\end_deeper
-\layout Itemize
+\end_layout
+\end_deeper
+\begin_layout Itemize
Compose other layout files, besides article
-\begin_deeper
-\layout Enumerate
+\end_layout
+\begin_deeper
+\begin_layout Enumerate
book
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
set (very unlikely)
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
I do not expect lyx to deal with colection of books, for now!
-\end_inset
+\end_layout
+\end_inset
-\layout Enumerate
+\end_layout
+
+\begin_layout Enumerate
refentry
-\end_deeper
-\layout Itemize
+\end_layout
+\end_deeper
+\begin_layout Itemize
goodies
-\begin_deeper
-\layout Enumerate
+\end_layout
+\begin_deeper
+\begin_layout Enumerate
including other lyx files
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
more advanced tables support
-\end_deeper
-\layout Itemize
+\end_layout
+\end_deeper
+\begin_layout Itemize
better documentation
-\layout Standard
+\end_layout
+\begin_layout Standard
That's all.
;-)
-\the_end
+\end_layout
+
+\end_body
+\end_document