Changeset 28037 for trunk/doc


Ignore:
Timestamp:
Aug 18, 2007, 10:44:40 PM (12 years ago)
Author:
markd@…
Message:

Add chapter and section ids (up to 2 levels deep) and do some cross-referencing.
Thanks simon r. for the tips.

Location:
trunk/doc/guide/new/xml
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/new/xml/installing.xml

    r27493 r28037  
    22<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
    33"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
    4 <chapter>
     4<chapter id="installing-macports">
    55  <title>Installing MacPorts</title>
    66
     
    1010  installed, and then begin with section 5.</para>
    1111
    12   <section>
     12  <section id="installing-macports.install.xcode.tools">
    1313    <title>Install Xcode Tools</title>
    1414
     
    4444  </section>
    4545
    46   <section>
     46  <section id="installing-macports.install.x11">
    4747    <title>Install X11</title>
    4848
     
    117117  </section>
    118118
    119   <section>
     119  <section id="installing-macports.install.macports.binary">
    120120    <title>Install MacPorts - Binary</title>
    121121
     
    149149  </section>
    150150
    151   <section>
     151  <section id="installing-macports.install.macports.source">
    152152    <title>Install MacPorts - Source</title>
    153153
     
    181181  </section>
    182182
    183   <section>
     183  <section id="installing-macports.set.bash.shell">
    184184    <title>Set the Bash Shell</title>
    185185
     
    242242
    243243    <para>You must always do a selfupdate after a new MacPorts install, and
    244     you should also do it frequently thereafter. The command updates MacPorts
    245     via rsync with the latest port sources, and, if necessary, updates the
    246     MacPorts application (called MacPorts base) to the latest release.</para>
    247 
    248     <orderedlist>
    249       <listitem>
    250         <para>Open a terminal window.</para>
    251       </listitem>
    252 
    253       <listitem>
    254         <para>Execute the MacPorts selfupdate command.</para>
    255 
    256         <programlisting><prompt>%%</prompt> <userinput>sudo port selfupdate</userinput></programlisting>
    257 
    258         <para>Use the debug flag for verbose output.</para>
    259 
    260         <programlisting><prompt>%%</prompt> <userinput>sudo port -d selfupdate</userinput></programlisting>
    261       </listitem>
    262     </orderedlist>
     244    you should also do it frequently thereafter. See <link
     245    linkend="using-macports.port.command.selfupdate">selfupdate</link> —one of
     246    several <link linkend="using-macports.port.command">port
     247    commands</link>.</para>
    263248  </section>
    264249</chapter>
  • trunk/doc/guide/new/xml/internals.xml

    r27835 r28037  
    22<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
    33"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
    4 <chapter>
     4<chapter id="macports-internals">
    55  <title>MacPorts Internals</title>
    66
     
    88  of MacPorts or learn how to configure it for non-default operation.</para>
    99
    10   <section>
     10  <section id="macports-internals.macports.file.hierarchy">
    1111    <title>MacPorts File Hierarchy</title>
    1212
     
    241241  </section>
    242242
    243   <section>
     243  <section id="macports-internals.configuration.files">
    244244    <title>Configuration Files</title>
    245245
     
    249249    located in <filename>/opt/local/etc/macports</filename>.</para>
    250250
    251     <section>
     251    <section id="macports-internals.configuration.files.sources.conf">
    252252      <title>sources.conf</title>
    253253
     
    256256    </section>
    257257
    258     <section>
     258    <section id="macports-internals.configuration.files.macports.conf">
    259259      <title>macports.conf</title>
    260260
     
    263263    </section>
    264264
    265     <section>
     265    <section id="macports-internals.configuration.files.variants.conf">
    266266      <title>variants.conf</title>
    267267
     
    271271  </section>
    272272
    273   <section>
     273  <section id="macports-internals.port.images">
    274274    <title>Port Images</title>
    275275
     
    297297  </section>
    298298
    299   <section>
     299  <section id="macports-internals.macports.apis">
    300300    <title>MacPorts APIs</title>
    301301
     
    306306    MacPorts port utility.</para>
    307307
    308     <section>
     308    <section id="macports-internals.macports.apis.ports">
    309309      <title>Ports API</title>
    310310
     
    350350    </section>
    351351
    352     <section>
     352    <section id="macports-internals.macports.apis.macports">
    353353      <title>MacPorts API</title>
    354354
     
    493493  </section>
    494494
    495   <section>
     495  <section id="macports-internals.macports.registry">
    496496    <title>The MacPorts Registry</title>
    497497
     
    522522    </itemizedlist>
    523523
    524     <section>
     524    <section id="macports-internals.macports.registry.registry.api">
    525525      <title>The Registry API</title>
    526526
  • trunk/doc/guide/new/xml/intro.xml

    r27982 r28037  
    22<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
    33"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
    4 <chapter>
     4<chapter id="introduction">
    55  <title>Introduction</title>
    66
  • trunk/doc/guide/new/xml/portfiledev.xml

    r28035 r28037  
    22<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
    33"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
    4 <chapter>
     4<chapter id="portfile-development">
    55  <title>Portfile Development</title>
    66
     
    99  Portfiles.</para>
    1010
    11   <section>
     11  <section id="portfile-development.portfile.introduction">
    1212    <title>Portfile Introduction</title>
    1313
     
    7777  </section>
    7878
    79   <section>
     79  <section id="portfile-development.local.portfile.repositories">
    8080    <title>Local Portfile Repositories</title>
    8181
     
    149149  </section>
    150150
    151   <section>
     151  <section id="portfile-development.creating.a.portfile">
    152152    <title>Creating a Portfile</title>
    153153
     
    206206        keyword lists maintainer email addresses(s). To hide these addresses
    207207        from spambots, see the more full explanation of the maintainer keyword
    208         in the Portfile Reference section.</para>
     208        in the <link linkend="portfile-reference.keywords.global">Global
     209        Keywords</link> section of the Portfile Reference.</para>
    209210
    210211        <programlisting>maintainers       julesverne@somedomain.org</programlisting>
     
    277278  </section>
    278279
    279   <section>
     280  <section id="portfile-development.example.portfiles">
    280281    <title>Example Portfiles</title>
    281282
     
    284285    default phases.</para>
    285286
    286     <section>
     287    <section id="portfile-development.example.portfiles.basic.portfile">
    287288      <title>A Basic Portfile</title>
    288289
     
    312313    </section>
    313314
    314     <section>
     315    <section id="portfile-development.example.portfiles.pre.post">
    315316      <title>Portfile Using Pre- / Post- Phases</title>
    316317
     
    327328    </section>
    328329
    329     <section>
     330    <section id="portfile-development.example.portfiles.override">
    330331      <title>Portfile that Overrides Default Phases</title>
    331332
     
    339340    </section>
    340341
    341     <section>
     342    <section id="portfile-development.example.portfiles.startupitem">
    342343      <title>Portfile Using a StartupItem</title>
    343344
     
    360361  </section>
    361362
    362   <section>
     363  <section id="portfile-development.port.variants">
    363364    <title>Port Variants</title>
    364365
     
    368369    a description.</para>
    369370
    370     <section>
     371    <section id="portfile-development.port.variants.modify.options">
    371372      <title>Variants to Modify Options</title>
    372373
     
    405406    </section>
    406407
    407     <section>
     408    <section id="portfile-development.port.variants.actions.phase">
    408409      <title>Variant Actions in a Phase</title>
    409410
     
    427428    </section>
    428429
    429     <section>
     430    <section id="portfile-development.port.variants.default.variants">
    430431      <title>Default Variants</title>
    431432
     
    444445  </section>
    445446
    446   <section>
     447  <section id="portfile-development.patch.files">
    447448    <title>Patch Files</title>
    448449
     
    452453    functionality.</para>
    453454
    454     <section>
     455    <section id="portfile-development.patch.files.portfile.patches">
    455456      <title>Creating Portfile Patches</title>
    456457
     
    514515    </section>
    515516
    516     <section>
     517    <section id="portfile-development.patch.files.source.patches">
    517518      <title>Creating Source Code Patches</title>
    518519
     
    582583    </section>
    583584
    584     <section>
     585    <section id="portfile-development.patch.files.manually.applying">
    585586      <title>Manually Applying Patches</title>
    586587
     
    610611  </section>
    611612
    612   <section>
     613  <section id="portfile-development.portfile.best.practices">
    613614    <title>Portfile Best Practices</title>
    614615
  • trunk/doc/guide/new/xml/portfileref.xml

    r28034 r28037  
    22<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
    33"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
    4 <chapter>
     4<chapter id="portfile-reference">
    55  <title>Portfile Reference</title>
    66
     
    99  variables, keywords, and Tcl extensions.</para>
    1010
    11   <section>
     11  <section id="portfile-reference.port.phases">
    1212    <title>Port Phases</title>
    1313
     
    2020    phases as shown in the section "Portfile Development".</para>
    2121
    22     <section>
     22    <section id="portfile-reference.port.phases.fetch">
    2323      <title>Fetch</title>
    2424
     
    2828    </section>
    2929
    30     <section>
     30    <section id="portfile-reference.port.phases.checksum">
    3131      <title>Checksum</title>
    3232
     
    3636    </section>
    3737
    38     <section>
     38    <section id="portfile-reference.port.phases.extract">
    3939      <title>Extract</title>
    4040
     
    4343    </section>
    4444
    45     <section>
     45    <section id="portfile-reference.port.phases.patch">
    4646      <title>Patch</title>
    4747
     
    5858    </section>
    5959
    60     <section>
     60    <section id="portfile-reference.port.phases.configure">
    6161      <title>Configure</title>
    6262
     
    6565    </section>
    6666
    67     <section>
     67    <section id="portfile-reference.port.phases.build">
    6868      <title>Build</title>
    6969
     
    7272    </section>
    7373
    74     <section>
     74    <section id="portfile-reference.port.phases.destroot">
    7575      <title>Destroot</title>
    7676
     
    112112    </section>
    113113
    114     <section>
     114    <section id="portfile-reference.port.phases.archive">
    115115      <title>Archive</title>
    116116
     
    120120    </section>
    121121
    122     <section>
     122    <section id="portfile-reference.port.phases.install">
    123123      <title>Install</title>
    124124
     
    128128    </section>
    129129
    130     <section>
     130    <section id="portfile-reference.port.phases.activate">
    131131      <title>Activate</title>
    132132
     
    137137  </section>
    138138
    139   <section>
     139  <section id="portfile-reference.dependencies">
    140140    <title>Dependencies</title>
    141141
     
    154154    library and build dependencies also, but not its run dependencies.</para>
    155155
    156     <section>
     156    <section id="portfile-reference.dependencies.dependslib">
    157157      <title>depends_lib</title>
    158158
     
    163163    </section>
    164164
    165     <section>
     165    <section id="portfile-reference.dependencies.dependsbuild">
    166166      <title>depends_build</title>
    167167
     
    172172    </section>
    173173
    174     <section>
     174    <section id="portfile-reference.dependencies.dependsrun">
    175175      <title>depends_run</title>
    176176
     
    181181    </section>
    182182
    183     <section>
     183    <section id="portfile-reference.dependencies.nonport">
    184184      <title>Non-Port Dependencies</title>
    185185
     
    211211  </section>
    212212
    213   <section>
     213  <section id="portfile-reference.startupitems">
    214214    <title>StartupItems</title>
    215215
     
    324324  </section>
    325325
    326   <section>
     326  <section id="portfile-reference.variables">
    327327    <title>Variables</title>
    328328
     
    330330    used within Portfiles.</para>
    331331
    332     <section>
     332    <section id="portfile-reference.variables.general">
    333333      <title>General</title>
    334334
     
    457457    </section>
    458458
    459     <section>
     459    <section id="portfile-reference.variables.portgroup">
    460460      <title>PortGroup Variables</title>
    461461
     
    670670  </section>
    671671
    672   <section>
     672  <section id="portfile-reference.keywords">
    673673    <title>Keywords</title>
    674674
     
    688688    phase.</para>
    689689
    690     <section>
     690    <section id="portfile-reference.keywords.append.delete">
    691691      <title>Using -append and -delete Keywords</title>
    692692
     
    763763    </section>
    764764
    765     <section>
     765    <section id="portfile-reference.keywords.global">
    766766      <title>Global Keywords</title>
    767767
     
    957957    </section>
    958958
    959     <section>
     959    <section id="portfile-reference.keywords.fetch">
    960960      <title>Fetch</title>
    961961
     
    10981098    </section>
    10991099
    1100     <section>
     1100    <section id="portfile-reference.keywords.checksum">
    11011101      <title>Checksum</title>
    11021102
     
    11221122    </section>
    11231123
    1124     <section>
     1124    <section id="portfile-reference.keywords.extract">
    11251125      <title>Extract</title>
    11261126
     
    12101210    </section>
    12111211
    1212     <section>
     1212    <section id="portfile-reference.keywords.patch">
    12131213      <title>Patch</title>
    12141214
     
    12341234    </section>
    12351235
    1236     <section>
     1236    <section id="portfile-reference.keywords.configure">
    12371237      <title>Configure</title>
    12381238
     
    14421442    </section>
    14431443
    1444     <section>
     1444    <section id="portfile-reference.keywords.build">
    14451445      <title>Build</title>
    14461446
     
    15111511    </section>
    15121512
    1513     <section>
     1513    <section id="portfile-reference.keywords.destroot">
    15141514      <title>Destroot</title>
    15151515
     
    16251625  </section>
    16261626
    1627   <section>
     1627  <section id="portfile-reference.tcl.extensions">
    16281628    <title>Tcl Extensions</title>
    16291629
  • trunk/doc/guide/new/xml/project.xml

    r27495 r28037  
    22<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
    33"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
    4 <chapter>
     4<chapter id="macports-project">
    55  <title>MacPorts Project</title>
    66
     
    1414  account to create tickets.</para>
    1515
    16   <section>
     16  <section id="macports-project.creating.trac.tickets">
    1717    <title>Creating Trac Tickets</title>
    1818
     
    3232    </screenshot>
    3333
    34     <section>
     34    <section id="macports-project.creating.trac.tickets.guidelines">
    3535      <title>Trac Ticket Guidelines</title>
    3636
     
    235235  </section>
    236236
    237   <section>
     237  <section id="macports-project.contributing">
    238238    <title>Contributing to MacPorts</title>
    239239
     
    306306  </section>
    307307
    308   <section>
     308  <section id="macports-project.port.update.policies">
    309309    <title>Port Update Policies</title>
    310310
     
    316316    below.</para>
    317317
    318     <section>
     318    <section id="macports-project.port.update.policies.nonmaintainer">
    319319      <title>Non-Maintainer Port Updates</title>
    320320
     
    375375    </section>
    376376
    377     <section>
     377    <section id="macports-project.port.update.policies.abandonment">
    378378      <title>Port Abandonment</title>
    379379
     
    404404  </section>
    405405
    406   <section>
     406  <section id="macports-project.macports.membership">
    407407    <title>MacPorts Membership</title>
    408408
  • trunk/doc/guide/new/xml/using.xml

    r28013 r28037  
    22<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
    33"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
    4 <chapter>
     4<chapter id="using-macports">
    55  <title>Using MacPorts</title>
    66
     
    99  rsync replication server.</para>
    1010
    11   <section>
     11  <section id="using-macports.port.command">
    1212    <title>The port Command</title>
    1313
     
    1717    install and manage ports.</para>
    1818
    19     <section>
     19    <section id="using-macports.port.command.selfupdate">
    2020      <title>selfupdate</title>
    2121
     
    3535      <programlisting><prompt>%%</prompt> <userinput>sudo port selfupdate</userinput></programlisting>
    3636
     37      <para>Use the debug flag for verbose output.</para>
     38
     39      <programlisting><prompt>%%</prompt> <userinput>sudo port -d selfupdate</userinput></programlisting>
     40
    3741      <screen>DEBUG: Rebuilding the MacPorts base system if needed.
    3842DEBUG: Synchronizing ports tree(s)
     
    4953    </section>
    5054
    51     <section>
     55    <section id="using-macports.port.command.sync">
    5256      <title>sync</title>
    5357
     
    5862    </section>
    5963
    60     <section>
     64    <section id="using-macports.port.command.list">
    6165      <title>list</title>
    6266
     
    6771    </section>
    6872
    69     <section>
     73    <section id="using-macports.port.command.search">
    7074      <title>search</title>
    7175
     
    7983    </section>
    8084
    81     <section>
     85    <section id="using-macports.port.command.info">
    8286      <title>info</title>
    8387
     
    96100    </section>
    97101
    98     <section>
     102    <section id="using-macports.port.command.deps">
    99103      <title>deps</title>
    100104
     
    113117    </section>
    114118
    115     <section>
     119    <section id="using-macports.port.command.variants">
    116120      <title>variants</title>
    117121
     
    131135    </section>
    132136
    133     <section>
     137    <section id="using-macports.port.command.install">
    134138      <title>install</title>
    135139
     
    149153    </section>
    150154
    151     <section>
     155    <section id="using-macports.port.command.clean">
    152156      <title>clean</title>
    153157
     
    166170    </section>
    167171
    168     <section>
     172    <section id="using-macports.port.command.uninstall">
    169173      <title>uninstall</title>
    170174
     
    185189    </section>
    186190
    187     <section>
     191    <section id="using-macports.port.command.contents">
    188192      <title>contents</title>
    189193
     
    201205    </section>
    202206
    203     <section>
     207    <section id="using-macports.port.command.installed">
    204208      <title>installed</title>
    205209
     
    223227    </section>
    224228
    225     <section>
     229    <section id="using-macports.port.command.outdated">
    226230      <title>outdated</title>
    227231
     
    239243    </section>
    240244
    241     <section>
     245    <section id="using-macports.port.command.upgrade">
    242246      <title>upgrade</title>
    243247
     
    268272    </section>
    269273
    270     <section>
     274    <section id="using-macports.port.command.dependents">
    271275      <title>dependents</title>
    272276
     
    283287    </section>
    284288
    285     <section>
     289    <section id="using-macports.port.command.livecheck">
    286290      <title>livecheck</title>
    287291
     
    290294  </section>
    291295
    292   <section>
     296  <section id="using-macports.port.variants">
    293297    <title>Port Variants</title>
    294298
     
    310314    </note>
    311315
    312     <section>
     316    <section id="using-macports.port.variants.invoking.variants">
    313317      <title>Invoking Variants</title>
    314318
     
    330334    </section>
    331335
    332     <section>
     336    <section id="using-macports.port.variants.negating.default.variants">
    333337      <title>Negating Default Variants</title>
    334338
     
    351355  </section>
    352356
    353   <section>
     357  <section id="using-macports.common.tasks">
    354358    <title>Common Tasks</title>
    355359
     
    358362  </section>
    359363
    360   <section>
     364  <section id="using-macports.port.binaries">
    361365    <title>Port Binaries</title>
    362366
     
    365369    types of binaries: archives and packages.</para>
    366370
    367     <section>
     371    <section id="using-macports.port.binaries.binary.archives">
    368372      <title>Binary Archives</title>
    369373
     
    409413    </section>
    410414
    411     <section>
     415    <section id="using-macports.port.binaries.binary.packages">
    412416      <title>Binary Packages</title>
    413417
     
    435439    </section>
    436440
    437     <section>
     441    <section id="using-macports.port.binaries.port.source.packages">
    438442      <title>Port Source Packages</title>
    439443
     
    447451  </section>
    448452
    449   <section>
     453  <section id="using-macports.rsync.replication.servers">
    450454    <title>Rsync Replication Servers</title>
    451455
     
    457461    local network perform selfupdates.</para>
    458462
    459     <section>
     463    <section id="using-macports.rsync.replication.servers.rsync.server.setup">
    460464      <title>Rsync Server Setup</title>
    461465
     
    510514    </section>
    511515
    512     <section>
     516    <section id="using-macports.rsync.replication.servers.rsync.client.setup">
    513517      <title>Rsync Client Setup</title>
    514518
Note: See TracChangeset for help on using the changeset viewer.