[docs] xmldocs - docelic modified 10 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Nov 20 09:40:40 EST 2004
User: docelic
Date: 2004-11-20 14:40:40 GMT
Modified: . Makefile README TODO
Modified: bin stattree
Modified: howtos custom-sendmail-routine
Modified: refs ConfigAllAfter cgi.tag no_html_comment_embed
Added: howtos daemon-control professional-support
Log:
Some styling stuff.
Most important:
- fixed some problems with Makefile, although not yet OK.
- bin/stattree: don't generate duplicates in Uses: reports
Revision Changes Path
1.44 +4 -4 xmldocs/Makefile
rev 1.44, prev_rev 1.43
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -r1.43 -r1.44
--- Makefile 15 Nov 2004 15:15:09 -0000 1.43
+++ Makefile 20 Nov 2004 14:40:39 -0000 1.44
@@ -14,7 +14,7 @@
GUIDES = iccattut xmldocs
HOWTOS = howtos
GLOSSARY = glossary
-ALL_DOCS = $(GUIDES) $(HOWTOS) $(GLOSSARY) $(SYMBOL_TYPES)
+ALL_DOCS = $(GLOSSARY) $(HOWTOS) $(GUIDES) $(SYMBOL_TYPES)
SHELL = /bin/sh
export O = OUTPUT
export T = tmp
@@ -26,7 +26,7 @@
PSR_FLAGS = --xinclude
VPATH = guides refs howtos glossary
-.SILENT:
+#.SILENT:
.PHONY: all complete
.PHONY: skel
.PHONY: guides howtos symbols glossary
@@ -185,13 +185,13 @@
# Silly, rewrite this, I forgot about $*. Or $* wouldn't help? I'm not
# willing to think about it right now.
refxmls: BOTH = --both
-refxmls: bin/refs-autogen $(foreach stype,$(SYMBOL_TYPES),refs/$(stype).xml)
+refxmls: bin/refs-autogen $(foreach stype,$(SYMBOL_TYPES),refs/$(stype).xml) glossary/glossary.xml howtos/howtos.xml
:
$T/%.list: BNAME = $(subst $T/,,$@)
refs/%.xml: BNAME = $(subst refs/,,$@)
$T/%.list: FNAME = $(subst .list,,$(BNAME))
refs/%.xml: FNAME = $(subst .xml,,$(BNAME))
-# A little 'overwork' here: we reegenerate all .xml files even if just
+# A little 'overwork' here: we regenerate all .xml files even if just
# one file changes.
$T/%.list refs/%.xml: $(foreach icver,$(IC_VERSIONS),cache/$(icver)/.cache.bin) $(shell find refs/ -regex '.+[^(\.xml)]$$') bin/refs-autogen
# PEH, -g is useless since tags migrate between tag groups
1.12 +6 -6 xmldocs/README
rev 1.12, prev_rev 1.11
Index: README
===================================================================
RCS file: /var/cvs/xmldocs/README,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- README 20 Oct 2004 21:31:09 -0000 1.11
+++ README 20 Nov 2004 14:40:39 -0000 1.12
@@ -30,14 +30,14 @@
the directory back to 'tmp/' and avoid the overhead of
regenerating OlinkDB files).
- -- And those covered by 'make':
- make skel
- make OUTPUT/xmldocs.css
+ -- And those already covered by 'make':
make caches
make refxmls
- make olinkdbs-nc
- make olinkdbs-c
- make OUTPUT/iccattut.html OUTPUT/iccattut ...
+ make olinkdbs-nc olinkdbs-c
+ make tmp/iccattut-nc.db tmp/iccattut-c.db
+ make skel
+ make OUTPUT/xmldocs.css
+ make OUTPUT/iccattut.html OUTPUT/iccattut
See Makefile for a complete list, of course.
1.49 +11 -0 xmldocs/TODO
rev 1.49, prev_rev 1.48
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -r1.48 -r1.49
--- TODO 16 Nov 2004 16:36:49 -0000 1.48
+++ TODO 20 Nov 2004 14:40:39 -0000 1.49
@@ -4,7 +4,10 @@
- Online examples only have to be standard examples, with actual work in
practice if condition=online
Code to do that is: <programlisting><textobject><textdata fileref="pathto.xml"/></textobject></programlisting>
+- Image tag, sort out mgkpath thing
+- To be able to build docs for 5.2 (so, excluding cvs-head)
- Fix mess with entities
+- Commit log-files howto from denali
- Ask ndw about including [NEW!] and [TODO!] in titles in TOC.
@@ -126,3 +129,11 @@
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
1.32 +9 -6 xmldocs/bin/stattree
rev 1.32, prev_rev 1.31
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- stattree 6 Nov 2004 15:38:06 -0000 1.31
+++ stattree 20 Nov 2004 14:40:39 -0000 1.32
@@ -518,8 +518,9 @@
name => ${$c{gfunc}}[0],
}
};
- push @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{pragma}},
- $1
+ push(@{$hash{uses}{$$context_data{group}}{$$context_data{name}}{pragma}},
+ $1) unless grep {/^$1$/}
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{pragma}}
}
$hash{total}{pragmas}++;
@@ -561,9 +562,10 @@
group => 'function',
name => ${$c{gfunc}}[0],
};
- push
+ push(
@{$hash{uses}{$$context_data{group}}{$$context_data{name}}{catvar}},
- $name
+ $name) unless grep {/^$name$/}
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{catvar}}
}
$hash{total}{catvars}++;
@@ -603,9 +605,10 @@
name => ${$c{gfunc}}[0],
};
#print "$$context_data{name}\n" if $$context_data{group} eq 'function';
- push
+ push(
@{$hash{uses}{$$context_data{group}}{$$context_data{name}}{globvar}},
- $name
+ $name) unless grep {/^$name$/}
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{globvar}}
}
$hash{total}{globvars}++;
1.4 +1 -2 xmldocs/howtos/custom-sendmail-routine
rev 1.4, prev_rev 1.3
Index: custom-sendmail-routine
===================================================================
RCS file: /var/cvs/xmldocs/howtos/custom-sendmail-routine,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- custom-sendmail-routine 12 Nov 2004 22:26:26 -0000 1.3
+++ custom-sendmail-routine 20 Nov 2004 14:40:39 -0000 1.4
@@ -22,13 +22,12 @@
</author>
</authorgroup>
-
</chapterinfo>
<sect1 id='customsendmail_introduction'>
<title>Introduction</title>
<para>
- HOW-TO version: $Id: custom-sendmail-routine,v 1.3 2004/11/12 22:26:26 docelic Exp $
+ HOW-TO version: $Id: custom-sendmail-routine,v 1.4 2004/11/20 14:40:39 docelic Exp $
</para>
<para>
Someone <ulink url="http://www.icdevgroup.org/pipermail/interchange-users/2004-July/039811.html">was wondering</ulink> how to optimize the order processing on a busy site. It was observed that about once in every ten times, the <filename>etc/mail_receipt</filename> takes a few <emphasis>extra</emphasis> seconds before it's mailed out.
1.1 xmldocs/howtos/daemon-control
rev 1.1, prev_rev 1.0
Index: daemon-control
===================================================================
<chapter id="ControlDaemon">
<chapterinfo>
<title>Control Interchange Daemon</title>
<titleabbrev>daemoncontrol</titleabbrev>
<keywordset>
<keyword>control</keyword>
<keyword>start</keyword>
<keyword>stop</keyword>
<keyword>restart</keyword>
<keyword>reconfig</keyword>
<keyword>unix</keyword>
<keyword>init</keyword>
<keyword>sbin</keyword>
<keyword>daemon</keyword>
<keyword>script</keyword>
<keyword>run</keyword>
</keywordset>
<!--
<authorgroup>
<author>
<firstname>Mike</firstname>
<surname>Heins</surname>
<affiliation>
<email>mheins at perusion.net</email>
</affiliation>
</author>
</authorgroup>
-->
</chapterinfo>
<sect1 id='daemoncontrol_introduction'>
<title>Introduction</title>
<para>
HOW-TO version: $Id: daemon-control,v 1.1 2004/11/20 14:40:39 docelic Exp $
</para>
<para>
Knowing how to manage the Interchange daemon is one of the very basic
administration tasks.
</para>
</sect1>
<sect1 id='daemoncontrol_solution'>
<title>Solution</title>
<para>
Interchange is (re)started by invoking:
</para>
<itemizedlist>
<listitem vendor='deb'><para>
<userinput>/etc/init.d/interchange restart</userinput> (Debian GNU)
</para></listitem>
<listitem vendor='rh'><para>
<userinput>/etc/rc.d/init.d/interchange restart</userinput> (Red Hat)
</para></listitem>
<listitem vendor='tarball'><para>
<userinput>/usr/local/interchange/bin/interchange -r</userinput>
(tarball)
</para></listitem>
</itemizedlist>
<para>
Specific catalogs are reconfigured by invoking:
</para>
<itemizedlist>
<listitem vendor='deb;rh'><para>
<userinput>/usr/sbin/interchange -reconfig
<replaceable>CATNAME</replaceable></userinput>
(Debian GNU and Red Hat)
</para></listitem>
<listitem><para>
<userinput>/usr/local/interchange/bin/interchange -reconfig
<replaceable>CATNAME</replaceable></userinput> (tarball)
</para></listitem>
</itemizedlist>
<para>
Why would you want to reconfigure a catalog?
Most of the time, the changes you make to the HTML files or databases
are directly visible on the next access to your site. However, that is not
the case with more "serious" files such as catalog
configurations (<filename>catalog.cfg</filename>) or profiles
(<filename>etc/profiles*</filename>).
</para><para>
To take changes from those files "on air", you must reconfigure a catalog.
</para>
<para>
Changes to global <filename>interchange.cfg</filename> can only be updated
by restarting Interchange completely.
</para>
<!-- TODO mention kill, pkill, killall, pidfile -->
</sect1>
</chapter>
1.1 xmldocs/howtos/professional-support
rev 1.1, prev_rev 1.0
Index: professional-support
===================================================================
<chapter id="professional-support">
<chapterinfo>
<title>Request Professional Interchange Support</title>
<titleabbrev>professionalsupport</titleabbrev>
<keywordset>
<keyword>interchange</keyword>
<keyword>paid</keyword>
<keyword>commercial</keyword>
<keyword>professional</keyword>
<keyword>help</keyword>
<keyword>support</keyword>
<keyword>development</keyword>
<keyword>hosting</keyword>
<keyword>catalog</keyword>
<keyword>product</keyword>
</keywordset>
<authorgroup>
<author>
<firstname>Davor</firstname>
<surname>Ocelic</surname>
<affiliation>
<email>docelic at icdevgroup.org</email>
</affiliation>
</author>
</authorgroup>
</chapterinfo>
<sect1 id='professionalsupport_introduction'>
<title>Introduction</title>
<para>
HOW-TO version: $Id: professional-support,v 1.1 2004/11/20 14:40:39 docelic Exp $
</para>
<para>
</para>
</sect1>
<sect1 id='professionalsupport_solution'>
<title>Solution</title>
<para>
</para>
</sect1>
</chapter>
1.2 +0 -4 xmldocs/refs/ConfigAllAfter
rev 1.2, prev_rev 1.1
Index: ConfigAllAfter
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigAllAfter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ConfigAllAfter 9 Nov 2004 23:16:16 -0000 1.1
+++ ConfigAllAfter 20 Nov 2004 14:40:40 -0000 1.2
@@ -2,10 +2,6 @@
config files to read as part of every catalog's configuration, after all its files are read in first
__END__
-
-__NAME__ see also
-__END__
-
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>config file</replaceable></arg>
1.3 +1 -1 xmldocs/refs/cgi.tag
rev 1.3, prev_rev 1.2
Index: cgi.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/cgi.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- cgi.tag 9 Nov 2004 23:16:16 -0000 1.2
+++ cgi.tag 20 Nov 2004 14:40:40 -0000 1.3
@@ -79,7 +79,7 @@
parameters, such as <literal>pagename?foo=bar</literal>,
then the value of the <literal>foo</literal> CGI variable will be
accessible using <code>[cgi foo]</code> in
-&glos-itl; or <code>$CGI->{foo}</code> in embedded Perl.
+&glos-ITL; or <code>$CGI->{foo}</code> in embedded Perl.
__END__
__NAME__ notes
1.5 +2 -1 xmldocs/refs/no_html_comment_embed
rev 1.5, prev_rev 1.4
Index: no_html_comment_embed
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_comment_embed,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- no_html_comment_embed 9 Nov 2004 23:16:16 -0000 1.4
+++ no_html_comment_embed 20 Nov 2004 14:40:40 -0000 1.5
@@ -17,7 +17,8 @@
__NAME__ description
-Many &glos-HTML; editing applications do not support &glos-itl; directly, and some
+Many &glos-HTML; editing applications do not support &glos-ITL; directly, and
+some
(thinking it doesn't belong to the page) ruin your work. This is
understandable to an extent, because some ITL tags (such as <tag>list</tag>)
appear in places that raise errors with HTML syntax checking algorithms.
More information about the docs
mailing list