OpenACS

lars
committed
MAIN:lars:20030917144704
on 17 Sep 03
Fixed bug with username and local accounts when logging in with email
openacs-4/.../engineering-standards/docbook-primer.xml (+6 -6)
446 446     <para>
447 447       <indexterm><primary>lists</primary></indexterm>
448 448       Here's how you make the DocBook equivalent of the three usual HTML-lists:
449 449     </para>
450 450
451 451     <variablelist>
452 452
453 453       <varlistentry>
454 454         <term><emphasis role="strong">1. How to make an &lt;ul&gt;</emphasis></term>
455 455         <listitem><para>
456 456             Making an unordered list is pretty much like doing the same thing in HTML - if you close your <computeroutput>&lt;li&gt;</computeroutput>, that is. The only differences are that each list item has to be wrapped in something more, such as
457 457             <computeroutput>&lt;para&gt;</computeroutput>, and that the tags are called
458 458             <ulink url="http://docbook.org/tdg/html/itemizedlist.html"><computeroutput>&lt;itemizedlist&gt;</computeroutput></ulink>
459 459             and
460 460             <ulink url="http://docbook.org/tdg/html/listitem.html"><computeroutput>&lt;listitem&gt;</computeroutput></ulink>:
461 461           </para>
462 462
463 463           <programlisting>
464 464             &lt;itemizedlist&gt;
465 465            
466               &lt;listitem&gt;&lt;para&gt;Stuff goes here&lt;/para&gt;&lt;listitem&gt;
467               &lt;listitem&gt;&lt;para&gt;More stuff goes here&lt;/para&gt;&lt;listitem&gt;
  466             &lt;listitem&gt;&lt;para&gt;Stuff goes here&lt;/para&gt;&lt;/listitem&gt;
  467             &lt;listitem&gt;&lt;para&gt;More stuff goes here&lt;/para&gt;&lt;/listitem&gt;
468 468
469 469             &lt;/itemizedlist&gt;
470 470           </programlisting>
471 471
472 472         </listitem>
473 473       </varlistentry>
474 474
475 475
476 476       <varlistentry>
477 477         <term><emphasis role="strong">2. How to make an &lt;ol&gt;</emphasis></term>
478 478         <listitem><para>
479 479             The ordered list is like the preceding, except that you use
480 480             <ulink url="http://docbook.org/tdg/html/orderedlist.html"><computeroutput>&lt;orderedlist&gt;</computeroutput></ulink> instead:</para>
481 481
482 482           <programlisting>
483 483             &lt;orderedlist&gt;
484 484            
485               &lt;listitem&gt;&lt;para&gt;Stuff goes here&lt;/para&gt;&lt;listitem&gt;
486               &lt;listitem&gt;&lt;para&gt;More stuff goes here&lt;/para&gt;&lt;listitem&gt;
  485             &lt;listitem&gt;&lt;para&gt;Stuff goes here&lt;/para&gt;&lt;/listitem&gt;
  486             &lt;listitem&gt;&lt;para&gt;More stuff goes here&lt;/para&gt;&lt;/listitem&gt;
487 487
488 488             &lt;/orderedlist&gt;
489 489           </programlisting>
490 490
491 491         </listitem>
492 492       </varlistentry>
493 493
494 494
495 495       <varlistentry>
496 496         <term><emphasis role="strong">3. How to make a &lt;dl&gt;</emphasis></term>
497 497         <listitem><para>
498 498             This kind of list is called a <computeroutput>variablelist</computeroutput> and these are the tags you'll need to
499 499             make it happen:
500 500             <ulink url="http://docbook.org/tdg/html/variablelist.html"><computeroutput>&lt;variablelist&gt;</computeroutput></ulink>,
501 501             <ulink url="http://docbook.org/tdg/html/varlistentry.html"><computeroutput>&lt;varlistentry&gt;</computeroutput></ulink>,
502 502             <ulink url="http://docbook.org/tdg/html/term.html"><computeroutput>&lt;term&gt;</computeroutput></ulink> and
503 503             <ulink url="http://docbook.org/tdg/html/listitem.html"><computeroutput>&lt;listitem&gt;</computeroutput></ulink>:</para>
504 504
505 505           <programlisting>
506 506             &lt;variablelist&gt;
507 507            
508 508             &lt;varlistentry&gt;
509 509             &lt;term&gt;Heading (&lt;dt&gt;) goes here&lt;/term&gt;
510               &lt;listitem&gt;&lt;para&gt;And stuff (&lt;dd&gt;)goes here&lt;/para&gt;&lt;listitem&gt;
  510             &lt;listitem&gt;&lt;para&gt;And stuff (&lt;dd&gt;)goes here&lt;/para&gt;&lt;/listitem&gt;
511 511             &lt;/varlistentry&gt;
512 512
513 513             &lt;varlistentry&gt;
514 514             &lt;term&gt;Another heading goes here&lt;/term&gt;
515               &lt;listitem&gt;&lt;para&gt;And more stuff goes here&lt;/para&gt;&lt;listitem&gt;
  515             &lt;listitem&gt;&lt;para&gt;And more stuff goes here&lt;/para&gt;&lt;/listitem&gt;
516 516             &lt;/varlistentry&gt;
517 517
518 518             &lt;/variablelist&gt;
519 519           </programlisting>
520 520
521 521         </listitem>
522 522       </varlistentry>
523 523
524 524     </variablelist>
525 525
526 526   </sect2>
527 527
528 528
529 529   <sect2 id="dbprimer-tables">
530 530     <title>Tables</title>
531 531
532 532     <para>
533 533       <indexterm><primary>informaltable</primary><secondary>table</secondary></indexterm>
534 534       DocBook supports several types of tables, but in most cases, the
535 535       <ulink url="http://docbook.org/tdg/html/informaltable.html"><computeroutput>&lt;informaltable&gt;</computeroutput></ulink>