lib/examples/docbook_article.lyx

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