lib/examples/docbook_article.lyx

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