lib/examples/docbook_article.lyx

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