lib/examples/docbook_article.lyx

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