diff options
Diffstat (limited to 'modules/documentation.module')
| -rw-r--r-- | modules/documentation.module | 41 |
1 files changed, 29 insertions, 12 deletions
diff --git a/modules/documentation.module b/modules/documentation.module index 9150be178..5a9aec24e 100644 --- a/modules/documentation.module +++ b/modules/documentation.module @@ -16,7 +16,8 @@ function documentation() { <H1>Chapter 1: introduction</H1> <P>Drupal is the English pronunciation for the Dutch word 'druppel' which means 'drop'. Drupal is a fully-featured content management/discussion engine suitable to setup a news-driven community or portal site. Drupal aims to provide easy installation, excessive configuration and fine-grained maintenance capabilities. Due to its modular design, drupal is flexible and easy to adapt or extend.</P> - <P>Drupal is primarily written by Dries Buytaert (dries_at_drop.org) and built after Slash (<A HREF="http://slashcode.com/">http://slashcode.com/</A>) and Scoop (<A HREF="http://scoop.kuro5hin.org/">http://scoop.kuro5hin.org/</A>).</P> + <P>Drupal is primarily written by Dries Buytaert (dries_at_drop.org) and built after Slash (<A HREF="http://slashcode.com/">http://slashcode.com/</A>) and Scoop (<A HREF="http://scoop.kuro5hin.org/">http://scoop.kuro5hin.org/</A>). Drupal is released under the GNU General Public License (GPL) so if you are interested in helping out the drupal project in any way, drop me an e-mail.</P> + <P>Everybody can download, use and modify drupal to suit his or her needs. Everybody can freely distribute modified or unmodified versions of it, provided that they too are licensed under the GNU GPL. Drupal is maintained by volunteer effort at a best effort basis but you can always contact me or other drupal developers for consulting services related to drupal.</P> <H1>Chapter 2: installation</H1> @@ -40,22 +41,36 @@ function documentation() { <BLOCKQUOTE>$ mysql -h <I><hostname></I> -u <I><username></I> -p<I><password> <database></I> < database/database.mysql</BLOCKQUOTE> <P>5. Rename the configuration file <CODE>includes/hostname.conf</CODE> to match your server's hostname:</P> <BLOCKQUOTE>$ cp includes/hostname.conf includes/www.yourdomain.com.conf</BLOCKQUOTE> + <P><CODE>/</CODE>'s and <CODE>:</CODE>'s are translated to <CODE>.</CODE>'s. So if the URI of your drupal site would be <CODE>http://www.yourdomain.com:80/foo/</CODE> your configuration file should be named <CODE>www.yourdomain.com.80.foo.conf</CODE>.</P> <P>6. Edit your configuration file to set the required settings such as the database options and to customize your site to your likings.</P> <P>7. Launch your browser and point it to http://yourdomain.com/, create an account, log in and head on to http://yourdomain.com/admin.php. The first user will automatically have administrator permissions. Play with it for a bit and spend some time getting used to the administration interfaces.</P> <P>8. Optionally (yet recommended for smooth operation) edit the <CODE>.htaccess</CODE> file and set the values of the PHP variables to your likings: <CODE>session.name</CODE>, <CODE>session.cookie_lifetime</CODE>, <CODE>session.gc_maxlifetime</CODE>, <CODE>session.cache_expire</CODE> and <CODE>session.save_path</CODE>. Check your PHP reference manual for the exact purpose of each variable mentioned.</P> <P>9. Optionally (yet recommended for smooth operation) setup a crontab to periodically visit http://yourdomain.com/cron.php.</P> <P>Use a browser like lynx or wget but make sure the process terminates: either use /usr/bin/lynx -source http://yourdomain.com/cron.php or /usr/bin/wget -O /dev/null http://yourdomain.com/cron.php. Take a look at the example scripts in the <CODE>scripts</CODE>-directory and make sure to adjust them to your needs.</P> <P>A good crontab-line to run the cron-script once every hour would be:</P> - <PRE> - 00 * * * * /home/www/drupal/scripts/cron-lynx - </PRE> + <PRE> 00 * * * * /home/www/drupal/scripts/cron-lynx</PRE> <P>10. Optionally create your site's theme or at least customize the existing themes. To get started, head on to the <CODE>themes</CODE>-directory and make a custom logo for each theme. <P>11. Optionally add and remove modules to customize the functionality of your site. Adding and removing modules is plain easy. You can add a module by copying the files into the <CODE>modules</CODE>-directory and you can remove a module by removing a module's file from the <CODE>modules</CODE>-directory. The drupal engine will then automatically include or exclude this module. If for some reason, this seems to fail, "manually" rehash the modules list from http://yourdomain.com/admin.php?mod=module.</P> <P>12. If you get it to run, let us know at <A HREF="mailto:info@drop.org">info@drop.org</A> so we can add your site to our list of drupal sites. If you can't get it to run, you can find support at the drupal site or you can contact us by e-mail at <A HREF="mailto:info@drop.org">info@drop.org</A>.</P> - <H2>More than one (sub)domain on one machine</H2> + <H2>More then one drupal site on one machine</H2> + + <H3>Multiple directories</H3> + + <P>Drupal allows you to setup multiple drupal sites using different directories on top of one physical source tree. This might be useful if you want to setup multiple sites about different topics (e.g. <CODE>http://yourdomain.com/travel/</CODE> and <CODE>http://yourdomain.com/sport/</CODE>) or if you want to provide users on your system with a personal drupal site (e.g. <CODE>http://yourdomain.com/~joe/</CODE> and <CODE>http://yourdomain.com/~john/</CODE>). When using Unix/Linux as your host operating system, this can be best accomplished by using symbolic links:</P> + <PRE> + $ ls -l includes/*.conf + -rw-rw-r-- 1 drupal drupal includes/yourdomain.com.~joe.conf + </PRE> + <P>Once you created the configuration file, create a fake directory using symbolic links that matches the URI. For a drupal site with URI <CODE>http://yourdomain.com/~joe/</CODE> use:</P> + <BLOCKQUOTE>$ ln -s . ~joe</BLOCKQUOTE> + <P>If you want Joe to be able to configure his own drupal site, create another symbolic link to make the configuration file <CODE>includes/yourdomain.com.~joe.conf</CODE> available to Joe in his home directory:</P> + <BLOCKQUOTE>$ ln -s /path-to-drupal/includes/yourdomain.com.joe.conf /home/joe/</BLOCKQUOTE> + + <H3>More than one domain or vhost one machine</H3> + + <H4>Multiple domains using the same database</H4> - <H3>Multiple (sub)domains using the same database</H3> <P>If you want to host multiple domains (or subdomains) on top of the same database (e.g. http://yourdomain.com/ and http://www.yourdomain.com/), simply use symbolic links to setup the required configuration files:</P> <BLOCKQUOTE>$ ln -s includes/yourdomain.com.conf includes/www.yourdomain.com.conf</BLOCKQUOTE> <PRE> @@ -64,7 +79,8 @@ function documentation() { lrwxrwxrrx 1 drupal drupal includes/www.yourdomain.com.conf -> includes/yourdomain.com.conf </PRE> - <H3>Multiple (sub)domains using different databases</H3> + <H4>Multiple domains or vhosts using different databases</H4> + <P>Apache supports both IP- and name-based virtual hosts (vhosts). While running more than one engine (by using vhosts) can be very useful for development and testing purpose, it might even be more interesting for hosting companies. Therefor, we tried to support vhosts in the best possible way in order to make the life of any administrator easier. We do so by making it possible to run an unlimited amount of vhosts on the same physical source tree, though by using different configuration files. Moreover, you can setup multiple configuration files in your <CODE>includes</CODE>-directory.</P> <PRE> $ ls -l includes/*.conf @@ -88,7 +104,7 @@ function documentation() { <H1>Chapter 3: drupal engine</H1> - <P>While we in no way consider the design and implementation of the drupal engine to be finished, we feel that our own accompanying intensive experience has given us a fairly stable and well-proven design. The following provides a brief over-view of the different aspects of drupal's core engine and features.</P> + <P>While we in no way consider the design and implementation of the drupal engine to be finished, we feel that our own accompanying intensive experience has given us a fairly stable and well-proven design. The following provides a brief over-view of the different aspects of drupal's core engine and features.</P> <H2>Cron</H2> @@ -185,8 +201,8 @@ function documentation() { $theme->header(); // displays the header of a page for each $article to be displayed { - $theme->article($article); - // displays a themed article or story + $theme->article($article); + // displays a themed article or story } $theme->footer(); // displays the footer of a page @@ -227,7 +243,7 @@ function documentation() { <H3>Linux</H3> <P>To gain access via (anonymous) CVS use the following steps. In this example it is assumed that you want a copy of the drupal source code.</P> - <P>1. Install a recent copy of CVS. All you really need is a copy of the CVS client binary. Alternatively you can download the latest CVS source code from <A HREF="http://www.cyclic.com">Cyclic Software</A>. Don't worry: CVS is free software under the GNU GPL.</P> + <P>1. Install a recent copy of CVS. All you really need is a copy of the CVS client binary. Alternatively you can download the latest CVS source code from <A HREF="http://www.cyclic.com">Cyclic Software</A>. Don't worry: CVS is free .</P> <P>2. Set CVSROOT in your environment:</P> <BLOCKQUOTE>$ export CVSROOT=":pserver:anonymous@drop.org:/home/dries/cvs"</BLOCKQUOTE> <P>3. Login by running the command:</P> @@ -251,6 +267,7 @@ function documentation() { <P>If you can want to interface the CVS repository just like Linux users do (raw and uncut), then check <A HREF="http://oodt.jpl.nasa.gov/doc/developers-resources/developing/windows/index.html">this site</A>.</P> <H3>Additional references</H3> + <UL> <LI><A HREF="http://cvsbook.red-bean.com/">CVS book</A></LI> <LI><A HREF="http://www.loria.fr/~molli/cvs/doc/cvs_toc.html">CVS docs</A></LI> @@ -281,4 +298,4 @@ function documentation() { <P>5. <B>Mail or submit the patch:</B><BR>Remember: no MIME, no HTML mail, no links, no compression, no attachments. Just plain text.</P> <? } -?> +?>
\ No newline at end of file |