lib/examples/docbook_article.lyx

   1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 508
   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 \end_layout
 164
 165 \begin_deeper
 166 \begin_layout Enumerate
 167 item 2
 168 \end_layout
 169
 170 \begin_layout Description
 171 new item
 172 \end_layout
 173
 174 \begin_deeper
 175 \begin_layout Enumerate
 176 collection
 177 \end_layout
 178
 179 \end_deeper
 180 \end_deeper
 181 \begin_layout Itemize
 182 new set
 183 \end_layout
 184
 185 \begin_layout Subsection
 186 Code
 187 \end_layout
 188
 189 \begin_layout Standard
 190 Required steps to have a running lyx.
 191 \end_layout
 192
 193 \begin_layout Quotation
 194 Be carefull with your own code.
 195 \end_layout
 196
 197 \begin_layout Quotation
 198 The debugger.
 199 \end_layout
 200
 201 \begin_layout Code
 202 cat > env.out
 203 \end_layout
 204
 205 \begin_layout Code
 206 tar xvzf lyx.tgz
 207 \end_layout
 208
 209 \begin_layout Code
 210 cd lyx-1_0_x
 211 \end_layout
 212
 213 \begin_layout Code
 214 ./configure
 215 \end_layout
 216
 217 \begin_layout Code
 218 make
 219 \end_layout
 220
 221 \begin_layout Code
 222 make install
 223 \end_layout
 224
 225 \begin_layout Subsection
 226 Labels
 227 \end_layout
 228
 229 \begin_layout Standard
 230 If a label is the first element in any layout, that label will be merged
 231  with that element.
 232  See as an example
 233 \begin_inset CommandInset ref
 234 LatexCommand ref
 235 name "first-section"
 236 reference "first-section"
 237
 238 \end_inset
 239
 240 .
 241 \end_layout
 242
 243 \begin_layout Subsection
 244 Fonts
 245 \end_layout
 246
 247 \begin_layout Standard
 248 The only fonts supported are
 249 \emph on
 250 Emphasis
 251 \emph default
 252  and
 253 \begin_inset Flex Literal
 254 status open
 255
 256 \begin_layout Plain Layout
 257 SGML
 258 \end_layout
 259
 260 \end_inset
 261
 262 .
 263 \end_layout
 264
 265 \begin_layout Subsection
 266 Figures
 267 \end_layout
 268
 269 \begin_layout Standard
 270 One of the major changes in the docbook when compared with the linuxdoc
 271  support are the figures support.
 272  LyX only allows to view eps figures.
 273  So you should have one of these if you want to take advantage of this feature.
 274 \end_layout
 275
 276 \begin_layout Standard
 277 Notice that when the docbook code is exported the filename extension is
 278  stripped.
 279  This enables that when the several backends are processed in sgmltools,
 280  the corresponding extensions are added.
 281  The default extension are eps for the print and gif for the html backend.
 282 \end_layout
 283
 284 \begin_layout Standard
 285 \begin_inset Float figure
 286 placement htbp
 287 wide false
 288 sideways false
 289 status open
 290
 291 \begin_layout Plain Layout
 292 \begin_inset Graphics
 293         filename ../doc/clipart/platypus.eps
 294         width 2cm
 295         height 3cm
 296         scaleBeforeRotation
 297         rotateAngle 45
 298         rotateOrigin center
 299
 300 \end_inset
 301
 302
 303 \end_layout
 304
 305 \begin_layout Plain Layout
 306 \begin_inset Caption Standard
 307
 308 \begin_layout Plain Layout
 309 Nice platypus
 310 \end_layout
 311
 312 \end_inset
 313
 314
 315 \end_layout
 316
 317 \end_inset
 318
 319
 320 \end_layout
 321
 322 \begin_layout Standard
 323 Wide figures are treated as normal figures.
 324 \end_layout
 325
 326 \begin_layout Standard
 327 \begin_inset Float figure
 328 placement htbp
 329 wide true
 330 sideways false
 331 status open
 332
 333 \begin_layout Plain Layout
 334 \begin_inset Graphics
 335         filename ../doc/clipart/platypus.eps
 336         width 2cm
 337         height 3cm
 338         scaleBeforeRotation
 339         rotateAngle 45
 340         rotateOrigin center
 341
 342 \end_inset
 343
 344
 345 \end_layout
 346
 347 \begin_layout Plain Layout
 348 \begin_inset Caption Standard
 349
 350 \begin_layout Plain Layout
 351 long, very long\SpecialChar ldots
 352  :-)
 353 \end_layout
 354
 355 \end_inset
 356
 357
 358 \end_layout
 359
 360 \end_inset
 361
 362
 363 \end_layout
 364
 365 \begin_layout Subsection
 366 Tables
 367 \end_layout
 368
 369 \begin_layout Standard
 370 There is also basic support for tables.
 371 \begin_inset Float table
 372 placement htbp
 373 wide false
 374 sideways false
 375 status open
 376
 377 \begin_layout Plain Layout
 378 \align center
 379 \begin_inset Tabular
 380 <lyxtabular version="3" rows="3" columns="5">
 381 <features tabularvalignment="middle">
 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 <column alignment="center" valignment="top" width="0pt">
 386 <column alignment="center" valignment="top" width="0pt">
 387 <row>
 388 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 389 \begin_inset Text
 390
 391 \begin_layout Plain Layout
 392
 393 \end_layout
 394
 395 \end_inset
 396 </cell>
 397 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 398 \begin_inset Text
 399
 400 \begin_layout Plain Layout
 401 Software 1
 402 \end_layout
 403
 404 \end_inset
 405 </cell>
 406 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 407 \begin_inset Text
 408
 409 \begin_layout Plain Layout
 410 Software 2
 411 \end_layout
 412
 413 \end_inset
 414 </cell>
 415 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 416 \begin_inset Text
 417
 418 \begin_layout Plain Layout
 419 Software 3
 420 \end_layout
 421
 422 \end_inset
 423 </cell>
 424 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
 425 \begin_inset Text
 426
 427 \begin_layout Plain Layout
 428 Software 4
 429 \end_layout
 430
 431 \end_inset
 432 </cell>
 433 </row>
 434 <row>
 435 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 436 \begin_inset Text
 437
 438 \begin_layout Plain Layout
 439 Plataform 1
 440 \end_layout
 441
 442 \end_inset
 443 </cell>
 444 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 445 \begin_inset Text
 446
 447 \begin_layout Plain Layout
 448 25 MB
 449 \end_layout
 450
 451 \end_inset
 452 </cell>
 453 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 454 \begin_inset Text
 455
 456 \begin_layout Plain Layout
 457 10 MB
 458 \end_layout
 459
 460 \end_inset
 461 </cell>
 462 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
 463 \begin_inset Text
 464
 465 \begin_layout Plain Layout
 466 34 MB
 467 \end_layout
 468
 469 \end_inset
 470 </cell>
 471 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
 472 \begin_inset Text
 473
 474 \begin_layout Plain Layout
 475
 476 \end_layout
 477
 478 \end_inset
 479 </cell>
 480 </row>
 481 <row>
 482 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 483 \begin_inset Text
 484
 485 \begin_layout Plain Layout
 486 Plataform 2
 487 \end_layout
 488
 489 \end_inset
 490 </cell>
 491 <cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
 492 \begin_inset Text
 493
 494 \begin_layout Plain Layout
 495
 496 \end_layout
 497
 498 \end_inset
 499 </cell>
 500 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 501 \begin_inset Text
 502
 503 \begin_layout Plain Layout
 504 12 MB
 505 \end_layout
 506
 507 \end_inset
 508 </cell>
 509 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 510 \begin_inset Text
 511
 512 \begin_layout Plain Layout
 513 30 MB
 514 \end_layout
 515
 516 \end_inset
 517 </cell>
 518 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
 519 \begin_inset Text
 520
 521 \begin_layout Plain Layout
 522 35 MB
 523 \end_layout
 524
 525 \end_inset
 526 </cell>
 527 </row>
 528 </lyxtabular>
 529
 530 \end_inset
 531
 532
 533 \end_layout
 534
 535 \begin_layout Plain Layout
 536 \begin_inset Caption Standard
 537
 538 \begin_layout Plain Layout
 539 Nice Formal Table
 540 \end_layout
 541
 542 \end_inset
 543
 544
 545 \end_layout
 546
 547 \end_inset
 548
 549
 550 \end_layout
 551
 552 \begin_layout Standard
 553 As it happens with the figures the wide tables are treated as normal tables.
 554 \end_layout
 555
 556 \begin_layout Subsection
 557 Margins
 558 \end_layout
 559
 560 \begin_layout Standard
 561 There are some restrictions when using margins.
 562  For further information on docbook allowed syntax consult the
 563 \begin_inset CommandInset href
 564 LatexCommand href
 565 name "docbook reference manual"
 566 target "http://www.oasis-open.org/docbook/documentation/reference/"
 567
 568 \end_inset
 569
 570 .
 571 \end_layout
 572
 573 \begin_layout Quotation
 574 It is also possible to insert margin notes inside some environments.
 575 \end_layout
 576
 577 \begin_deeper
 578 \begin_layout Standard
 579 \begin_inset ERT
 580 status collapsed
 581
 582 \begin_layout Plain Layout
 583
 584 \end_layout
 585
 586 \begin_layout Plain Layout
 587
 588 second par -> margin note
 589 \end_layout
 590
 591 \begin_layout Plain Layout
 592
 593 third par -> margin note
 594 \end_layout
 595
 596 \end_inset
 597
 598
 599 \end_layout
 600
 601 \end_deeper
 602 \begin_layout Quotation
 603 Notice that the previous layout is at level 1
 604 \begin_inset Foot
 605 status collapsed
 606
 607 \begin_layout Plain Layout
 608 This comes from a docbook restriction.
 609  Sidebar can only appear inside "MSGTEXT", "CAUTION", "IMPORTANT", "NOTE",
 610  "TIP", "WARNING", "BLOCKQUOTE".
 611 \end_layout
 612
 613 \begin_layout Plain Layout
 614 These environments are easily added to the docbook layout.
 615 \end_layout
 616
 617 \end_inset
 618
 619  and so is the follow:
 620 \end_layout
 621
 622 \begin_deeper
 623 \begin_layout Standard
 624 \begin_inset ERT
 625 status collapsed
 626
 627 \begin_layout Plain Layout
 628
 629 \end_layout
 630
 631 \end_inset
 632
 633
 634 \end_layout
 635
 636 \end_deeper
 637 \begin_layout Section
 638 The road map
 639 \end_layout
 640
 641 \begin_layout Standard
 642 This is a small list of the remaining tasks:
 643 \end_layout
 644
 645 \begin_layout Itemize
 646 Expand the number of layouts
 647 \end_layout
 648
 649 \begin_deeper
 650 \begin_layout Itemize
 651 example
 652 \end_layout
 653
 654 \begin_layout Itemize
 655 note
 656 \end_layout
 657
 658 \begin_layout Itemize
 659 warning
 660 \end_layout
 661
 662 \begin_layout Itemize
 663 tip
 664 \end_layout
 665
 666 \begin_layout Itemize
 667 caution
 668 \end_layout
 669
 670 \begin_layout Itemize
 671 important
 672 \end_layout
 673
 674 \end_deeper
 675 \begin_layout Itemize
 676 Compose other layout files, besides article
 677 \end_layout
 678
 679 \begin_deeper
 680 \begin_layout Enumerate
 681 book
 682 \end_layout
 683
 684 \begin_layout Enumerate
 685 set (very unlikely)
 686 \begin_inset Foot
 687 status collapsed
 688
 689 \begin_layout Plain Layout
 690 I do not expect lyx to deal with colection of books, for now!
 691 \end_layout
 692
 693 \end_inset
 694
 695
 696 \end_layout
 697
 698 \begin_layout Enumerate
 699 refentry
 700 \end_layout
 701
 702 \end_deeper
 703 \begin_layout Itemize
 704 goodies
 705 \end_layout
 706
 707 \begin_deeper
 708 \begin_layout Enumerate
 709 including other lyx files
 710 \end_layout
 711
 712 \begin_layout Enumerate
 713 more advanced tables support
 714 \end_layout
 715
 716 \end_deeper
 717 \begin_layout Itemize
 718 better documentation
 719 \end_layout
 720
 721 \begin_layout Standard
 722 That's all.
 723  ;-)
 724 \end_layout
 725
 726 \end_body
 727 \end_document