Documentation update

SVN Revision: 445

ChangeLog

@@ -1,3 +1,13 @@
+2005-11-28  Mickael Remond  <mickael.remond@process-one.net>
+
+	* doc/guide.tex: Improved and updated documentation (Thanks to Sander
+        Devrieze)
+	* doc/guide.html: Likewise
+	* doc/features.tex: Likewise
+	* doc/introduction.tex: Likewise
+	* doc/version.tex: Likewise
+	* doc/logo.png: New logo for ejabberd doc (Thanks to Sander Devrieze)
+
 2005-11-26  Alexey Shchepin  <alexey@sevcom.net>
 
 	* src/web/ejabberd_http.erl: Now web interface is compliant to

doc/introduction.tex

@@ -0,0 +1,131 @@
+\section{Introduction}
+\label{sec:intr}
+
+\quoting{I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. --
+Joeri} 
+
+\ejabberd{} is a free (GPL) distributed fault-tolerant \Jabber{}/XMPP server and is mainly written in \footahref{http://www.erlang.org/}{Erlang}.
+
+\ejabberd{} is designed to be a \marking{stable} and \marking{feature rich} \Jabber{}/XMPP server.
+
+\ejabberd{} is suitable for small servers, whether they need to be scalable or not, as well as extremely big servers.
+
+%\subsection{Layout with example deployment (title needs a better name)}
+
+%In this section there will be a graphical overview like these:\\
+%\verb|http://www.tipic.com/var/timp/timp_dep.gif| \\
+%\verb|http://www.jabber.com/images/jabber_Com_Platform.jpg| \\
+%\verb|http://www.antepo.com/files/OPN45systemdatasheet.pdf| \\
+
+%Some small images of Jabber clients that are known to work greatly with ejabberd. Less text!!!
+
+%\subsection{Try It Today}
+
+%(Not sure if I will include/finish this section for the next version.)
+
+%\begin{itemize}
+%\item Erlang REPOS
+%\item Packages in distributions
+%\item Windows binary
+%\item source tar.gz
+%\item Migration from Jabberd14 (and so also Jabberd2 because you can migrate from version 2 back to 14) and Jabber Inc. XCP possible.
+%\end{itemize}
+
+\newpage
+\subsection{Key Features}
+\label{sec:keyfeatures}
+\ind{features!key features}
+
+\quoting{Erlang seems to be tailor-made for writing stable, robust servers. --
+Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation}
+
+\ejabberd{} is:
+\begin{itemize}
+\item \marking{Multiplatform:} \ejabberd{} runs under Windows NT/2000/XP and Unix derived systems such as Linux, FreeBSD and NetBSD.
+
+\item \marking{Distributed:} You can run \ejabberd{} on a cluster of machines and all of them will serve one \Jabber{} domain. When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support hundreds of concurrent users.
+
+\item \marking{Fault-tolerant:} You can deploy an \ejabberd{} cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ``on the fly''.
+  
+\item \marking{Administrator Friendly:} \ejabberd{} is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already installed, and ready to run out of the box. Other benefits for administrators include:
+\begin{itemize}
+\item Comprehensive documentation.\moreinfo{ --- You can start in the \footahref{http://ejabberd.jabber.ru/book}{ejabberd Book}.}
+\item Straightforward installers for Windows and Linux.\moreinfo{ --- (\footahref{http://ejabberd.jabber.ru/screenshots-linux-installer}{Screenshots}).}
+\item Web interface for administration tasks.\moreinfo{ --- With HTTPS secure access. \footahref{http://ejabberd.jabber.ru/online-demo-webadmin}{Demo}.}
+\item Shared Roster groups.\improved{}\moreinfo{ --- The administrator can setup a common list of \Jabber{} users for all users on the server. Those users are virtually added to all rosters. They cannot be removed, but can be renamed or moved into different roster groups. Does not require client implementation. Not related to \jepref{0144} (Roster Item Exchange).\footahref{http://ejabberd.jabber.ru/screenshots-shared-roster-groups}{Screenshots})}
+\item Command line administration tool.\moreinfo{ --- Some basic administration tasks can be acomplished using the command line: register/remove users, backup/restore database, amongst others (\footahref{http://ejabberd.jabber.ru/screenshots-administration#ejabberdctl}{Screenshots}).}
+\item Can integrate with existing authentication mechanisms.
+\item Capability to send announce messages.
+\item Statistics via \jepref{0039} (Statistics Gathering).
+\end{itemize}
+
+\item \marking{Internationalized:} \ejabberd{} leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
+
+\begin{itemize}
+\item Translated in 11 languages.\moreinfo{ --- More information is available \footahref{http://ejabberd.jabber.ru/localization}{here}.}
+\item Support for \footahref{http://www.ietf.org/rfc/rfc3490.txt}{IDNA}.
+\item Support for \ns{xml:lang}.
+\end{itemize}
+
+\item \marking{Modular:} \ejabberd{}'s modular architecture allows easy customization:
+\begin{itemize}
+\item Load only the modules you want.
+\item Extend \ejabberd{} with your own custom modules.\moreinfo{ --- A list of contributed modules and patches is available on the \footahref{http://ejabberd.jabber.ru/contributions}{contributions page}.}
+\end{itemize}
+
+
+\end{itemize}
+
+\newpage
+
+\subsection{Additional Features}
+\label{sec:addfeatures}
+\ind{features!additional features}
+
+\quoting{ejabberd is making inroads to solving the "buggy incomplete server" problem --
+Justin Karneges, Founder of the Psi and the Delta projects}
+
+Besides common \Jabber{} server features, \ejabberd{} comes with a wide range of other features:
+\begin{itemize}
+\item The ability to interface via external components with networks such as:
+\begin{itemize}
+\item AIM
+\item ICQ
+\item MSN
+\item Yahoo!
+\end{itemize}
+\item Open Standards
+\begin{itemize}
+\item \footahref{http://ejabberd.jabber.ru/protocols}{Many JEPs supported}.
+\item XML-based protocol
+\item Fully XMPP compliant for c2s connections (Core \& IM) \moreinfo{ --- ejabberd supports all XMPP Core 1.0 and XMPP IM 1.0, or is close to it. Check the \footahref{http://ejabberd.jabber.ru/protocols}{supported protocols}.}
+\end{itemize}
+\item Security
+\begin{itemize}
+\item SASL and STARTTLS for c2s connections.
+\item STARTTLS and Dialback s2s connections.\new{}
+\item Obsolete SSL for c2s connections also supported.
+\item Web interface accessible via HTTPS secure access.
+\end{itemize}
+\item Databases
+\begin{itemize}
+\item Mnesia.
+\item ODBC data storage support (tested against PostgreSQL). \moreinfo{ --- ODBC requests can be load balanced between several connections.}
+\end{itemize}
+\item Authentication
+\begin{itemize}
+\item LDAP. \moreinfo{ --- Accounts can authenticate in a LDAP server.}
+\item External Authentication script.
+\item Internal Authentication.
+\end{itemize}
+\item Others
+\begin{itemize}
+\item IPv6 support both for c2s and s2s connections. 
+\item Support for virtual hosting. \moreinfo{ --- Several \Jabber{} hosts can be hosted on the same \ejabberd{} instance. As simple as adding a new domain name to the list of hosts in the configuration file.}
+\item \tjepref{0025}{HTTP Polling} service
+\item \tjepref{0045}{Multi-User Chat} module.
+\item IRC transport.
+\item \tjepref{0060}{Publish-Subscribe} component.
+\item Users Directory based on users vCards.
+\end{itemize}
+\end{itemize}

doc/version.tex

@@ -0,0 +1,2 @@
+% Define ejabberd version here.
+\newcommand{\version}{0.9.9-alpha}