lib/examples/docbook_article.lyx

   1 #LyX 1.6.0 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 345
   3 \begin_document
   4 \begin_header
   5 \textclass docbook
   6 \use_default_options false
   7 \language english
   8 \inputencoding default
   9 \font_roman default
  10 \font_sans default
  11 \font_typewriter default
  12 \font_default_family default
  13 \font_sc false
  14 \font_osf false
  15 \font_sf_scale 100
  16 \font_tt_scale 100
  17 \graphics default
  18 \paperfontsize default
  19 \spacing single
  20 \use_hyperref false
  21 \papersize default
  22 \use_geometry false
  23 \use_amsmath 0
  24 \use_esint 0
  25 \cite_engine basic
  26 \use_bibtopic false
  27 \paperorientation portrait
  28 \secnumdepth 3
  29 \tocdepth 3
  30 \paragraph_separation indent
  31 \defskip medskip
  32 \quotes_language english
  33 \papercolumns 1
  34 \papersides 1
  35 \paperpagestyle default
  36 \tracking_changes false
  37 \output_changes false
  38 \author ""
  39 \author ""
  40 \end_header
  41
  42 \begin_body
  43
  44 \begin_layout Title
  45 Docbook with LyX
  46 \end_layout
  47
  48 \begin_layout Date
  49 24 September 1999
  50 \end_layout
  51
  52 \begin_layout Author
  53 \begin_inset Flex Element:Firstname
  54 status open
  55
  56 \begin_layout Plain Layout
  57 José
  58 \end_layout
  59
  60 \end_inset
  61
  62
  63 \begin_inset Flex Element:Surname
  64 status open
  65
  66 \begin_layout Plain Layout
  67 Matos
  68 \end_layout
  69
  70 \end_inset
  71
  72
  73 \end_layout
  74
  75 \begin_layout Abstract
  76 This is a small illustration of lyx's features using DocBook.
  77 \end_layout
  78
  79 \begin_layout Abstract
  80 The abstract can span several paragraphs.
  81 \end_layout
  82
  83 \begin_layout Section
  84 \begin_inset CommandInset label
  85 LatexCommand label
  86 name "first-section"
  87
  88 \end_inset
  89
  90 Introduction
  91 \end_layout
  92
  93 \begin_layout Standard
  94 This file ilustrates the generation of docbook documents with LyX.
  95 \end_layout
  96
  97 \begin_layout Standard
  98 This will improve as soon as new features are available.
  99 \end_layout
 100
 101 \begin_layout Section
 102 Standard layouts
 103 \end_layout
 104
 105 \begin_layout Standard
 106 One of the goals is the support, as much as possible, of layouts used in
 107  other textclass, for compatibility purposes.
 108 \end_layout
 109
 110 \begin_layout Standard
 111 Remember that this is work in progress, I would like to hear any comments,
 112  good or
 113 \begin_inset Quotes eld
 114 \end_inset
 115
 116 bad
 117 \begin_inset Quotes erd
 118 \end_inset
 119
 120 .
 121 \end_layout
 122
 123 \begin_layout Subsection
 124 Lists
 125 \end_layout
 126
 127 \begin_layout Standard
 128 This is an example with several nested lists.
 129 \end_layout
 130
 131 \begin_layout Itemize
 132 item 1
 133 \end_layout
 134
 135 \begin_deeper
 136 \begin_layout Enumerate
 137 item 2
 138 \end_layout
 139
 140 \begin_layout Description
 141 new item
 142 \end_layout
 143
 144 \begin_deeper
 145 \begin_layout Enumerate
 146 collection
 147 \end_layout
 148
 149 \end_deeper
 150 \end_deeper
 151 \begin_layout Itemize
 152 new set
 153 \end_layout
 154
 155 \begin_layout Subsection
 156 Code
 157 \end_layout
 158
 159 \begin_layout Standard
 160 Required steps to have a running lyx.
 161 \end_layout
 162
 163 \begin_layout Quotation
 164 Be carefull with your own code.
 165 \end_layout
 166
 167 \begin_layout Quotation
 168 The debugger.
 169 \end_layout
 170
 171 \begin_layout Code
 172 cat > env.out
 173 \end_layout
 174
 175 \begin_layout Code
 176 tar xvzf lyx.tgz
 177 \end_layout
 178
 179 \begin_layout Code
 180 cd lyx-1_0_x
 181 \end_layout
 182
 183 \begin_layout Code
 184 ./configure
 185 \end_layout
 186
 187 \begin_layout Code
 188 make
 189 \end_layout
 190
 191 \begin_layout Code
 192 make install
 193 \end_layout
 194
 195 \begin_layout Subsection
 196 Labels
 197 \end_layout
 198
 199 \begin_layout Standard
 200 If a label is the first element in any layout, that label will be merged
 201  with that element.
 202  See as an example
 203 \begin_inset CommandInset ref
 204 LatexCommand ref
 205 name "first-section"
 206 reference "first-section"
 207
 208 \end_inset
 209
 210 .
 211 \end_layout
 212
 213 \begin_layout Subsection
 214 Fonts
 215 \end_layout
 216
 217 \begin_layout Standard
 218 The only fonts supported are
 219 \emph on
 220 Emphasis
 221 \emph default
 222  and
 223 \begin_inset Flex Element:Literal
 224 status open
 225
 226 \begin_layout Plain Layout
 227 SGML
 228 \end_layout
 229
 230 \end_inset
 231
 232 .
 233 \end_layout
 234
 235 \begin_layout Subsection
 236 Figures
 237 \end_layout
 238
 239 \begin_layout Standard
 240 One of the major changes in the docbook when compared with the linuxdoc
 241  support are the figures support.
 242  LyX only allows to view eps figures.
 243  So you should have one of these if you want to take advantage of this feature.
 244 \end_layout
 245
 246 \begin_layout Standard
 247 Notice that when the docbook code is exported the filename extension is
 248  stripped.
 249  This enables that when the several backends are processed in sgmltools,
 250  the corresponding extensions are added.
 251  The default extension are eps for the print and gif for the html backend.
 252 \end_layout
 253
 254 \begin_layout Standard
 255 \begin_inset Float figure
 256 placement htbp
 257 wide false
 258 sideways false
 259 status open
 260
 261 \begin_layout Plain Layout
 262 \begin_inset Graphics
 263         filename ../doc/clipart/platypus.eps
 264         width 2cm
 265         height 3cm
 266         scaleBeforeRotation
 267         rotateAngle 45
 268         rotateOrigin center
 269
 270 \end_inset
 271
 272
 273 \end_layout
 274
 275 \begin_layout Plain Layout
 276 \begin_inset Caption
 277
 278 \begin_layout Plain Layout
 279 Nice platypus
 280 \end_layout
 281
 282 \end_inset
 283
 284
 285 \end_layout
 286
 287 \end_inset
 288
 289
 290 \end_layout
 291
 292 \begin_layout Standard
 293 Wide figures are treated as normal figures.
 294 \end_layout
 295
 296 \begin_layout Standard
 297 \begin_inset Float figure
 298 placement htbp
 299 wide true
 300 sideways false
 301 status open
 302
 303 \begin_layout Plain Layout
 304 \begin_inset Graphics
 305         filename ../doc/clipart/platypus.eps
 306         width 2cm
 307         height 3cm
 308         scaleBeforeRotation
 309         rotateAngle 45
 310         rotateOrigin center
 311
 312 \end_inset
 313
 314
 315 \end_layout
 316
 317 \begin_layout Plain Layout
 318 \begin_inset Caption
 319
 320 \begin_layout Plain Layout
 321 long, very long\SpecialChar \ldots{}
 322  :-)
 323 \end_layout
 324
 325 \end_inset
 326
 327
 328 \end_layout
 329
 330 \end_inset
 331
 332
 333 \end_layout
 334
 335 \begin_layout Subsection
 336 Tables
 337 \end_layout
 338
 339 \begin_layout Standard
 340 There is also basic support for tables.
 341 \begin_inset Float table
 342 placement htbp
 343 wide false
 344 sideways false
 345 status open
 346
 347 \begin_layout Plain Layout
 348 \align center
 349 \begin_inset Tabular
 350 <lyxtabular version="3" rows="3" columns="5">
 351 <features>
 352 <column alignment="center" valignment="top" width="0pt">
 353 <column alignment="center" valignment="top" width="0pt">
 354 <column alignment="center" valignment="top" width="0pt">
 355 <column alignment="center" valignment="top" width="0pt">
 356 <column alignment="center" valignment="top" width="0pt">
 357 <row>
 358 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 359 \begin_inset Text
 360
 361 \begin_layout Plain Layout
 362
 363 \end_layout
 364
 365 \end_inset
 366 </cell>
 367 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 368 \begin_inset Text
 369
 370 \begin_layout Plain Layout
 371 Software 1
 372 \end_layout
 373
 374 \end_inset
 375 </cell>
 376 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 377 \begin_inset Text
 378
 379 \begin_layout Plain Layout
 380 Software 2
 381 \end_layout
 382
 383 \end_inset
 384 </cell>
 385 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 386 \begin_inset Text
 387
 388 \begin_layout Plain Layout
 389 Software 3
 390 \end_layout
 391
 392 \end_inset
 393 </cell>
 394 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
 395 \begin_inset Text
 396
 397 \begin_layout Plain Layout
 398 Software 4
 399 \end_layout
 400
 401 \end_inset
 402 </cell>
 403 </row>
 404 <row>
 405 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 406 \begin_inset Text
 407
 408 \begin_layout Plain Layout
 409 Plataform 1
 410 \end_layout
 411
 412 \end_inset
 413 </cell>
 414 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 415 \begin_inset Text
 416
 417 \begin_layout Plain Layout
 418 25 MB
 419 \end_layout
 420
 421 \end_inset
 422 </cell>
 423 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 424 \begin_inset Text
 425
 426 \begin_layout Plain Layout
 427 10 MB
 428 \end_layout
 429
 430 \end_inset
 431 </cell>
 432 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
 433 \begin_inset Text
 434
 435 \begin_layout Plain Layout
 436 34 MB
 437 \end_layout
 438
 439 \end_inset
 440 </cell>
 441 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
 442 \begin_inset Text
 443
 444 \begin_layout Plain Layout
 445
 446 \end_layout
 447
 448 \end_inset
 449 </cell>
 450 </row>
 451 <row>
 452 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 453 \begin_inset Text
 454
 455 \begin_layout Plain Layout
 456 Plataform 2
 457 \end_layout
 458
 459 \end_inset
 460 </cell>
 461 <cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
 462 \begin_inset Text
 463
 464 \begin_layout Plain Layout
 465
 466 \end_layout
 467
 468 \end_inset
 469 </cell>
 470 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 471 \begin_inset Text
 472
 473 \begin_layout Plain Layout
 474 12 MB
 475 \end_layout
 476
 477 \end_inset
 478 </cell>
 479 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 480 \begin_inset Text
 481
 482 \begin_layout Plain Layout
 483 30 MB
 484 \end_layout
 485
 486 \end_inset
 487 </cell>
 488 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
 489 \begin_inset Text
 490
 491 \begin_layout Plain Layout
 492 35 MB
 493 \end_layout
 494
 495 \end_inset
 496 </cell>
 497 </row>
 498 </lyxtabular>
 499
 500 \end_inset
 501
 502
 503 \end_layout
 504
 505 \begin_layout Plain Layout
 506 \begin_inset Caption
 507
 508 \begin_layout Plain Layout
 509 Nice Formal Table
 510 \end_layout
 511
 512 \end_inset
 513
 514
 515 \end_layout
 516
 517 \end_inset
 518
 519
 520 \end_layout
 521
 522 \begin_layout Standard
 523 As it happens with the figures the wide tables are treated as normal tables.
 524 \end_layout
 525
 526 \begin_layout Subsection
 527 Margins
 528 \end_layout
 529
 530 \begin_layout Standard
 531 There are some restrictions when using margins.
 532  For further information on docbook allowed syntax consult the
 533 \begin_inset CommandInset href
 534 LatexCommand href
 535 name "docbook reference manual"
 536 target "http://www.oasis-open.org/docbook/documentation/reference/"
 537
 538 \end_inset
 539
 540 .
 541 \end_layout
 542
 543 \begin_layout Quotation
 544 It is also possible to insert margin notes inside some environments.
 545 \end_layout
 546
 547 \begin_deeper
 548 \begin_layout Standard
 549 \begin_inset ERT
 550 status collapsed
 551
 552 \begin_layout Plain Layout
 553
 554 \end_layout
 555
 556 \begin_layout Plain Layout
 557
 558 second par -> margin note
 559 \end_layout
 560
 561 \begin_layout Plain Layout
 562
 563 third par -> margin note
 564 \end_layout
 565
 566 \end_inset
 567
 568
 569 \end_layout
 570
 571 \end_deeper
 572 \begin_layout Quotation
 573 Notice that the previous layout is at level 1
 574 \begin_inset Foot
 575 status collapsed
 576
 577 \begin_layout Plain Layout
 578 This comes from a docbook restriction.
 579  Sidebar can only appear inside "MSGTEXT", "CAUTION", "IMPORTANT", "NOTE",
 580  "TIP", "WARNING", "BLOCKQUOTE".
 581 \end_layout
 582
 583 \begin_layout Plain Layout
 584 These environments are easily added to the docbook layout.
 585 \end_layout
 586
 587 \end_inset
 588
 589  and so is the follow:
 590 \end_layout
 591
 592 \begin_deeper
 593 \begin_layout Standard
 594 \begin_inset ERT
 595 status collapsed
 596
 597 \begin_layout Plain Layout
 598
 599 \end_layout
 600
 601 \end_inset
 602
 603
 604 \end_layout
 605
 606 \end_deeper
 607 \begin_layout Section
 608 The road map
 609 \end_layout
 610
 611 \begin_layout Standard
 612 This is a small list of the remaining tasks:
 613 \end_layout
 614
 615 \begin_layout Itemize
 616 Expand the number of layouts
 617 \end_layout
 618
 619 \begin_deeper
 620 \begin_layout Itemize
 621 example
 622 \end_layout
 623
 624 \begin_layout Itemize
 625 note
 626 \end_layout
 627
 628 \begin_layout Itemize
 629 warning
 630 \end_layout
 631
 632 \begin_layout Itemize
 633 tip
 634 \end_layout
 635
 636 \begin_layout Itemize
 637 caution
 638 \end_layout
 639
 640 \begin_layout Itemize
 641 important
 642 \end_layout
 643
 644 \end_deeper
 645 \begin_layout Itemize
 646 Compose other layout files, besides article
 647 \end_layout
 648
 649 \begin_deeper
 650 \begin_layout Enumerate
 651 book
 652 \end_layout
 653
 654 \begin_layout Enumerate
 655 set (very unlikely)
 656 \begin_inset Foot
 657 status collapsed
 658
 659 \begin_layout Plain Layout
 660 I do not expect lyx to deal with colection of books, for now!
 661 \end_layout
 662
 663 \end_inset
 664
 665
 666 \end_layout
 667
 668 \begin_layout Enumerate
 669 refentry
 670 \end_layout
 671
 672 \end_deeper
 673 \begin_layout Itemize
 674 goodies
 675 \end_layout
 676
 677 \begin_deeper
 678 \begin_layout Enumerate
 679 including other lyx files
 680 \end_layout
 681
 682 \begin_layout Enumerate
 683 more advanced tables support
 684 \end_layout
 685
 686 \end_deeper
 687 \begin_layout Itemize
 688 better documentation
 689 \end_layout
 690
 691 \begin_layout Standard
 692 That's all.
 693  ;-)
 694 \end_layout
 695
 696 \end_body
 697 \end_document