[interchange-docs] xmldocs - docelic modified 7 files

docs at icdevgroup.org docs at icdevgroup.org
Sat Apr 8 20:20:04 EDT 2006


User:      docelic
Date:      2006-04-09 00:20:04 GMT
Modified:  docbook  literals.ent
Modified:  glossary ITL epoch hello-world
Modified:  guides   index.xml install.xml
Added:     glossary Minivend
Log:
- docbook/literals.ent: new literal for Wikipedia, ℘
- glossary/*: new or updates
- guides/index.html: link to our own install guide, now that it's there
- guides/install.html: some fixes

Revision  Changes    Path
1.34      +3 -1      xmldocs/docbook/literals.ent


rev 1.34, prev_rev 1.33
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- literals.ent	29 Mar 2006 21:17:15 -0000	1.33
+++ literals.ent	9 Apr 2006 00:20:03 -0000	1.34
@@ -1,6 +1,7 @@
 
 <!-- first IC release shipping with xmldocs -->
 <!ENTITY first-xmldocs-release "5.4">
+<!ENTITY PERL_VER_REQUIRED "5.6">
 
 <!-- GENERAL ENTITIES -->
 <!ENTITY GNU "<ulink url='http://www.gnu.org'>GNU</ulink>">
@@ -33,6 +34,7 @@
 <!ENTITY SVG "<ulink url='http://www.w3.org/TR/SVG/'>SVG</ulink>">
 <!ENTITY QBOOKS "<ulink url='http://quickbooks.intuit.com/'>Intuit QuickBooks</ulink>">
 <!ENTITY SOAP "<ulink url='http://www.w3.org/TR/soap/'>SOAP</ulink>">
+<!ENTITY WP "<ulink url='http://www.wikipedia.org/'>Wikipedia</ulink>">
 
 
 
@@ -79,7 +81,7 @@
 under the terms of the GNU General Public License as published by the
 Free Software Foundation; either version 2 of the License, or (at your
 option) any later version.</para>">
-<!ENTITY DEF_SEEALSO "">
+<!ENTITY DEF_SEEALSO ""> <!-- needs to stay empty -->
 <!ENTITY DEF_PURPOSE ""> <!-- needs to stay empty -->
 <!ENTITY DEF_STRUCTURE "None.">
 <!ENTITY DEF_FILTER_TYPE "Unspecified.">



1.14      +1 -2      xmldocs/glossary/ITL


rev 1.14, prev_rev 1.13
Index: ITL
===================================================================
RCS file: /var/cvs/xmldocs/glossary/ITL,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- ITL	19 Nov 2005 22:37:40 -0000	1.13
+++ ITL	9 Apr 2006 00:20:03 -0000	1.14
@@ -1,8 +1,7 @@
 &IC; functions can be accessed via the Interchange Tag Language (&glos-ITL;).
 The pages in a catalog may be mostly &glos-HTML;, but they will use ITL tags
 to provide dynamic content and access Interchange functions in general.
-ITL is a superset of MML, or Minivend Markup Language.
-Minivend was the predecessor to Interchange.  
+ITL is a superset of MML, or &glos-Minivend; Markup Language.
 </para><para>
 These ITL tags perform various display and modification operations for
 the user session. There's more than 200 standard predefined tags, and the



1.3       +1 -0      xmldocs/glossary/epoch


rev 1.3, prev_rev 1.2
Index: epoch
===================================================================
RCS file: /var/cvs/xmldocs/glossary/epoch,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- epoch	15 Dec 2004 14:24:00 -0000	1.2
+++ epoch	9 Apr 2006 00:20:03 -0000	1.3
@@ -0,0 +1 @@
+<ulink url='http://en.wikipedia.org/wiki/Unix_epoch'>Unix Epoch</ulink> resource at &WP;.



1.3       +2 -2      xmldocs/glossary/hello-world


rev 1.3, prev_rev 1.2
Index: hello-world
===================================================================
RCS file: /var/cvs/xmldocs/glossary/hello-world,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- hello-world	15 Dec 2004 14:24:00 -0000	1.2
+++ hello-world	9 Apr 2006 00:20:03 -0000	1.3
@@ -1,2 +1,2 @@
-<emphasis>Hello, World!</emphasis> resource at
-<ulink url="http://en.wikipedia.org/wiki/Hello_world">Wikipedia</ulink>.
+<ulink url="http://en.wikipedia.org/wiki/Hello_world">Hello, World!</ulink>
+resource at &WP;.



1.1                  xmldocs/glossary/Minivend


<<Minivend: empty>>


1.9       +0 -3      xmldocs/guides/index.xml


rev 1.9, prev_rev 1.8
Index: index.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/index.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- index.xml	16 Mar 2006 15:31:52 -0000	1.8
+++ index.xml	9 Apr 2006 00:20:04 -0000	1.9
@@ -80,11 +80,8 @@
 					<emphasis role='bold'>
 						Installation/Configuration FAQ
 					</emphasis><sbr/>
-<ulink url="http://www.icdevgroup.org/interchange-doc-5.2.0/icfaq.html">HTML</ulink>
-<!--
 					<ulink url="install/index.html">Multi-HTML</ulink> |
 					<ulink url="install.html">HTML</ulink>
--->
 				</entry>
 
 				<entry>



1.2       +32 -27    xmldocs/guides/install.xml


rev 1.2, prev_rev 1.1
Index: install.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/install.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- install.xml	30 Mar 2006 00:43:11 -0000	1.1
+++ install.xml	9 Apr 2006 00:20:04 -0000	1.2
@@ -15,10 +15,7 @@
 	</copyright>
 	<copyright>
 		<year>2006</year>
-		<holder>
-			<firstname>Davor</firstname><surname>Ocelic</surname>
-			<email>docelic at icdevgroup.org</email>
-		</holder>
+		<holder>Davor Ocelic</holder>
 	</copyright>
 
 	<authorgroup>
@@ -46,7 +43,7 @@
 	<abstract>
 		<para>
 		The purpose of this document is to guide you through the complete
-		Interchange installation routine.
+		&IC; installation routine.
 		</para><para>
 		While the concepts will be properly explained and elaborated on,
 		the intention is to make this document a collection of pointers
@@ -96,8 +93,8 @@
 		<para>
 		Since the Perl installation is crucial for Interchange setup
 		(and run-time performance), special attention must be given to it.
-		Interchange requires &PERL; 5.6 or newer, and will soon require
-		5.8. Run <command>perl -v</command> to check your version.
+		Interchange requires &PERL; &PERL_VER_REQUIRED; or newer.
+		Run <command>perl -v</command> to check your version.
 		</para>
 		<para>
 		Perl installations, especially from non-standard distributions or
@@ -120,9 +117,8 @@
 		problems with threaded Perl versions 5.8.5 or newer, although it means
 		an up-to-30% performance drop. For home installations and testing, both
 		the performance impact and even an older Perl version are acceptable.
-		For production sites, consider compiling a special version of Perl
-		that will be used to run &IC;.
-		<!-- TODO find on the mailing list written docs on how to compile -->
+		For production sites, consider compiling a special, non-threaded version
+		of Perl that will be used to run &IC;.
 		</para>
 		<para>
 		Interchange relies on a number of non-standard Perl modules.
@@ -133,7 +129,11 @@
 		advantage of the excellent &CPAN; functionality and perform the work
 		by simply typing:
 <programlisting>
-$ perl -MCPAN -e 'install "Bundle::Interchange"'
+$ /path/to/perl -MCPAN -e 'install "Bundle::Interchange"'
+</programlisting>
+		For the complete set of modules (the required and optional ones), run
+<programlisting>
+$ /path/to/perl -MCPAN -e 'install "Bundle::InterchangeKitchenSink"'
 </programlisting>
 		</para>
 	</sect2>
@@ -154,9 +154,10 @@
 		There also exists a variant of the link program written in &PERL;,
 		so the C compiler is not exactly mandatory (even though it is strongly
 		suggested). Since the link program does not contain anything specific
-		to the &IC; catalog it is used by, you can get someone to compile it
-		for you, and then keep copying it around to new names for each of the
-		catalogs.
+		to the &IC; catalog it is used by, you can probably get someone to compile
+		it for you, and then keep copying it around to new names for each of the
+		catalogs (unless, of course, you want to modify link program settings
+		such as socket file location or timeout value).
 		</para>
 	</sect2>
 
@@ -179,8 +180,9 @@
 		</para>
 		<para>
 		In case of Apache, it is good to know where the Apache configuration
-		file is located. The catalog creation script recognized the file format
-		and can help the installer answer some of the questions automatically.
+		file is located. The catalog creation script (<command>makecat</command>)
+		recognizes the file format and can help the configurator answer some of the
+		questions automatically.
 		</para>
 		<para>
 		Know where the document root directory for your site (or virtual host)
@@ -205,8 +207,12 @@
 		cause no suspicious problems on first run.
 		</para>
 		<para>
-		Know the DSN (Data source name) string, which is what tells the Perl DBI
-		how to connect to the database.
+		In fact, our demo catalog '&std-catalog;' requires use of an &glos-SQL;
+		database.
+		</para>
+		<para>
+		Know the &glos-DSN; (Data source name) string, which is what tells
+		the Perl DBI how to connect to the database.
 		</para>
 		<para>
 		Know the database administrator user name and password.
@@ -235,6 +241,8 @@
 		to 8-letter usernames, there's no reason to use abbreviated forms.
 		</para>
 		<para>
+		For ultimate flexibility, it is a quite common approach to let every
+		catalog user have its own instance of the &IC; server.
 		</para>
 	</sect2>
 
@@ -282,14 +290,12 @@
 	</para><para>
 	Run <command>./configure</command>, which no longer performs an 
 	installation as it used to, but simply prints proper installation
-	instructions.
-	</para><para>
-	Basically, the installation routine comes down to running
+	instructions (Basically, the installation routine comes down to running
 	<command>perl Makefile.pl; make; make test &amp;&amp;
-	make install</command>.
+	make install</command>).
 	</para>
 	<para>
-	The <command>make test</command> is probably the most important.
+	<command>make test</command> is probably the most important.
 	If you do not get an <literal>OK</literal> on all the tests ran,
 	you have a problem that you need to fix before moving any further.
 	</para><para>
@@ -317,7 +323,7 @@
 	or want to keep everything under your own control. However, there is the
 	so-called "&std-catalog;" demo that ships with &IC; &mdash; it is extremely
 	elaborate and feature-rich for someone looking to build an Internet store,
-	and it still allows custom modifications to be performed on it.
+	and it allows custom modifications to be performed on it.
 	</para><para>
 	Regardless of whether you want to base your own catalogs on our demo or not,
 	it is strongly suggested to install the demo. It will let you
@@ -331,13 +337,12 @@
 	On the first run, <literal>makecat</literal> will ask a series of questions
 	to configure site-wide parameters. It will then proceed with the practical
 	catalog creation phase, so the first <command>makecat</command> session will
-	seem very long, and some of the questions will seem as if they were
-	duplicated.
+	seem very long, and some of the questions will seem duplicated.
 	</para><para>
 	The <command>makecat</command> is self-documented. Each question is
 	accompanyed with an introduction, examples, and a reasonable Unix default.
 	</para><para>
-	Each catalog can be completely independent, with different settings and
+	Each catalog can be completely independent with different settings and
 	databases, or catalogs can share pages, databases, and session files.
 	This means that several catalogs can share the same information, allowing
 	"virtual malls" (although not directly out-of-the box with makecat or our








More information about the docs mailing list