Changed documentation to asciidoc

git-svn-id: svn://cherokee-project.com/cherokee/trunk@1647 5dc97367-97f1-0310-9951-d761b3857238

doc/Makefile.am

@@ -1,4 +1,11 @@
-docdir = $(datadir)/doc/cherokee/
+ASCIIDOC=$(top_srcdir)/doc/build/asciidoc.py -b xhtml11 --conf-file=$(top_srcdir)/doc/build/chunked_template.conf -a cherokee_version=$(PACKAGE_VERSION)
+
+SUFFIXES = .txt .html
+
+.txt.html:
+	$(ASCIIDOC) -o $@ $< 
+
+docdir = $(datadir)/doc/cherokee
 doc_DATA = \
 index.html \
 authentication.html \
@@ -14,47 +21,47 @@ internal_configuration.html \
 advanced.html \
 admin.html \
 download.html \
-How_to_generate_SSL_keys.html \
+generating_ssl_keys.html \
 icons.html
 
-dochandlersdir = $(docdir)handlers/
+dochandlersdir = $(docdir)/
 dochandlers_DATA = \
-handlers/file.html \
-handlers/dirlist.html \
-handlers/common.html \
-handlers/redir.html \
-handlers/cgi.html \
-handlers/fastcgi.html \
-handlers/scgi.html
-
-docloggersdir = $(docdir)loggers/
+modules_handlers_file.html \
+modules_handlers_dirlist.html \
+modules_handlers_common.html \
+modules_handlers_redir.html \
+modules_handlers_cgi.html \
+modules_handlers_fastcgi.html \
+modules_handlers_scgi.html
+
+docloggersdir = $(docdir)/
 docloggers_DATA = \
-loggers/combined.html \
-loggers/ncsa.html \
-loggers/w3c.html
+modules_loggers_combined.html \
+modules_loggers_ncsa.html \
+modules_loggers_w3c.html
 
-docencodersdir = $(docdir)encoders/
+docencodersdir = $(docdir)/
 docencoders_DATA = \
-encoders/gzip.html
+modules_encoders_gzip.html
 
-docbalancersdir = $(docdir)balancers/
+docbalancersdir = $(docdir)/
 docbalancers_DATA = \
-balancers/round_robin.html
+modules_balancers_round_robin.html
 
-docvalidatorsdir = $(docdir)validators/
+docvalidatorsdir = $(docdir)/
 docvalidators_DATA = \
-validators/htdigest.html \
-validators/htpasswd.html \
-validators/ldap.html \
-validators/mysql.html \
-validators/pam.html \
-validators/plain.html
-
-docmediacssdir = $(docdir)media/css/
+modules_validators_htdigest.html \
+modules_validators_htpasswd.html \
+modules_validators_ldap.html \
+modules_validators_mysql.html \
+modules_validators_pam.html \
+modules_validators_plain.html
+
+docmediacssdir = $(docdir)/media/css/
 docmediacss_DATA = \
-media/css/documentation.css
+media/css/cherokee_doc.css
 
-docmediaimagesdir = $(docdir)media/images/
+docmediaimagesdir = $(docdir)/media/images/
 docmediaimages_DATA = \
 media/images/admin_handler_fastcgi2.png \
 media/images/admin_index.png \
@@ -97,7 +104,3 @@ $(docmediaimages_DATA)
 
 CLEANFILES = \
 $(GENERATED_FILES) 
-
-.NOTPARALLEL: $(GENERATED_FILES)
-$(GENERATED_FILES):
-	python $(top_srcdir)/doc/build_docs.py -v

doc/admin.txt

@@ -0,0 +1,25 @@
+Cherokee Admin
+--------------
+
+This section describes the Cherokee configuration admin interface. It is designed to
+make the configuration of the cherokee web server really easy.
+
+If cherokee is going to be running in the same host, just use:
+----
+$ cherokee-admin
+----
+And redirect your internet browser to 127.0.0.1:9090. By default, the interface will
+be listening on port 9090 at 127.0.0.1. There are some advanced options thought:
+
+    * *-h*: Show usage
+    * *-a*: Listen all interfaces
+    * *-C*: Use a different configuration file
+    * *-d*: Use a custom admin-interface path
+
+Example:
+----
+$ cherokee-admin -a -P 9091 -C /etc/cherokee/cherokee2.conf \
+                 -d /path/to/svn/trunk/cherokee-admin/
+----
+image::media/images/admin_launch.png[Cherokee admin interface]
+

doc/advanced.txt

@@ -0,0 +1,7 @@
+Advanced Configuration
+----------------------
+
+To be written
+
+image::media/images/admin_advanced.png[Cherokee Admin interface]
+

doc/locale/en/authentication.txt → doc/authentication.txt

@@ -1,24 +1,20 @@
 Authentication
-==============
+--------------
 
 There are two types of authentication:
 
-*basic*
+*basic*::
     This method sends the username and password in clear text over the network.
     It is not the most secure method.  If the connection to the web server is
     through HTTPS then this method is as secure as the encryption used.  This
     method is very easy to implement, so most clients support it.
 
-*digest*
+*digest*::
     This method is by far the most secure, but also more complex.  Most modern
     web browsers support this method.
 
-Cherokee comes with a number of validators: htpasswd_, htdigest_, PAM_, LDAP_,
-MySQL_, and a plain_ text file.
+Cherokee comes with a number of validators: link:modules_validators_htpasswd.html[htpasswd], 
+link:modules_validators_htdigest.html[htdigest], link:modules_validators_pam.html[PAM], 
+link:modules_validators_ldap.html[LDAP], link:modules_validators_mysql.html[MySQL], 
+and a link:modules_validators_plain.html[plain] text file.
 
-.. _htdigest: validators/htdigest.html
-.. _htpasswd: validators/htpasswd.html
-.. _LDAP: validators/ldap.html
-.. _MySQL: validators/mysql.html
-.. _PAM: validators/pam.html
-.. _plain: validators/plain.html