[docs] xmldocs - docelic modified 10 files

docs at icdevgroup.org docs at icdevgroup.org
Tue May 24 17:42:19 EDT 2005


User:      docelic
Date:      2005-05-24 21:42:19 GMT
Modified:  .        Makefile TODO
Modified:  docbook  olinkdb-c.xml olinkdb-nc.xml
Modified:  guides   iccattut.xml programming-style.xml upgrade.xml
Modified:  howtos   quantity-in-basket
Modified:  refs     css
Added:     guides   faq.xml
Log:
- Added Interchange FAQ document ( guides/faq.xml ).
  It's document of type article, with the standard DocBook XML QandA set.

  Initial content will be a port of existing faq, and with time it should
  receive some new questions.

- Various fixes to the rest of files

Revision  Changes    Path
1.60      +1 -1      xmldocs/Makefile


rev 1.60, prev_rev 1.59
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.59
retrieving revision 1.60
diff -u -r1.59 -r1.60
--- Makefile	24 May 2005 20:24:04 -0000	1.59
+++ Makefile	24 May 2005 21:42:18 -0000	1.60
@@ -13,7 +13,7 @@
 #############################################################
 # Base definitions
 SYMBOL_TYPES= pragmas vars tags confs filters
-GUIDES      = iccattut programming-style
+GUIDES      = iccattut programming-style upgrade faq
 HOWTOS      = howtos
 GLOSSARY    = glossary
 ALL_DOCS    = $(GLOSSARY) $(HOWTOS) $(GUIDES) $(SYMBOL_TYPES)



1.68      +2 -11     xmldocs/TODO


rev 1.68, prev_rev 1.67
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.67
retrieving revision 1.68
diff -u -r1.67 -r1.68
--- TODO	24 May 2005 20:24:04 -0000	1.67
+++ TODO	24 May 2005 21:42:18 -0000	1.68
@@ -1,5 +1,3 @@
-
-
 Outstanding:
 =======
 files/pricing/ dir is missing?!
@@ -25,20 +23,15 @@
 	<ulink url="http://www.icdevgroup.org/pipermail/interchange-users/2004-December/041539.html">2004-December/041539</ulink>.
 - match style (no starting verb or all starting verbs) in all Example titles
 - check if all Default fields are properly formated (<literal> or none)
-- s/a HTML/an HTML/
 
 Coding:
 - script to [un]comment debug lines!!
-- use Interchange.pm to make an Interchange shell
-- finish ML stats
+- use Interchange.pm to make an Interchange shell (External.pm!)
+- finish ML stats <-- MAILPOND on ocelic2! 
 
 DOCUMENTATION SYSTEM:
 - Add support to document tags which are NOT found in separate files
   (like [restrict] or [subject]).
-- Read all possible options for tag files from vend/config.pm
-  (%tag.* structures) and warn if invalid option is found in any tag file.
-
-
 
  Mid-term:
 - Ask ndw about including [NEW!] and [TODO!] in titles in TOC. --> This is a 
@@ -123,8 +116,6 @@
   - give examples for the tasks in 'do yourself' section (in progress)
   - give good practices about filtering, security
   - see problems from old docs/TODO notes on iccattut
-  - ICCATTUT MUST NOT STOP WHERE it stops now. it needs to show all stuff
-    from current "excercise for readers" section, and also many more things.
   - files/tutorial*: s/tutorial-*.log/tutorial.*.log/
 
 GLOSSARY:



1.12      +14 -0     xmldocs/docbook/olinkdb-c.xml


