lib/examples/docbook_example.lyx

   1 #This file was created by <jamatos> Wed Sep 29 16:07:48 1999
   2 #LyX 1.0 (C) 1995-1999 Matthias Ettrich and the LyX Team
   3 \lyxformat 2.15
   4 \textclass docbook
   5 \language default
   6 \inputencoding default
   7 \fontscheme default
   8 \graphics default
   9 \paperfontsize default
  10 \spacing single
  11 \papersize Default
  12 \paperpackage a4
  13 \use_geometry 0
  14 \use_amsmath 0
  15 \paperorientation portrait
  16 \secnumdepth 3
  17 \tocdepth 3
  18 \paragraph_separation indent
  19 \defskip medskip
  20 \quotes_language english
  21 \quotes_times 2
  22 \papercolumns 1
  23 \papersides 1
  24 \paperpagestyle default
  25
  26 \layout SGML
  27
  28
  29 \begin_inset Info Here goes the information about the article:
  30   * title
  31   * date
  32   * author
  33     + first name
  34     + last name
  35  * abstract
  36 \end_inset
  37
  38
  39 \layout Title
  40 \added_space_top vfill \added_space_bottom vfill
  41 Docbook with LyX
  42 \layout Date
  43
  44 24 September 1999
  45 \layout Author
  46
  47 \begin_deeper
  48 \layout SGML
  49 \align center
  50
  51 \size normal
  52
  53 \begin_inset Info The author name is always composed of:
  54   * first name
  55   * surname
  56
  57 It is always possible to have more than one author.
  58 \end_inset
  59
  60
  61 \layout FirstName
  62
  63
  64 \latex no_latex
  65 Jos
  66 \latex default
  67 e'
  68 \layout Surname
  69
  70
  71 \latex no_latex
  72 Matos
  73 \end_deeper
  74 \layout Abstract
  75
  76 This is a small illustration of lyx's features using DocBook.
  77 \layout Abstract
  78
  79 The abstract can span several paragraphs.
  80 \layout Section
  81
  82
  83 \begin_inset LatexCommand \label{first-section}
  84
  85 \end_inset
  86
  87 Introduction
  88 \layout Standard
  89
  90 This file ilustrates the generation of docbook documents with LyX.
  91 \layout Standard
  92
  93 This will improve as soon as new features are available.
  94 \layout Section
  95
  96 Standard layouts
  97 \layout Standard
  98
  99 One of the goals is the support, as much as possible, of layouts used in
 100  other textclass, for compatibility purposes.
 101 \layout Standard
 102
 103 Remember that this is work in progress, I would like to hear any comments,
 104  good or
 105 \begin_inset Quotes eld
 106 \end_inset
 107
 108 bad
 109 \begin_inset Quotes erd
 110 \end_inset
 111
 112 .
 113 \layout Subsection
 114
 115 Lists
 116 \layout Standard
 117
 118 This is an example with several nested lists.
 119 \layout Itemize
 120
 121 item 1
 122 \begin_deeper
 123 \layout Enumerate
 124
 125 item 2
 126 \layout Description
 127
 128 new item
 129 \begin_deeper
 130 \layout Enumerate
 131
 132 collection
 133 \end_deeper
 134 \end_deeper
 135 \layout Itemize
 136
 137 new set
 138 \layout Subsection
 139
 140 Code
 141 \layout Standard
 142
 143 Required steps to have a running lyx.
 144 \layout Quotation
 145
 146 Be carefull with your own code.
 147 \layout Quotation
 148
 149 The debugger.
 150 \layout Code
 151
 152 cat > env.out
 153 \layout Code
 154
 155 tar xvzf lyx.tgz
 156 \layout Code
 157
 158 cd lyx-1_0_x
 159 \layout Code
 160
 161 ./configure
 162 \layout Code
 163
 164 make
 165 \layout Code
 166
 167 make install
 168 \layout Subsection
 169
 170 Labels
 171 \layout Standard
 172
 173 If a label is the first element in any layout, that label will be merged
 174  with that element.
 175  See as an example
 176 \begin_inset LatexCommand \ref[first-section]{first-section}
 177
 178 \end_inset
 179
 180 .
 181 \layout Subsection
 182
 183 Fonts
 184 \layout Standard
 185
 186 The only fonts supported are
 187 \emph on
 188 Emphasis
 189 \emph default
 190  and
 191 \latex latex
 192 <literal>SGML</literal>
 193 \latex default
 194 .
 195 \layout Subsection
 196
 197 Figures
 198 \layout Standard
 199
 200 One of the major changes in the docbook when compared with the linuxdoc
 201  support are the figures support.
 202  LyX only allows to view eps figures.
 203  So you should have one of these if you want to take advantage of this feature.
 204 \layout Standard
 205
 206 Notice that when the docbook code is exported the filename extension is
 207  stripped.
 208  This enables that when the several backends are processed in sgmltools,
 209  the corresponding extensions are added.
 210  The default extension are eps for the print and gif for the html backend.
 211 \layout Standard
 212
 213 \begin_float fig
 214 \layout Standard
 215
 216
 217 \begin_inset Figure size 56 85
 218 file ../doc/platypus.eps
 219 width 1 2
 220 height 1 3
 221 angle 45
 222 flags 2
 223
 224 \end_inset
 225
 226
 227 \layout Caption
 228
 229 Nice platypus
 230 \end_float
 231
 232 \layout Standard
 233
 234 Wide figures are treated as normal figures.
 235 \layout Standard
 236
 237 \begin_float wide-fig
 238 \layout Standard
 239
 240
 241 \begin_inset Figure size 56 85
 242 file ../doc/platypus.eps
 243 width 1 2
 244 height 1 3
 245 angle 45
 246 flags 2
 247
 248 \end_inset
 249
 250
 251 \layout Caption
 252
 253 long, very long...
 254  :-)
 255 \end_float
 256 \layout Subsection
 257
 258 Tables
 259 \layout Standard
 260
 261 There is also basic support for tables.
 262 \begin_float tab
 263 \layout Standard
 264 \added_space_top 0.3cm \added_space_bottom 0.3cm \align center \LyXTable
 265 multicol5
 266 3 5 0 0 -1 -1 -1 -1
 267 1 0 0 0
 268 1 0 0 0
 269 1 1 0 0
 270 8 1 0 "" ""
 271 8 1 0 "" ""
 272 8 1 0 "" ""
 273 8 1 0 "" ""
 274 8 1 1 "" ""
 275 0 8 1 0 0 0 0 "" ""
 276 0 8 1 0 0 0 0 "" ""
 277 0 8 1 0 0 0 0 "" ""
 278 0 8 1 0 0 0 0 "" ""
 279 0 8 1 0 0 0 0 "" ""
 280 0 8 1 0 0 0 0 "" ""
 281 1 8 1 0 0 0 0 "" ""
 282 0 8 1 0 0 0 0 "" ""
 283 1 8 1 0 0 0 0 "" ""
 284 2 8 1 0 0 0 0 "" ""
 285 0 8 1 0 0 0 0 "" ""
 286 1 8 0 1 0 0 0 "" ""
 287 0 8 1 0 0 0 0 "" ""
 288 0 8 1 0 0 0 0 "" ""
 289 0 8 1 0 0 0 0 "" ""
 290
 291
 292 \newline
 293 Software 1
 294 \newline
 295 Software 2
 296 \newline
 297 Software 3
 298 \newline
 299 Software 4
 300 \newline
 301 Plataform 1
 302 \newline
 303 25 MB
 304 \newline
 305 10 MB
 306 \newline
 307 34 MB
 308 \newline
 309 Plataform 2
 310 \newline
 311
 312 \newline
 313 12 MB
 314 \newline
 315 30 MB
 316 \newline
 317 35 MB
 318 \layout Caption
 319
 320 Nice Formal Table
 321 \end_float
 322
 323 \layout Standard
 324
 325 As it happens with the figures the wide tables are treated as normal tables.
 326 \layout Subsection
 327
 328 Margins
 329 \layout Standard
 330
 331 There are some restrictions when using margins.
 332  For further information on docbook allowed syntax consult the
 333 \begin_inset LatexCommand \url[docbook reference manual]{http://www.oasis-open.org/docbook/documentation/reference/}
 334
 335 \end_inset
 336
 337 .
 338 \layout Quotation
 339
 340 It is also possible to insert margin notes inside some environments.
 341 \begin_deeper
 342 \layout SGML
 343
 344 \begin_float margin
 345 \end_deeper
 346 \layout Standard
 347
 348 margin note
 349 \layout Standard
 350
 351 second par -> margin note
 352 \layout Standard
 353
 354 third par -> margin note
 355 \end_float
 356
 357 \layout Quotation
 358
 359 Notice that the previous layout is at level 1
 360 \begin_float footnote
 361 \layout Standard
 362
 363 This comes from a docbook restriction.
 364  Sidebar can only appear inside "MSGTEXT", "CAUTION", "IMPORTANT", "NOTE",
 365  "TIP", "WARNING", "BLOCKQUOTE".
 366 \layout Standard
 367
 368 These environments are easily added to the docbook layout.
 369 \end_float
 370  and so is the follow:
 371 \begin_deeper
 372 \layout SGML
 373
 374 \begin_float margin
 375 \end_deeper
 376 \layout Standard
 377
 378 too marginal ;-)
 379 \end_float
 380
 381 \layout Section
 382
 383 The road map
 384 \layout Standard
 385
 386 This is a small list of the remaining tasks:
 387 \layout Itemize
 388
 389 Expand the number of layouts
 390 \begin_deeper
 391 \layout Itemize
 392
 393 example
 394 \layout Itemize
 395
 396 note
 397 \layout Itemize
 398
 399 warning
 400 \layout Itemize
 401
 402 tip
 403 \layout Itemize
 404
 405 caution
 406 \layout Itemize
 407
 408 important
 409 \end_deeper
 410 \layout Itemize
 411
 412 Compose other layout files, besides article
 413 \begin_deeper
 414 \layout Enumerate
 415
 416 book
 417 \layout Enumerate
 418
 419 set (very unlikely)
 420 \begin_float footnote
 421 \end_deeper
 422 \layout Standard
 423
 424 I do not expect lyx to deal with colection of books, for now!
 425 \end_float
 426 \begin_deeper
 427 \layout Enumerate
 428
 429 refentry
 430 \end_deeper
 431 \layout Itemize
 432
 433 goodies
 434 \begin_deeper
 435 \layout Enumerate
 436
 437 including other lyx files
 438 \layout Enumerate
 439
 440 more advanced tables support
 441 \end_deeper
 442 \layout Itemize
 443
 444 better documentation
 445 \layout Standard
 446
 447 That's all.
 448  ;-)
 449 \the_end