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