hc-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ol...@apache.org
Subject svn commit: r806498 - in /httpcomponents/project/src/site/apt: charter.apt commons-httpclient-lessons.apt goals.apt index.apt mail.apt status.apt user-docs.apt
Date Fri, 21 Aug 2009 11:16:43 GMT
Author: olegk
Date: Fri Aug 21 11:16:43 2009
New Revision: 806498

URL: http://svn.apache.org/viewvc?rev=806498&view=rev
HTTPCLIENT-868: Add anchors to documentation sections


Modified: httpcomponents/project/src/site/apt/charter.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/charter.apt?rev=806498&r1=806497&r2=806498&view=diff
--- httpcomponents/project/src/site/apt/charter.apt (original)
+++ httpcomponents/project/src/site/apt/charter.apt Fri Aug 21 11:16:43 2009
@@ -36,7 +36,7 @@
 ~~ Changes to the Charter require PMC approval.
 ~~ DO NOT EDIT the "Charter" section, not even to fix typos.
   The Apache HttpComponents project is responsible for creating and
   maintaining a toolset of low level Java components focused on HTTP
@@ -73,7 +73,7 @@
   The history of the HttpComponents starts with the now retired
   {{{http://jakarta.apache.org/slide/}Jakarta Slide}} project.
@@ -107,7 +107,7 @@
   Our TLP resolution is presented below.
   The Apache HttpComponents project was established
   as an Apache top level project in November 2007,

Modified: httpcomponents/project/src/site/apt/commons-httpclient-lessons.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/commons-httpclient-lessons.apt?rev=806498&r1=806497&r2=806498&view=diff
--- httpcomponents/project/src/site/apt/commons-httpclient-lessons.apt (original)
+++ httpcomponents/project/src/site/apt/commons-httpclient-lessons.apt Fri Aug 21 11:16:43
@@ -39,7 +39,7 @@
     listed below emerged during our work with HttpClient and prompted our action. HttpComponents

     is an attempt to address these issues.
-* Monolithic design of Commons HttpClient
+* {Monolithic design of Commons HttpClient}
     * The use patterns of Commons HttpClient have evolved much since its first release. We

     have found HttpClient used in applications it was never specifically designed 
@@ -56,7 +56,7 @@
     server side. More application specific aspects of HTTP, however, cannot be adequately

     represented by one monolithic library. 
-* Inherent API deficiencies of Commons HttpClient
+* {Inherent API deficiencies of Commons HttpClient}
     * HttpMethod interface, one of the most fundamental interfaces in Commons HttpClient,

     is inherently flawed. It tightly couples the HTTP request and HTTP response and implies
@@ -73,7 +73,7 @@
     introduce a common behavior across all standard HTTP methods, one would have to 
     subclass all the existing subclasses of the HttpMethodBase: GetMethod, PostMethod, etc.
-* External dependencies
+* {External dependencies}
     * One of the most frequently cited complaints is its dependency on Commons Logging and

     Commons Codec. We would like to give the users an option to use core HTTP components

Modified: httpcomponents/project/src/site/apt/goals.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/goals.apt?rev=806498&r1=806497&r2=806498&view=diff
--- httpcomponents/project/src/site/apt/goals.apt (original)
+++ httpcomponents/project/src/site/apt/goals.apt Fri Aug 21 11:16:43 2009
@@ -41,7 +41,7 @@
     {{{commons-httpclient-lessons.html}Lessons Learned - Jakarta Commons HttpClient}}
-* Componentized design
+* {Componentized design}
     * People use HTTP in varied and unexpected ways such as spiders, HTTP proxies, web servers,

     web clients, and many more. It is not feasible that one monolithic library could cater
@@ -59,7 +59,7 @@
     one of the {{{commons-httpclient-lessons.html}major deficiencies}} discovered in the
-* Minimal external dependencies
+* {Minimal external dependencies}
     * HttpComponents strives to minimize the use of external dependencies in the low level
     components to make them easier to integrate with complex systems that may depend on a

Modified: httpcomponents/project/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/index.apt?rev=806498&r1=806497&r2=806498&view=diff
--- httpcomponents/project/src/site/apt/index.apt (original)
+++ httpcomponents/project/src/site/apt/index.apt Fri Aug 21 11:16:43 2009
@@ -44,9 +44,9 @@
     applications such as web browsers, web spiders, HTTP proxies, web service transport 
     libraries, or systems that leverage or extend the HTTP protocol for distributed communication.

-HttpComponents Structure
+{HttpComponents Structure}
-* HttpComponents Core
+* {HttpComponents Core}
     {{{httpcomponents-core/index.html}HttpCore}} is a set of low level HTTP transport components

     that can be used to build custom client and server side HTTP services with a minimal
@@ -63,7 +63,7 @@
     * HttpCore {{{httpcomponents-core/examples.html}Samples}}
-* HttpComponents Client
+* {HttpComponents Client}
     {{{httpcomponents-client/index.html}HttpClient}} is a HTTP/1.1 compliant HTTP agent 
     implementation based on HttpCore. It also provides reusable components for client-side

@@ -76,7 +76,7 @@
     * HttpClient {{{httpcomponents-client/examples.html}Samples}}
-* Commons HttpClient (legacy)
+* {Commons HttpClient (legacy)}
     The Apache HttpComponents project is charged with developing and maintaining 
     {{{http://hc.apache.org/httpclient-3.x/index.html}Commons HttpClient}}.

Modified: httpcomponents/project/src/site/apt/mail.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/mail.apt?rev=806498&r1=806497&r2=806498&view=diff
--- httpcomponents/project/src/site/apt/mail.apt (original)
+++ httpcomponents/project/src/site/apt/mail.apt Fri Aug 21 11:16:43 2009
@@ -29,7 +29,7 @@
    HttpComponents Mailing Lists
-About Mailing Lists
+{About Mailing Lists}
    A mailing list is an electronic discussion forum that you can subscribe to.
    Once you are subscribed, you will receive every email that is sent to the
@@ -53,7 +53,7 @@
    not a help resource for HttpComponents.
-Research First
+{Research First}
    Before you post a question to a mailing list, make sure it isn't
    already answered. Read the available documentation. Search the web,
@@ -68,7 +68,7 @@
    them to locate the old mail than to write down the answer again.
-Choose The Appropriate Forum
+{Choose The Appropriate Forum}
    Different kinds of questions are discussed in different forums.
    It is important to choose the right forum for your question.
@@ -90,7 +90,7 @@
      "Choose your forum carefully"}}.
    It basically tells you the same stuff you'll find below.
-* User List
+* {User List}
    If you develop an application that <<uses>> HttpClient, and you need
    advice on how to achieve something with it, post your question to the
@@ -102,7 +102,7 @@
    And if somebody else asks a question you can answer, please do so!
-* Developer List
+* {Developer List}
    If you want to discuss <<development of HttpComponents>>, post your
    question or suggestion to the <<dev>> list. The developer list is used
@@ -110,7 +110,7 @@
    Bug reports and comments filed in {{{./issue-tracking.html}JIRA}} will
    automatically be sent to this list, too.
-* Issue Tracking
+* {Issue Tracking}
    We are using {{{./issue-tracking.html}JIRA}} as our issue tracking system.
    Although this is not a mailing list, and should not be abused as a general
@@ -127,7 +127,7 @@
    first. Most developers are monitoring both lists, and we will tell you
    if you should open a new issue.
-* Personal Mail
+* {Personal Mail}
    <<Never>> send a question directly to one of the people you have seen
    active on the mailing lists, or whose email address you've found in
@@ -152,7 +152,7 @@
    Just make sure that your next question goes to the mailing list again.
-Shape Your Mail
+{Shape Your Mail}
    Some of the people reading your mail will be processing dozens or hundreds
    of mails daily. To get their attention and a quick reply, it is important
@@ -203,7 +203,7 @@
    they might be able to help you.
-The Lists
+{The Lists}
    The HttpComponents project currently uses the following lists.
    Clicking on a list name will take you to a page with subscribe,
@@ -233,7 +233,7 @@
    There is no public archive.
-Subscribe And Unsubscribe
+{Subscribe And Unsubscribe}
    To subscribe to the list "<xxx>", send a mail to

Modified: httpcomponents/project/src/site/apt/status.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/status.apt?rev=806498&r1=806497&r2=806498&view=diff
--- httpcomponents/project/src/site/apt/status.apt (original)
+++ httpcomponents/project/src/site/apt/status.apt Fri Aug 21 11:16:43 2009
@@ -34,7 +34,7 @@
 HttpComponents Project Status
-* HttpComponents HttpCore 4.0
+* {HttpComponents HttpCore 4.0}
     HttpCore 4.0 is considered stable and ready for use in production. We are working on
     improvements and performance optimizations for 4.1 release.
@@ -42,12 +42,12 @@
     The HttpCore forms the foundation of HttpClient 4.0 and can also be used separately to
     custom client- and server-side HTTP services.
-* HttpComponents HttpClient 4.0
+* {HttpComponents HttpClient 4.0}
     HttpClient 4.0 is considered stable and ready for use in production. We are working on

     incremental improvements and performance optimizations for the 4.1 release.
-* Commons HttpClient 3.1.x
+* {Commons HttpClient 3.1.x}
     The 3.1 branch of Commons HttpClient is now nearing its end of life. Major bugs will
still be 
     fixed, but no new features added. No more public releases are expected.

Modified: httpcomponents/project/src/site/apt/user-docs.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/user-docs.apt?rev=806498&r1=806497&r2=806498&view=diff
--- httpcomponents/project/src/site/apt/user-docs.apt (original)
+++ httpcomponents/project/src/site/apt/user-docs.apt Fri Aug 21 11:16:43 2009
@@ -29,7 +29,7 @@
    User Documentation Index
-User Documentation
+{User Documentation}
    You are a user of HttpComponents if you are developing an application
    that makes use of our libraries. The documentation linked here is meant
@@ -48,7 +48,7 @@
    if not impossible.
-General Information
+{General Information}
    If you are just getting started, you'll probably start by retrieving
    some pages from a web server. The <<Primer>> will give you valuable
@@ -76,9 +76,9 @@
    Commons HttpClient 3.1. The standard Java HttpUrlConnection also manages
    connections, though we're not really concerned about that.
-API Specific Information
+{API Specific Information}
-* Official tutorials and guides
+* {Official tutorials and guides}
     * {{{httpcomponents-core/tutorial/html/}HttpCore tutorial}} - 
     Detailed HttpCore API tutorail.
@@ -92,7 +92,7 @@
     * {{{httpcomponents-client/logging.html}Logging guide}} -
     How to enable internal context / wire logging in HttpClient.
-* JavaDocs
+* {JavaDocs}
     * {{{httpcomponents-core/httpcore/apidocs/index.html}HttpCore API}}
@@ -102,7 +102,7 @@
     * {{{httpcomponents-client/httpmime/apidocs/index.html}HttpMime API}}
-* Example Code
+* {Example Code}
     * {{{http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/examples/org/apache/http/examples/}
@@ -118,7 +118,7 @@
     Example code is meant to help you understand the API. It is also shipped with releases.
-* Code contributions
+* {Code contributions}
     * {{{http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/contrib/src/main/java/org/apache/http/contrib/}
@@ -126,14 +126,14 @@
     Contribution code can provide useful additional functionality or examples.
     It is <not supported>, and not shipped with releases.
-* User contributed documentation
+* {User contributed documentation}
    * {{{http://wiki.apache.org/HttpComponents/GeneralHttpCoreIntroduction}
        Building custom HTTP agents based on HttpCore}} -
    The tutorial provides a general introduction into the HttpCore API and 
    explains in details how to build a custom HTTP agent based on HttpCore.
-* Commons HttpClient 3.1 (legacy)
+* {Commons HttpClient 3.1 (legacy)}
   * {{{httpclient-3.x/tutorial.html}Tutorial}} -
     Explains how to use HttpClient 3.1 in simple scenarios.

View raw message