lib/examples/docbook_article.lyx

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