[interchange-docs] xmldocs - docelic modified 15 files
docs at icdevgroup.org
docs at icdevgroup.org
Mon Apr 3 19:28:57 EDT 2006
User: docelic
Date: 2006-04-03 23:28:57 GMT
Modified: bin stattree
Modified: refs ConfigParseComments
Added: glossary DSN
Added: refs DEBUG DOCROOT DiscountSpacesOn ESLASH GPG_PATH
Added: IMAGE_DIR MV_DHTML_BROWSER MV_FORTUNE_COMMAND NULL
Added: SQLDSN SURVEY_LOG_DIR VISIT_TIMEOUT
Log:
- bin/stattree: prevent indexing of xfer_catalog.coretag: adds too much noise
- refs/*: updates and new
Revision Changes Path
1.51 +5 -1 xmldocs/bin/stattree
rev 1.51, prev_rev 1.50
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.50
retrieving revision 1.51
diff -u -r1.50 -r1.51
--- stattree 27 Mar 2006 22:38:30 -0000 1.50
+++ stattree 3 Apr 2006 23:28:56 -0000 1.51
@@ -247,6 +247,9 @@
# statistic.
return if $file =~ m#^(eg|extra|SPECS|debian|scripts|extensions)/#;
+ # This one makes a hell of a lot noise for nothing...
+ return if $file =~ m#xfer_catalog#;
+
# Here, we know it's a file, and a text file in fact
# So open the file and parse contents
@@ -673,7 +676,8 @@
if (
($c{line} =~ /(()|\$())\$(::)?Variable(->\2|\3){(\w+?)}/ and $name=$6)
or ($c{line}=~/\$Tag->var\s*\(\s*(["'])(\S+?)\1(\s*,\s*(2))?/ and $name=$5)
- or ($c{line} =~ /[^_\/]__([^_]\w+?)__[^_\/]/ and
+ # The (#!) prevents finding #!__PERL__ in code/UI_Tag/xfer_catalog.coretag
+ or ($c{line} =~ /[^_\/(#!)]__([^_]\w+?)__[^_\/]/ and
( $1 !~ /^(END|DIE|MYVAR|PACKAGE|NAME|none|WARN)$/) and $name=$1)
or ($c{line} =~ /\[var (\S+?)\]/i and $name=$1)
or ($c{line} =~ /\[var (\S+?)\s+2\s*\]/i and $name=$1)
1.1 xmldocs/glossary/DSN
<<DSN: empty>>
1.3 +6 -1 xmldocs/refs/ConfigParseComments
rev 1.3, prev_rev 1.2
Index: ConfigParseComments
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigParseComments,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ConfigParseComments 8 Dec 2004 12:39:58 -0000 1.2
+++ ConfigParseComments 3 Apr 2006 23:28:56 -0000 1.3
@@ -1,5 +1,5 @@
__NAME__ purpose
-treat config meta-directives as plain comments
+(obsolete) treat config meta-directives as plain comments
__END__
@@ -8,6 +8,11 @@
<arg choice='plain'>Yes</arg>
<arg choice='plain'>No</arg>
</group>
+__END__
+
+__NAME__ notes
+This directive is obsolete as of &IC; 5.5.0, and the behavior is
+as if <code>ConfigParseComments Yes</code> was specified.
__END__
1.1 xmldocs/refs/DEBUG
rev 1.1, prev_rev 1.0
Index: DEBUG
===================================================================
__NAME__ purpose
enable Interchange debugging
__END__
__NAME__ see also
DebugFile
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><literal>0</literal></arg>
<arg choice='plain'><literal>1</literal></arg>
</group>
__END__
__NAME__ description
Enable &IC; debug messages. Always used in combination with &conf-DebugFile;.
__END__
__NAME__ example: Defining DEBUG
<programlisting>
Variable DEBUG 1
DebugFile /tmp/icdebug
</programlisting>
__END__
1.1 xmldocs/refs/DOCROOT
rev 1.1, prev_rev 1.0
Index: DOCROOT
===================================================================
__NAME__ purpose
filesystem path to catalog's document root
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>path</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies filesystem path to the
corresponding catalog's &glos-DOCROOT;.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ example: Setting DOCROOT
<programlisting>
Variable DOCROOT /var/www/CATALOG/htdocs/
</programlisting>
__END__
1.1 xmldocs/refs/DiscountSpacesOn
rev 1.1, prev_rev 1.0
Index: DiscountSpacesOn
===================================================================
__NAME__ purpose
__END__
__NAME__ see also
DiscountSpaceVar
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
__END__
__NAME__ example: Defining DiscountSpacesOn
<programlisting>
DiscountSpacesOn Yes
</programlisting>
__END__
1.1 xmldocs/refs/ESLASH
rev 1.1, prev_rev 1.0
Index: ESLASH
===================================================================
__NAME__ purpose
(obsolete)
__END__
__NAME__ synopsis
__END__
__NAME__ description
__END__
__NAME__ notes
This variable is a consequence of a typing mistake in the source.
The proper variable you should refer to is named &var-SLASH;.
__END__
__NAME__ see also
SLASH
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/GPG_PATH
rev 1.1, prev_rev 1.0
Index: GPG_PATH
===================================================================
__NAME__ purpose
location of the gpg program
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>path</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies the location of the
<command>gpg</command> program.
__END__
__NAME__ notes
__END__
__NAME__ see also
EncryptProgram, PGP
__END__
__NAME__ example: Setting GPG_PATH
<programlisting>
Variable GPG_PATH /opt/gnupg/bin/gpg
</programlisting>
__END__
1.1 xmldocs/refs/IMAGE_DIR
rev 1.1, prev_rev 1.0
Index: IMAGE_DIR
===================================================================
__NAME__ purpose
(obsolete)
__END__
__NAME__ synopsis
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_DHTML_BROWSER
rev 1.1, prev_rev 1.0
Index: MV_DHTML_BROWSER
===================================================================
__NAME__ purpose
regular expression matching HTTP user agents with DHTML support
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>regexp</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies &glos-regexp; to use in matching
DHTML-capable client browsers (HTTP user agents).
program binary.
__END__
__NAME__ notes
__END__
__NAME__ see also
XHTML, MV_HTML4_COMPLIANT
__END__
__NAME__ example: Setting MV_DHTML_BROWSER
<programlisting>
Variable MV_DHTML_BROWSER MSIE [5-9].*Windows|Mozilla.*Gecko
</programlisting>
__END__
1.1 xmldocs/refs/MV_FORTUNE_COMMAND
rev 1.1, prev_rev 1.0
Index: MV_FORTUNE_COMMAND
===================================================================
__NAME__ purpose
location of the Unix fortune program
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>path</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies the location of the infamous Unix fortune
program binary.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ example: Setting MV_FORTUNE_COMMAND
<programlisting>
Variable MV_FORTUNE_COMMAND /usr/local/bin/fortune
</programlisting>
__END__
1.1 xmldocs/refs/NULL
rev 1.1, prev_rev 1.0
Index: NULL
===================================================================
__NAME__ purpose
(obsolete)
__END__
__NAME__ synopsis
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/SQLDSN
rev 1.1, prev_rev 1.0
Index: SQLDSN
===================================================================
__NAME__ purpose
default DSN string used for SQL database connections
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>DSN</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies the default &glos-DSN; to be used in
&glos-SQL; database connections.
__END__
__NAME__ notes
No magic is happening here, mind you. Your "template", the demo catalog,
or some piece of code must — at some point — refer to the
&var-SQLDSN; variable explicitly. &IC; does not somehow do this by itself.
__END__
__NAME__ see also
__END__
__NAME__ example: Setting SQLDSN
<programlisting>
Variable SQLDSN dbi:Pg:dbname=MYDBNAME
</programlisting>
__END__
1.1 xmldocs/refs/SURVEY_LOG_DIR
rev 1.1, prev_rev 1.0
Index: SURVEY_LOG_DIR
===================================================================
__NAME__ purpose
directory to store survey results
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>path</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies the directory to store survey results.
__END__
__NAME__ see also
__END__
__NAME__ example: Setting SURVEY_LOG_DIR
<programlisting>
Variable SURVEY_LOG_DIR logs/survey
</programlisting>
__END__
1.1 xmldocs/refs/VISIT_TIMEOUT
rev 1.1, prev_rev 1.0
Index: VISIT_TIMEOUT
===================================================================
__NAME__ purpose
time after which user request is treated as new visit
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>seconds</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies the minimal time required between
two user requests, for the next request to be treated as the beginning
of a new user visit (and not as part of the current series of requests).
__END__
__NAME__ see also
__END__
__NAME__ example: Setting VISIT_TIMEOUT
<programlisting>
Variable VISIT_TIMEOUT 600
</programlisting>
__END__
More information about the docs
mailing list