[docs] xmldocs - docelic modified 13 files
docs at icdevgroup.org
docs at icdevgroup.org
Sun Feb 20 20:16:53 EST 2005
User: docelic
Date: 2005-02-21 01:16:52 GMT
Modified: . TODO
Modified: refs PageDir SendMailProgram TagDir
Added: refs AsciiTrack ConfigDir DescriptionField PriceField
Added: TcpHost TemplateDir TolerateGet UrlSepChar VarName
Log:
Some new items, good stuff.
I am wonderful ;-)
Revision Changes Path
1.66 +18 -26 xmldocs/TODO
rev 1.66, prev_rev 1.65
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.65
retrieving revision 1.66
diff -u -r1.65 -r1.66
--- TODO 20 Feb 2005 00:59:49 -0000 1.65
+++ TODO 21 Feb 2005 01:16:51 -0000 1.66
@@ -1,13 +1,14 @@
+
+Outstanding:
+=======
On config directives, include parse_<> function in source context
- See that if 'crypt' is put in see also, all symbols of that name appear
in see also line and their type is distinguished visually.
-- Add ROW_REPARSE along ROW_INTERPOLATE in tag refs
- TAXAREA is not discovered in source by bin/stattree
- toc in glossary
- Make MapRoutined source contexts have Line: x-y instead of Lines: z header.
- make glossary,howto items also appear as symbols, so that you can put
their names in See Also and get generated links
-- find out where on denali did I misplace a "port" of icvariables?
- recognize situations where contexts overlap, but in a special way that
first example does not see the other, but the other sees the first becase
of 10 lines of pre-context. (example is IMAGE_MOGRIFY refentry). In those
@@ -16,14 +17,10 @@
- Enhance stuff with acronyms
- Under AUTHORS, include cvs line where appropriate (guides, howtos, gloss... )
- In vars.html, include line if it appears in variable.txt
-
-Outstanding:
- why email, email-raw, SendMailProgram produce errors about usertags olink ID
- Add docbook element to reference mailing list posts. Something like
<ml list='users'>2004-December/041539</ml>, it expands to:
<ulink url="http://www.icdevgroup.org/pipermail/interchange-users/2004-December/041539.html">2004-December/041539</ulink>.
-- Ask ndw about including [NEW!] and [TODO!] in titles in TOC. --> This is a
- bug and it will work when they fix it.
- 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/
@@ -42,6 +39,8 @@
Mid-term:
+- Ask ndw about including [NEW!] and [TODO!] in titles in TOC. --> This is a
+ bug and it will work when they fix it.
- &glos-hello-world needs to give "hello world", not "hello-world" as text
- List of mv_s, descriptions and shortcuts
- for "online" docs, also provide a form where users can add comments or
@@ -73,6 +72,19 @@
- new developer howto
- filenames in Source contexts should also be clickable. this is longterm
because it'll involve perltidy and other stuff I have in mind ...
+- CVS page: http://www.icdevgroup.org/i/dev/cvs.html?id=auxbUMnz
+ Make a tutorial : IC from CVS, Catalog in SVN, replicated setup online
+ and locally
+- How to deal with Safe
+Programming guidelines doc - integrate with programming style. Advise
+programmers of choices to make in order to make their code play well with
+IC - for example, if they want to have a field in the DB for images,
+advise them to name the column 'image' because other tags (they might or
+might not later use) take that as default value. etc...
+guide on setting complete IC environment
+explain version naming.. stable/unstable and how 5.3.0 implies next stable
+Documentation on how to create replicated catalog online and at your
+desktop machine for ultimate convenience.
Notes:
@@ -94,14 +106,6 @@
Misc:
- Mike We are short on chiefs and heavy on Indians here
-Stuff:
-- nightly build http://ftp.icdevgroup.org/interchange/nightly_build/
- Also provide interchange-nightly at same place where interchange-latest
-- CVS page: http://www.icdevgroup.org/i/dev/cvs.html?id=auxbUMnz
- Make a tutorial : IC from CVS, Catalog in SVN, replicated setup online
- and locally
-- Mention ML page, cvsweb
-- How to deal with Safe
- In iccattut:
@@ -128,18 +132,6 @@
action, form, unix inet socket, values,
regex, flypage, sku
-- More:
-Programming guidelines doc - integrate with programming style. Advise
-programmers of choices to make in order to make their code play well with
-IC - for example, if they want to have a field in the DB for images,
-advise them to name the column 'image' because other tags (they might or
-might not later use) take that as default value. etc...
-guide on setting complete IC environment
-style: leave newline at end of file
-explain version naming.. stable/unstable and how 5.3.0 implies next stable
-Documentation on how to create replicated catalog online and at your
-desktop machine for ultimate convenience.
-- PRODUCE PATCH TO RECOMPILE OFFICIAL DISTRIBUTION PERL without threads.
1.3 +1 -1 xmldocs/refs/PageDir
rev 1.3, prev_rev 1.2
Index: PageDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/PageDir,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PageDir 3 Jan 2005 20:42:16 -0000 1.2
+++ PageDir 21 Feb 2005 01:16:51 -0000 1.3
@@ -1,5 +1,5 @@
__NAME__ purpose
-directory containing catalog pages
+specify directory containing catalog pages
__END__
1.3 +5 -0 xmldocs/refs/SendMailProgram
rev 1.3, prev_rev 1.2
Index: SendMailProgram
===================================================================
RCS file: /var/cvs/xmldocs/refs/SendMailProgram,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SendMailProgram 20 Feb 2005 00:59:50 -0000 1.2
+++ SendMailProgram 21 Feb 2005 01:16:51 -0000 1.3
@@ -10,6 +10,11 @@
__END__
+__NAME__ see also
+AsciiTrack
+__END__
+
+
__NAME__ description
The directive specifies the location of the <command>sendmail</command>
binary (executable file).
1.2 +1 -1 xmldocs/refs/TagDir
rev 1.2, prev_rev 1.1
Index: TagDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/TagDir,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TagDir 20 Feb 2005 00:59:50 -0000 1.1
+++ TagDir 21 Feb 2005 01:16:51 -0000 1.2
@@ -1,5 +1,5 @@
__NAME__ purpose
-directory containing code declaration blocks
+specify directories containing code declaration blocks
__END__
1.1 xmldocs/refs/AsciiTrack
rev 1.1, prev_rev 1.0
Index: AsciiTrack
===================================================================
__NAME__ purpose
specify filename to which formatted order reports should be appended
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>filename</arg>
</group>
__END__
__NAME__ description
The directive specifies the filename to which formatted orders will be appended.
__END__
__NAME__ see also
SendMailProgram
__END__
__NAME__ notes
If the &conf-Route; directive is set to <literal>supplant</literal>, this
directive is disregarded.
__END__
__NAME__ example: Setting ErrorFile
<programlisting>
AsciiTrack etc/tracking.asc
</programlisting>
__END__
1.1 xmldocs/refs/ConfigDir
rev 1.1, prev_rev 1.0
Index: ConfigDir
===================================================================
__NAME__ purpose
specify default "include" directory for "<file" notation
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>directory</arg>
</group>
__END__
__NAME__ description
Specify the default "include" directory for files that are specified
using the <literal><filename</literal> notation and have a relative
pathname. See <xref linkend="ConfigDir_examples"/> for clarification.
__END__
TODO: in glos configuration, mention that directives are immediate-effect
so you can redefine them multiple times
TODO: show conditionals in config:
Variable TEMPLATE blue
ParseVariables Yes
ConfigDir templates/__TEMPLATE__
ParseVariables No
Variable MENUBAR <menubar
Variable LEFTSIDE <leftside
Variable BOTTOM <bottom
ConfigDir config
__NAME__ notes
See the &glos-configuration; glossary entry for complete information
on &IC; config files.
__END__
__NAME__ example: Setting ConfigDir
<programlisting>
ConfigDir variables
</programlisting>
__END__
__NAME__ example: Setting directive value from a file
In combination with the above example, the following would read the
directive value from file <filename>variables/mailorderto</filename>.
<programlisting>
MailOrderTo <mailorderto
</programlisting>
__END__
1.1 xmldocs/refs/DescriptionField
rev 1.1, prev_rev 1.0
Index: DescriptionField
===================================================================
__NAME__ purpose
specify name of the "description" field in the Interchange database
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>field_name</replaceable></arg>
</group>
__END__
__NAME__ description
By default, &IC; expects the item description to be in the
<database class='field'>description</database> field in the database.
This directive allows modification of the default name.
</para><para>
The field is accessed implicitly when you call say,
<code>[item-description]</code> in &glos-ITL;.
__END__
__NAME__ notes
The existence of the field is not exactly crucial, but it's important
for say, &glos-flypage;s.
__END__
TODO: Clarify this? "If there is an
attribute set to the same name as C<DescriptionField>, this will be used for
display."
__NAME__ example: Redefining DescriptionField
<programlisting>
DescriptionField opis
</programlisting>
"Opis", for example, is a croatian equivalent of "description".
__END__
1.1 xmldocs/refs/PriceField
rev 1.1, prev_rev 1.0
Index: PriceField
===================================================================
__NAME__ purpose
specify name of the "price" field in the Interchange database
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>field_name</replaceable></arg>
</group>
__END__
__NAME__ description
By default, &IC; expects item price to be in the
<database class='field'>price</database> field in the database.
This directive allows modification of the default name.
</para><para>
The field is accessed implicitly when you call say,
<code>[item-price]</code> in &glos-ITL;.
__END__
__NAME__ notes
The existence of the field is not exactly crucial, but it's important
for say, &glos-flypage;s.
</para><para>
The field can also be set according to a &conf-Locale;.
__END__
__NAME__ example: Redefining PriceField
<programlisting>
PriceField cijena
</programlisting>
"Cijena", for example, is a croatian equivalent of "price".
__END__
1.1 xmldocs/refs/TcpHost
rev 1.1, prev_rev 1.0
Index: TcpHost
===================================================================
__NAME__ purpose
specify which hosts can connect to Interchange server running in Inet mode
__END__
__NAME__ see also
TcpMap
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>hostname</replaceable></arg>
</group>
__END__
__NAME__ description
The &conf-TcpHost; directive defines a list of hostnames whose
connections to the &IC; Inet socket will be accepted.
This effectively allows or denies access to all catalogs running on the
corresponding &IC; server.
</para><para>
It's important to note that the directive <emphasis role='bold'>does not
</emphasis> support wildcards or anything, it only accepts plain list
of space-separated IPs or hostnames.
__END__
<!--
accepts a wildcard list -
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
-->
TODO: Why not as RobotHost etc, accepting wildcards and proper comma-
separated list ?
__NAME__ example: Defining TcpHost
<programlisting><![CDATA[
TcpHost localhost secure.domain.com
]]></programlisting>
__END__
1.1 xmldocs/refs/TemplateDir
rev 1.1, prev_rev 1.0
Index: TemplateDir
===================================================================
__NAME__ purpose
specify common template/fallback "pages" directories
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'>directory</arg>
</group>
__END__
__NAME__ description
Specify directories containing default pages. This effectively allows you to
keep pages common for all catalogs in common directories, or — in case
of a catalog directive — extend the page
search outside the catalog's <filename class='directory'>pages/</filename>
directory.
__END__
__NAME__ example: Setting TemplateDir
<programlisting>
TemplateDir /usr/local/interchange/default_pages
</programlisting>
__END__
1.1 xmldocs/refs/TolerateGet
rev 1.1, prev_rev 1.0
Index: TolerateGet
===================================================================
__NAME__ purpose
specify whether information from both GET and POST method should be parsed when form is submitted using POST method
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
Enabling the option makes &IC; parse both GET data and POST data when a POST
form is been submitted.
Unfortunately this has to be a global setting because at URL
parse time, the &IC; daemon doesn't yet know which catalog it is dealing
with (due to catalog aliases, etc.).
__END__
__NAME__ example: Enabling TolerateGet
<programlisting>
TolerateGet yes
</programlisting>
__END__
1.1 xmldocs/refs/UrlSepChar
rev 1.1, prev_rev 1.0
Index: UrlSepChar
===================================================================
__NAME__ purpose
specify default URL separator character
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>non_word_character</arg>
</group>
__END__
__NAME__ description
Specify URL separator character for &IC;-generated &glos-HTML; links.
Only one character is allowed, and the only recommended ones are
the default <literal>&</literal>, <literal>;</literal> and
<literal>:</literal>.
__END__
__NAME__ see also
MV_HTML4_COMPLIANT
__END__
__NAME__ example: Setting UrlSepChar
<programlisting>
UrlSepChar :
</programlisting>
__END__
1.1 xmldocs/refs/VarName
rev 1.1, prev_rev 1.0
Index: VarName
===================================================================
__NAME__ purpose
remap Interchange variables to arbitrary names in generated URLs
__END__
__NAME__ see also
ScratchDefault
__END__
__NAME__ synopsis
<arg choice='plain'><replaceable>original_name</replaceable></arg>
<arg choice='plain'><replaceable>remapped_name</replaceable></arg>
__END__
__NAME__ description
The directive sets the names of variables that will be remapped to and from
the URL when Interchange outputs it in user pages or reads from form
submission requests.
__END__
__NAME__ notes
&IC; already ships with some remapping definitions (to shorten URLs, not
obfuscate code or anything); see <filename>/etc/varnames</filename> for the
list.
__END__
__NAME__ example: Remapping mv_session_id to session
<programlisting>
VarName mv_session_id session
</programlisting>
__END__
More information about the docs
mailing list