You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ro...@apache.org on 2007/12/20 20:08:11 UTC
svn commit: r606001 - in /httpcomponents/project/src/site: apt/dev-docs.apt
apt/user-docs.apt site.xml
Author: rolandw
Date: Thu Dec 20 11:08:10 2007
New Revision: 606001
URL: http://svn.apache.org/viewvc?rev=606001&view=rev
Log:
documentation indices for users (real) and developers (dummy)
Added:
httpcomponents/project/src/site/apt/dev-docs.apt
httpcomponents/project/src/site/apt/user-docs.apt
Modified:
httpcomponents/project/src/site/site.xml
Added: httpcomponents/project/src/site/apt/dev-docs.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/dev-docs.apt?rev=606001&view=auto
==============================================================================
--- httpcomponents/project/src/site/apt/dev-docs.apt (added)
+++ httpcomponents/project/src/site/apt/dev-docs.apt Thu Dec 20 11:08:10 2007
@@ -0,0 +1,49 @@
+~~ $HeadURL$
+~~ $Revision$
+~~ $Date$
+~~
+~~ ====================================================================
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+~~ ====================================================================
+~~
+~~ This software consists of voluntary contributions made by many
+~~ individuals on behalf of the Apache Software Foundation. For more
+~~ information on the Apache Software Foundation, please see
+~~ <http://www.apache.org/>.
+
+ -----------
+ Developer Documentation Index
+
+Developer Documentation
+
+ You are a developer of HttpComponents if you are developing code or
+ documentation for the components themselves.
+
+ Unfortunately, this page is currently mostly a dummy. It will eventually
+ point you to information about setting up a development environment,
+ submitting patches, and updating information on the website.
+ For the time being, the documentation on cutting releases may include
+ some interesting pieces of information for you.
+
+Release Process
+
+ * {{{http://wiki.apache.org/jakarta-httpclient/HttpComponentsCoreReleaseProcess}
+ HttpComponents Core Release Process}}
+
+ * {{{http://wiki.apache.org/jakarta-httpclient/HttpClientReleaseProcess}
+ Commons HttpClient 3.1 Process}}
Added: httpcomponents/project/src/site/apt/user-docs.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/user-docs.apt?rev=606001&view=auto
==============================================================================
--- httpcomponents/project/src/site/apt/user-docs.apt (added)
+++ httpcomponents/project/src/site/apt/user-docs.apt Thu Dec 20 11:08:10 2007
@@ -0,0 +1,120 @@
+~~ $HeadURL$
+~~ $Revision$
+~~ $Date$
+~~
+~~ ====================================================================
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+~~ ====================================================================
+~~
+~~ This software consists of voluntary contributions made by many
+~~ individuals on behalf of the Apache Software Foundation. For more
+~~ information on the Apache Software Foundation, please see
+~~ <http://www.apache.org/>.
+
+ -----------
+ User Documentation Index
+
+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
+ to help you understand how to use these libraries.
+
+ The <<General Information>> section points to documentation that is
+ mostly API agnostic.
+ Here you will find information that is useful, no matter whether you are
+ using the new HttpComponents, or the Commons HttpClient 3.1, or even the
+ standard Java HttpUrlConnection.
+ Of course we put no emphasis on the latter.
+
+ The <<API Specific Information>> section points to documentation for
+ specific APIs, either the new HttpComponents, or the Commons HttpClient 3.1.
+ Using the information there with other APIs will be tricky,
+ if not impossible.
+
+
+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\
+ information for that.
+ Once you are tackling more specific use cases, such as sending parameters
+ to a servlet, or configuring a proxy within an applet, some of the FAQs
+ may prove helpful.
+
+ * {{{http://wiki.apache.org/jakarta-httpclient/ForAbsoluteBeginners}
+ Client HTTP Programming Primer}} -
+ The Primer describes how to submit an HTML form to a web server and
+ retrieve the results. HTML forms are often used as login forms, so the
+ Primer also tells you how to perform form-based login in your application.
+
+ * {{{http://wiki.apache.org/jakarta-httpclient/FrequentlyAskedApplicationDesignQuestions}
+ Application Design FAQ}} -
+ This FAQ addresses problems such as uploading files and configuring proxies
+ based on JVM settings. It also explains the different ways in which a client
+ may authenticate against a server.
+
+ * {{{http://wiki.apache.org/jakarta-httpclient/FrequentlyAskedConnectionManagementQuestions}
+ Connection Management FAQ}} -
+ This FAQ addresses questions related to connection management, for example
+ where sockets in state TIME_WAIT come from. Although the API is different,
+ connection management in the new HttpClient works similar to that in the
+ Commons HttpClient 3.1. The standard Java HttpUrlConnection also manages
+ connections, though we're not really concerned about that.
+
+ * {{{http://wiki.apache.org/jakarta-httpclient/FrequentlyAskedNTLMQuestions}
+ NTLM FAQ}} -
+ The limited support of HttpClient for NTLM authentication is addressed
+ by this FAQ.
+
+
+API Specific Information
+
+* JavaDocs
+
+ * {{{./httpcomponents-core/httpcore/apidocs/index.html}HttpCore (main)}}
+
+ * {{{./httpcomponents-core/httpcore-nio/apidocs/index.html}HttpNIO}}
+
+ * {{{./httpcomponents-client/httpclient/apidocs/index.html}HttpClient}}
+
+ * {{{./httpclient-3.x/apidocs/index.html}Commons HttpClient 3.1}}
+
+
+* HttpComponents
+
+ * {{{http://wiki.apache.org/jakarta-httpclient/HttpComponents}
+ Informal Units of HttpComponents}}
+
+ * {{{http://wiki.apache.org/jakarta-httpclient/GuidedTourOfHttpCore}
+ A Guided Tour Of HttpCore}}
+
+
+* Commons HttpClient 3.1
+
+ * {{{./httpclient-3.x/tutorial.html}Tutorial}} -
+ Explains how to use HttpClient 3.1 in simple scenarios.
+ The concepts still apply to the new HttpClient 4.0,
+ but the API has changed completely.
+
+ * {{{./httpclient-3.x/troubleshooting.html}Troubleshooting}} -
+ Explains how to avoid common errors, and how to report the uncommon ones.
+
+ * {{{./httpclient-3.x/userguide.html}User Guide}} -
+ The HttpClient 3.1 User Guide is a selection of guides for specific topics
+ such as Authentication, Multi-Threaded Applications, SSL, and others.
Modified: httpcomponents/project/src/site/site.xml
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/site.xml?rev=606001&r1=606000&r2=606001&view=diff
==============================================================================
--- httpcomponents/project/src/site/site.xml (original)
+++ httpcomponents/project/src/site/site.xml Thu Dec 20 11:08:10 2007
@@ -56,6 +56,10 @@
<item name="Download" href="download.html"/>
<item name="Wiki (external)" href="http://wiki.apache.org/jakarta-httpclient/FrontPage"/>
</menu>
+ <menu name="Documentation">
+ <item name="For Users" href="user-docs.html"/>
+ <item name="For Developers" href="dev-docs.html"/>
+ </menu>
<menu name="Components">
<item name="HttpCore" href="httpcomponents-core/index.html"/>
<item name="HttpClient" href="httpcomponents-client/index.html"/>