lib/examples/docbook_article.lyx

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