Changeset 27778

Show
Ignore:
Timestamp:
12/14/2009 10:35:13 PM (9 months ago)
Author:
jesstess
Message:

Apply finger-tutorial-preambles2.patch

Author: jesstess
Reviewer: exarkun, thijs
Fixes: #2406

Add preambles to each section of the finger tutorial linking to the
parts of the core howto covered in that section.

Location:
trunk
Files:
1 added
10 modified

Legend:

Unmodified
Added
Removed

  • trunk/doc/core/howto/application.xhtml

    r27686 r27778  
    1919configurable fashion.  A Twisted user who wishes to use the Application 
    2020framework needs to be familiar with developing Twisted <a 
    21 href="servers.xhtml">servers</a> and/or <a href="clients.xhtml">clients</a></p>. 
     21href="servers.xhtml">servers</a> and/or <a href="clients.xhtml">clients</a>.</p> 
    2222 
    2323<h3>Goals</h3> 

  • trunk/doc/core/howto/index.xhtml

    r27267 r27778  
    1414 
    1515  <ul class="toc"> 
    16     <li>Introduction 
     16    <li><a name="introduction">Introduction</a> 
    1717 
    1818      <ul> 
    … …  
    2626    </li> 
    2727 
    28     <li>Tutorials 
     28    <li><a name="tutorials">Tutorials</a> 
    2929 
    3030      <ul> 
    … …  
    8585    </li> 
    8686 
    87     <li>Low-Level Networking and Event Loop 
     87    <li><a name="lowlevel">Low-Level Networking and Event Loop</a> 
    8888 
    8989      <ul> 
    … …  
    112112    </li> 
    113113 
    114     <li>High-Level Twisted 
     114    <li><a name="highlevel">High-Level Twisted</a> 
    115115 
    116116      <ul> 
    … …  
    129129        Authentication</a></li> 
    130130 
    131         <li><a href="application.xhtml">Using application</a></li> 
     131        <li><a href="application.xhtml">Using the Twisted Application 
     132        Framework</a></li> 
     133 
    132134      </ul> 
    133135    </li> 
    134136 
    135     <li>Utilities 
     137    <li><a name="utilities">Utilities</a> 
    136138 
    137139      <ul> 
    … …  
    150152    </li> 
    151153 
    152     <li>Twisted RDBMS support 
     154    <li><a name="rdbms">Twisted RDBMS support</a> 
    153155 
    154156      <ul> 
    … …  
    161163    </li> 
    162164 
    163     <li>Perspective Broker 
     165    <li><a name="pb">Perspective Broker</a> 
    164166 
    165167      <ul> 
    … …  
    180182    </li> 
    181183 
    182     <li>Appendix 
     184    <li><a name="appendix">Appendix</a> 
    183185 
    184186      <ul> 

  • trunk/doc/core/howto/tutorial/components.xhtml

    r24451 r27778  
    1515 
    1616<p>In this section of the tutorial, we'll move our code to a component 
    17 architecture so that adding new features is trivial.</p> 
     17architecture so that adding new features is trivial. 
     18See <a href="../components.xhtml">Interfaces and Adapters</a> for a more 
     19complete discussion of components.</p> 
    1820 
    1921<h2>Write Maintainable Code</h2> 

  • trunk/doc/core/howto/tutorial/configuration.xhtml

    r25672 r27778  
    1515 
    1616<p>In this part, we make it easier for non-programmers to configure a finger 
    17 server, and show how to package it in the .deb and RPM package formats.</p> 
     17server and show how to package it in the .deb and RPM package formats. Plugins 
     18are discussed further in the <a href="../plugin.xhtml">Twisted Plugin System</a> 
     19howto. .tap files are covered in <a href="../tap.xhtml">Writing a twistd 
     20Plugin</a>, and .tac applications are covered 
     21in <a href="../application.xhtml">Using the Twisted Application 
     22Framework</a>.</p> 
    1823 
    1924<h2>Plugins</h2> 

  • trunk/doc/core/howto/tutorial/factory.xhtml

    r10593 r27778  
    1616href="index.xhtml">Twisted from Scratch, or The Evolution of Finger</a>.</p> 
    1717 
    18 <p>In this part, we add HTTPS support to our web frontend, showing how to have 
    19 a single factory listen on multiple ports.</p> 
     18<p>In this part, we add HTTPS support to our web frontend, showing how to have a 
     19single factory listen on multiple ports. More information on using SSL in 
     20Twisted can be found in the <a href="../ssl.xhtml">SSL howto</a>.</p> 
    2021 
    2122<h2>Support HTTPS</h2> 

  • trunk/doc/core/howto/tutorial/index.xhtml

    r10840 r27778  
    2727We will extend this service slightly beyond the standard, in order to  
    2828demonstrate some of Twisted's higher-level features. 
     29</p> 
     30 
     31<p> 
     32Each section of the tutorial dives straight into applications for various 
     33Twisted topics. These topics have their own introductory howtos listed in 
     34the <a href="../index.xhtml">core howto index</a> and in the documentation for 
     35other Twisted projects like Twisted Web and Twisted Words. There are at least 
     36three ways to use this tutorial: you may find it useful to read through the rest 
     37of the topics listed in the <a href="../index.xhtml">core howto index</a> before 
     38working through the finger tutorial, work through the finger tutorial and then 
     39go back and hit the introductory material that is relevant to the Twisted 
     40project you're working on, or read the introductory material one piece at a time 
     41as it comes up in the finger tutorial. 
    2942</p> 
    3043 

  • trunk/doc/core/howto/tutorial/intro.xhtml

    r27174 r27778  
    3636organization. You can also define pseudo "users", which are essentially 
    3737keywords.</p> 
     38 
     39<p>This portion of the tutorial makes use of factories and protocols as 
     40introduced in the <a href="../servers.xhtml">Writing a TCP Server howto</a> and 
     41deferreds as introduced in <a href="../defer.xhtml">Using Deferreds</a> 
     42and <a href="../gendefer.xhtml">Generating Deferreds</a>. Services and 
     43applications are discussed in <a href="../application.xhtml">Using the Twisted 
     44Application Framework</a>.</p> 
    3845 
    3946<p>By the end of this section of the tutorial, our finger server will answer 

  • trunk/doc/core/howto/tutorial/library.xhtml

    r10593 r27778  
    1414href="index.xhtml">Twisted from Scratch, or The Evolution of Finger</a>.</p> 
    1515 
    16 <p>In this part, we separate the application code that launches a finger 
    17 service from the library code which defines a finger service, placing the 
    18 application in a Twisted Application Configuration (.tac) file. We also move 
    19 configuration (such as HTML templates) into separate files.</p> 
     16<p>In this part, we separate the application code that launches a finger service 
     17from the library code which defines a finger service, placing the application in 
     18a Twisted Application Configuration (.tac) file. We also move configuration 
     19(such as HTML templates) into separate files. Configuration and deployment with 
     20.tac and twistd are introduced in <a href="../application.xhtml">Using the 
     21Twisted Application Framework</a>.</p> 
    2022 
    2123<h2>Organization</h2> 

  • trunk/doc/core/howto/tutorial/pb.xhtml

    r24451 r27778  
    1515 
    1616<p>In this part, we add a Perspective Broker service to the finger application 
    17 so that Twisted clients can access the finger server.</p> 
     17so that Twisted clients can access the finger server. Perspective Broker is 
     18introduced in depth in its own <a href="../index.xhtml#pb">section</a> of the 
     19core howto index.</p> 
    1820 
    1921<h2>Use Perspective Broker</h2> 

  • trunk/doc/core/howto/tutorial/protocol.xhtml

    r25523 r27778  
    1616<p>In this section of the tutorial, our finger server will continue to sprout 
    1717features: the ability for users to set finger announces, and using our finger 
    18 service to send those announcements on the web, on IRC and over XML-RPC.</p> 
     18service to send those announcements on the web, on IRC and over XML-RPC. 
     19Resources and XML-RPC are introduced in the Web Applications portion of 
     20the <a href="../../../web/howto/index.xhtml">Twisted Web howto</a>. More examples 
     21using <code class="API">twisted.words.protocols.irc</code> can be found 
     22in <a href="../clients.xhtml">Writing a TCP Client</a> and 
     23the <a href="../../../words/examples/index.xhtml">Twisted Words examples</a>.</p> 
    1924 
    2025<h2>Setting Message By Local Users</h2>