rev 1.12, prev_rev 1.11
Index: olinkdb-c.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-c.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- olinkdb-c.xml	20 May 2005 21:41:49 -0000	1.11
+++ olinkdb-c.xml	24 May 2005 21:42:18 -0000	1.12
@@ -3,6 +3,8 @@
 	SYSTEM "/usr/share/xml/docbook/stylesheet/nwalsh/common/targetdatabase.dtd" [
 	<!ENTITY iccattut SYSTEM "../tmp/iccattut-c.db"> 
 	<!ENTITY upgrade SYSTEM "../tmp/upgrade-c.db"> 
+	<!ENTITY faq SYSTEM "../tmp/faq-c.db"> 
+	<!ENTITY programming-style SYSTEM "../tmp/programming-style-c.db"> 
 	<!ENTITY howtos SYSTEM "../tmp/howtos-c.db"> 
 	<!ENTITY glossary SYSTEM "../tmp/glossary-c.db"> 
 	<!ENTITY pragmas SYSTEM "../tmp/pragmas-c.db"> 
@@ -29,6 +31,18 @@
 			<dir name='upgrade'>
 				<document targetdoc="upgrade">
 				&upgrade;
+				</document>
+			</dir>
+			
+			<dir name='faq'>
+				<document targetdoc="faq">
+				&faq;
+				</document>
+			</dir>
+			
+			<dir name='programming-style'>
+				<document targetdoc="programming-style">
+				&programming-style;
 				</document>
 			</dir>
 			



1.12      +4 -0      xmldocs/docbook/olinkdb-nc.xml


rev 1.12, prev_rev 1.11
Index: olinkdb-nc.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-nc.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- olinkdb-nc.xml	20 May 2005 21:41:49 -0000	1.11
+++ olinkdb-nc.xml	24 May 2005 21:42:18 -0000	1.12
@@ -3,6 +3,8 @@
 	SYSTEM "/usr/share/xml/docbook/stylesheet/nwalsh/common/targetdatabase.dtd" [
 	<!ENTITY iccattut SYSTEM "../tmp/iccattut-nc.db"> 
 	<!ENTITY upgrade SYSTEM "../tmp/upgrade-nc.db"> 
+	<!ENTITY faq SYSTEM "../tmp/faq-nc.db"> 
+	<!ENTITY programming-style SYSTEM "../tmp/programming-style-nc.db"> 
 	<!ENTITY howtos SYSTEM "../tmp/howtos-nc.db"> 
 	<!ENTITY glossary SYSTEM "../tmp/glossary-nc.db"> 
 	<!ENTITY pragmas SYSTEM "../tmp/pragmas-nc.db"> 
@@ -21,6 +23,8 @@
 		<dir name="OUTPUT"> 
 			<document targetdoc="iccattut" baseuri="iccattut.html"> &iccattut; </document>
 			<document targetdoc="upgrade" baseuri="upgrade.html"> &upgrade; </document>
+			<document targetdoc="faq" baseuri="faq.html"> &faq; </document>
+			<document targetdoc="programming-style" baseuri="programming-style.html"> &programming-style; </document>
 			<document targetdoc="howtos" baseuri="howtos.html"> &howtos; </document>
 			<document targetdoc="glossary" baseuri="glossary.html"> &glossary; </document>
 			<document targetdoc="pragmas" baseuri="pragmas.html"> &pragmas; </document>



1.33      +1 -1      xmldocs/guides/iccattut.xml


rev 1.33, prev_rev 1.32
Index: iccattut.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/iccattut.xml,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -r1.32 -r1.33
--- iccattut.xml	24 May 2005 12:59:12 -0000	1.32
+++ iccattut.xml	24 May 2005 21:42:18 -0000	1.33
@@ -11,7 +11,7 @@
 	<titleabbrev>iccattut</titleabbrev>
 
 	<copyright>
-		<year>2003</year><year>2004</year>
+		<year>2003</year><year>2004</year><year>2005</year>
 		<holder>Interchange Development Group</holder>
 	</copyright>
 	<copyright>



1.4       +8 -2      xmldocs/guides/programming-style.xml


rev 1.4, prev_rev 1.3
Index: programming-style.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/programming-style.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- programming-style.xml	1 Mar 2005 10:31:12 -0000	1.3
+++ programming-style.xml	24 May 2005 21:42:18 -0000	1.4
@@ -177,8 +177,14 @@
 		tags are treated as containers. This is easy to follow for container tags
 		such as &lt;p&gt; &mdash; simply remember not to omit the closing tag.
 		With non-container tags, such as &lt;input&gt;, &lt;br&gt; or &lt;hr&gt;,
-		a new &glos-pragma; will be introduced to automatically replace the 
-		closing <literal>&gt;</literal> with <literal>/&gt;</literal>.
+		closing <literal>&gt;</literal> needs to be replaced with
+		<literal>/&gt;</literal>, but not unconditionally (&IC; must be able to
+		output both the usual, and XHTML variant).
+		In such constructs, you can use <varname>$Vend::Xtrailer</varname>
+		that's set to <literal>/</literal> if &conf-XHTML; is enabled, 
+		and we could eventually replace all "raw" calls like &lt;input&gt;
+		with &tag-formel;, &tag-widget; and other tags that will honor 
+		<varname>$Vend::Xtrailer</varname>.
 <programlisting><![CDATA[
 <form action="[process]">
   <input type="text"   name="city" value="[value city]" >



1.2       +10 -1     xmldocs/guides/upgrade.xml


rev 1.2, prev_rev 1.1
Index: upgrade.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/upgrade.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- upgrade.xml	16 Feb 2005 17:59:33 -0000	1.1
+++ upgrade.xml	24 May 2005 21:42:18 -0000	1.2
@@ -51,8 +51,17 @@
 	<abstract>
 		<para>
 		The purpose of this document is to provide general notes for upgrading
-		from Minivend 3 to Minivend 4, and from Minivend 4 to current 
+		from Minivend 3 to Minivend 4, and from Minivend 4 to 
 		&IC;.
+		</para><para>
+		By saying "Interchange", we <emphasis>primarily</emphasis> mean the
+		early releases, such as 4.6 or 4.8. To be sure you did not miss anything
+		while upgrading to Interchange 5.0 and beyond, please review
+		WHATSNEW entries.
+		</para><para>
+		This Guide will be slowly losing on relevance, and users running
+		Interchange 5.0 or later should monitor WHATSNEW entries for 
+		upgrade information.
 		</para>
 	</abstract>
 



1.1                  xmldocs/guides/faq.xml


rev 1.1, prev_rev 1.0
Index: faq.xml
===================================================================
<?xml version="1.0" standalone="no"?>

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook-Interchange XML V4.2//EN"
	"../docbook/docbookxi.dtd">

<article id='faq'>

<articleinfo>
	<title>&IC; Frequently Asked Questions (FAQ)</title>
	<titleabbrev>faq</titleabbrev>

	<copyright>
		<year>2003</year><year>2004</year><year>2005</year>
		<holder>&IC; Development Group</holder>
	</copyright>
	<copyright>
		<year>2002</year>
		<holder>Red Hat, Inc.</holder>
	</copyright>

	<authorgroup>
		<author>
			<firstname>Davor</firstname><surname>Ocelic</surname>
			<email>docelic at icdevgroup.org</email>
		</author>
		<author>
			<firstname>Mike</firstname><surname>Heins</surname>
			<email>mike at perusion.com</email>
		</author>
	</authorgroup>

	<legalnotice>
		<para>
		This documentation is free; you can redistribute it and/or modify
		it 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>
		<para>
		It is distributed in the hope that it will be useful,
		but WITHOUT ANY WARRANTY; without even the implied warranty of
		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
		GNU General Public License for more details.
		</para>
	</legalnotice>

	<abstract>
		<para>
		The purpose of this FAQ is to provide quick answers to quick questions.
		Where ever appropriate, pointers to more "formal" documentation
		(guides, HOWTOs, reference pages) will be provided.
		</para>
	</abstract>

</articleinfo>




<qandaset>


<qandadiv><title>How does &IC; work</title>

<qandaentry>
<question><para>
Where are the pages?
</para></question>
<answer><para>
&IC; pages are not kept in normal HTML space. Look in the catalog subdirectory pages. The pages are always filtered through the &IC; daemon before being delivered.
</para></answer>
</qandaentry>

<qandaentry>
<question><para>
Where are the images?
</para></question>
<answer><para>
&IC; is a &glos-CGI; program, and if relative image paths were used, erroneous 
&glos-img; output like the following would have occured:

<programlisting><![CDATA[
<img src="/cgi-bin/simple/../whatever.jpg">
]]></programlisting>

For that reason, by default, &IC; uses &conf-ImageDir; or
&conf-ImageDirSecure; for a prefix used to rewrite image URLs.
In the demo, image
specs that have no absolute path information are prefixed with
<literal>/simple/images/</literal>.
</para><para>
In an &IC; page, this tag:

<programlisting><![CDATA[
<img src="ordernow.gif">
]]></programlisting>

will become this:

<programlisting><![CDATA[
<img src="/simple/images/ordernow.gif">
]]></programlisting>

This tag:

<programlisting><![CDATA[
<img src="items/00-0011.jpg">
]]></programlisting>

will become this:

<programlisting><![CDATA[
<img src="/simple/images/items/00-0011.jpg">
]]></programlisting>

Absolute image paths are not affected. An image such as
<literal>/other/images/whatever.gif</literal> will not be changed.
</para></answer>
</qandaentry>

</qandadiv>
</qandaset>
        
</article>




1.4       +2 -2      xmldocs/howtos/quantity-in-basket


rev 1.4, prev_rev 1.3
Index: quantity-in-basket
===================================================================
RCS file: /var/cvs/xmldocs/howtos/quantity-in-basket,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- quantity-in-basket	12 Nov 2004 22:26:26 -0000	1.3
+++ quantity-in-basket	24 May 2005 21:42:18 -0000	1.4
@@ -39,10 +39,10 @@
 	<sect1 id='quantityfields_introduction'>
 		<title>Introduction</title>
 		<para>
-		HOW-TO version: $Id: quantity-in-basket,v 1.3 2004/11/12 22:26:26 docelic Exp $
+		HOW-TO version: $Id: quantity-in-basket,v 1.4 2005/05/24 21:42:18 docelic Exp $
 		</para>
 		<para>
-		On your Interchange pages, you must provide some kind of a HTML form
+		On your Interchange pages, you must provide some kind of an HTML form
 		if you want to receive any data from the client. We will use the 
 		<filename>pages/ord/basket.html</filename> page from the
 		<!-- XXX LINK IT -->



1.11      +1 -1      xmldocs/refs/css


rev 1.11, prev_rev 1.10
Index: css
===================================================================
RCS file: /var/cvs/xmldocs/refs/css,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- css	13 Dec 2004 00:04:41 -0000	1.10
+++ css	24 May 2005 21:42:18 -0000	1.11
@@ -131,7 +131,7 @@
 [css THEME_CSS]
 </programlisting>
 In the example above, the <tag>css</tag> will look for the 
-<filename>images/theme_css.css</filename>, and generate a HTML link to it
+<filename>images/theme_css.css</filename>, and generate an HTML link to it
 (&lt;link rel="stylesheet" href="/images/theme_css.css"&gt;).
 __END__
 








More information about the docs mailing list