lib/examples/Articles/DocBook_Article_%28SGML%29.lyx

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