lib/examples/docbook_article.lyx

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