[interchange-docs] xmldocs - docelic modified 10 files

docs at icdevgroup.org docs at icdevgroup.org
Wed Nov 21 20:22:13 EST 2007


User:      docelic
Date:      2007-11-22 01:22:13 GMT
Modified:  .        README
Modified:  docbook  literals.ent reference.xsl
Modified:  refs     DomainTail IpHead IpQuad WideOpen
Modified:           dynamic_variables_file_only liven_urls.filter
Added:     refs     CountrySubdomains
Log:
* Few small updates, important is the introduction of manpages
  format back.

  The manpage stylesheets are a bit dorky (traditionally),
  but it's nothing that can't be adjusted to our exact liking
  with a few lines of xsl.

  To try it out:

   make olinkdbs-nc OUTPUT/widgets.man
   man ./OUTPUT/widgets.man/yesno.widget

Revision  Changes    Path
1.29      +3 -3      xmldocs/README


rev 1.29, prev_rev 1.28
Index: README
===================================================================
RCS file: /var/cvs/xmldocs/README,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- README	10 Sep 2007 14:57:55 -0000	1.28
+++ README	22 Nov 2007 01:22:13 -0000	1.29
@@ -32,11 +32,11 @@
 and things will still clap together nicely.
 
 Also, it is possible to generate documentation for a specific Interchange
-release, such as 5.0.0 or 5.2.0. To do so, use TARGET_RELEASE env variable:
+release, such as 5.0.0 or 5.2.0. To do so, use TARGET env variable:
 
-  TARGET_RELEASE="--last 5.2.0" make refxmls
+  TARGET="5.2.0" make refxmls
 
-Just make sure to have TARGET_RELEASE defined on each 'make' invocation.
+Just make sure to have TARGET defined on each 'make' invocation.
 
 **  -- -- --   -- -- -- --   -- -- -- --   -- -- -- --   -- -- -- --  **
 



1.50      +10 -0     xmldocs/docbook/literals.ent


rev 1.50, prev_rev 1.49
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -r1.49 -r1.50
--- literals.ent	15 Nov 2007 15:37:40 -0000	1.49
+++ literals.ent	22 Nov 2007 01:22:13 -0000	1.50
@@ -3,6 +3,15 @@
 <!ENTITY first-xmldocs-release "5.4">
 <!ENTITY PERL_VER_REQUIRED "5.6">
 
+<!-- This is used for including paragraphs based on IC version
+     they're generated for. Keep the list sorted like you see it. -->
+<!ENTITY r4.6.0 "4.6.0">
+<!ENTITY r4.8.0 "4.6.0;4.8.0">
+<!ENTITY r5.0.0 "4.6.0;4.8.0;5.0.0">
+<!ENTITY r5.2.0 "4.6.0;4.8.0;5.0.0;5.2.0">
+<!ENTITY r5.5.0 "4.6.0;4.8.0;5.0.0;5.2.0;5.5.0">
+<!ENTITY r5.5.2 "4.6.0;4.8.0;5.0.0;5.2.0;5.5.0;5.5.2">
+
 <!-- GENERAL ENTITIES -->
 <!ENTITY GNU "<ulink url='http://www.gnu.org'>GNU</ulink>">
 <!ENTITY IC "<ulink url='http://www.icdevgroup.org'>Interchange</ulink>">
@@ -39,6 +48,7 @@
 <!ENTITY GPG "<ulink url='http://www.gnupg.org/'>GPG</ulink>">
 <!ENTITY WIKIPEDIA "<ulink url='http://www.wikipedia.org/'>Wikipedia</ulink>">
 <!ENTITY MOD_PERL "<ulink url='http://perl.apache.org/'>mod_perl</ulink>">
+<!ENTITY ccTLD "<ulink url='http://en.wikipedia.org/wiki/Country_code_top-level_domain'>ccTLD</ulink>">
 
 
 



1.3       +30 -1     xmldocs/docbook/reference.xsl


rev 1.3, prev_rev 1.2
Index: reference.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/reference.xsl,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- reference.xsl	30 Mar 2006 00:43:11 -0000	1.2
+++ reference.xsl	22 Nov 2007 01:22:13 -0000	1.3
@@ -2,6 +2,7 @@
 
 <xsl:stylesheet
 	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+	xmlns:exsl="http://exslt.org/common"
 	xmlns:xi="http://www.w3.org/2003/XInclude"
 	version="1.0">
 
@@ -10,7 +11,35 @@
 
 	<xsl:param name="man.output.quietly">1</xsl:param>
 	<xsl:param name="man.charmap.enabled">0</xsl:param>
-	
+
+<!--
+	<xsl:template match="sbr">
+		<xsl:element name="br"/>
+	</xsl:template>
+-->
+
+	<xsl:template match="tag">
+		<code class='tag'>[<xsl:value-of select="."/>]</code>
+	</xsl:template>
+	<xsl:template match="option">
+		<code class='option'><xsl:value-of select="."/></code>
+	</xsl:template>
+	<xsl:template match="varname">
+		<code class='varname'><xsl:value-of select="."/></code>
+	</xsl:template>
+	<xsl:template match="check">
+		<code class='check'><xsl:value-of select="."/></code>
+	</xsl:template>
+	<xsl:template match="widget">
+		<code class='widget'><xsl:value-of select="."/></code>
+	</xsl:template>
+	<xsl:template match="pragma">
+		<code class='pragma'><xsl:value-of select="."/></code>
+	</xsl:template>
+	<xsl:template match="filter">
+		<code class='filter'><xsl:value-of select="."/></code>
+	</xsl:template>
+
 	<xsl:include href="common.xsl"/>
 	
 </xsl:stylesheet>



1.3       +11 -4     xmldocs/refs/DomainTail


rev 1.3, prev_rev 1.2
Index: DomainTail
===================================================================
RCS file: /var/cvs/xmldocs/refs/DomainTail,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DomainTail	6 Nov 2006 18:41:20 -0000	1.2
+++ DomainTail	22 Nov 2007 01:22:13 -0000	1.3
@@ -3,10 +3,6 @@
 __END__
 
 
-__NAME__ see also
-DomainTail,IpHead,IpQuad,WideOpen
-__END__
-
 
 __NAME__ synopsis
 <group choice='plain'>
@@ -21,6 +17,12 @@
 should be used in IP qualification for &glos-session; IDs.
 If, for example, an IP was <literal>ri01-053.dialin.iskon.hr</literal>,
 only <literal>iskon.hr</literal> would be used.
+</para>
+<para>
+&IC; also supports taking various &ccTLD;s into account; 
+see &conf-CountrySubdomains;.
+</para>
+<para>
 __END__
 
 TODO: how does this work with non-resolving stuff?
@@ -41,5 +43,10 @@
 <programlisting>
 DomainTail No
 </programlisting>
+__END__
+
+
+__NAME__ see also
+DomainTail,IpHead,IpQuad,WideOpen,CountrySubdomains
 __END__
 



1.4       +1 -1      xmldocs/refs/IpHead


rev 1.4, prev_rev 1.3
Index: IpHead
===================================================================
RCS file: /var/cvs/xmldocs/refs/IpHead,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- IpHead	6 Nov 2006 18:41:20 -0000	1.3
+++ IpHead	22 Nov 2007 01:22:13 -0000	1.4
@@ -4,7 +4,7 @@
 
 
 __NAME__ see also
-DomainTail,IpHead,IpQuad,WideOpen,
+DomainTail,IpHead,IpQuad,WideOpen,CountrySubdomains
 __END__
 
 



1.5       +1 -1      xmldocs/refs/IpQuad


rev 1.5, prev_rev 1.4
Index: IpQuad
===================================================================
RCS file: /var/cvs/xmldocs/refs/IpQuad,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- IpQuad	6 Nov 2006 18:41:20 -0000	1.4
+++ IpQuad	22 Nov 2007 01:22:13 -0000	1.5
@@ -4,7 +4,7 @@
 
 
 __NAME__ see also
-DomainTail,IpHead,WideOpen
+DomainTail,IpHead,WideOpen,CountrySubdomains
 __END__
 
 



1.6       +1 -1      xmldocs/refs/WideOpen


rev 1.6, prev_rev 1.5
Index: WideOpen
===================================================================
RCS file: /var/cvs/xmldocs/refs/WideOpen,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- WideOpen	9 Jul 2007 11:11:47 -0000	1.5
+++ WideOpen	22 Nov 2007 01:22:13 -0000	1.6
@@ -4,7 +4,7 @@
 
 
 __NAME__ see also
-DomainTail, CreditCardAuto, CyberCash
+DomainTail, CreditCardAuto, CountrySubdomains
 __END__
 
 



1.7       +1 -1      xmldocs/refs/dynamic_variables_file_only


rev 1.7, prev_rev 1.6
Index: dynamic_variables_file_only
===================================================================
RCS file: /var/cvs/xmldocs/refs/dynamic_variables_file_only,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- dynamic_variables_file_only	6 Nov 2006 22:34:44 -0000	1.6
+++ dynamic_variables_file_only	22 Nov 2007 01:22:13 -0000	1.7
@@ -1,5 +1,5 @@
 __NAME__ purpose
-dynamically update the configuration directives from files only
+dynamically update configuration directives from files only
 __END__
 
 



1.4       +21 -23    xmldocs/refs/liven_urls.filter


rev 1.4, prev_rev 1.3
Index: liven_urls.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/liven_urls.filter,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- liven_urls.filter	7 Sep 2005 16:29:16 -0000	1.3
+++ liven_urls.filter	22 Nov 2007 01:22:13 -0000	1.4
@@ -29,9 +29,6 @@
 (http/https, ftp and mailto) are actually enabled in the filter.
 For the rest of the protocols, you need to uncomment the appropriate
 lines in the filter source and restart &IC;.
-</para><para>
-The regular expressions used are really scary &mdash; don't try
-them at home! ;-)
 __END__
 
 __NAME__ author
@@ -42,26 +39,27 @@
 Here's an incomplete collection of URLs that the filter can recognize.
 <programlisting><![CDATA[
 [filter liven_urls]
-http://www.acl.lanl.gov/URI/archive/uri-archive.index.html<br/>
-ftp://@host.com/<br/>
-ftp://host.com/<br/>
-ftp://foo:@host.com/<br/>
-ftp://myname@host.dom/%2Fetc/motd<br/>
-ftp://myname@host.dom/etc/motd<br/>
-ftp://myname@host.dom//etc/motd<br/>
-file://vms.host.edu/disk$user/my/notes/note12345.txt<br/>
-prospero://host.dom//pros/name<br/>
-ldap:///o=University%20of%20Michigan,c=US<br/>
-ldap://ldap.itd.umich.edu/o=University%20of%20Michigan,c=US<br/>
-ldap://ldap.itd.umich.edu/o=University%20of%20Michigan,c=US?postalAddress<br/>
-ldap:///o=University%20of%20Michigan,c=US??sub?(cn=Babs%20Jensen)<br/>
-ldap://ldap.itd.umich.edu/c=GB?objectClass?one<br/>
-z39.50s://melvyl.ucop.edu/cat<br/>
-z39.50r://melvyl.ucop.edu/mags?elecworld.v30.n19<br/>
-z39.50r://cnidr.org:2100/tmf?bkirch_rules__a1;esn=f;rs=marc<br/>
-mid:foo4%25foo1 at bar.net<br/>
-cid:foo4*foo1 at bar.net<br/>
-mid:960830.1639 at XIson.com/partA.960830.1639 at XIson.com<br/>
+http://www.acl.lanl.gov/URI/archive/uri-archive.index.html
+ftp://@host.com/
+ftp://host.com/
+ftp://foo:@host.com/
+ftp://myname@host.dom/%2Fetc/motd
+ftp://myname@host.dom/etc/motd
+ftp://myname@host.dom//etc/motd
+mailto:noaddress at host.dom
+file://vms.host.edu/disk$user/my/notes/note12345.txt
+prospero://host.dom//pros/name
+ldap:///o=University%20of%20Michigan,c=US
+ldap://ldap.itd.umich.edu/o=University%20of%20Michigan,c=US
+ldap://ldap.itd.umich.edu/o=University%20of%20Michigan,c=US?postalAddress
+ldap:///o=University%20of%20Michigan,c=US??sub?(cn=Babs%20Jensen)
+ldap://ldap.itd.umich.edu/c=GB?objectClass?one
+z39.50s://melvyl.ucop.edu/cat
+z39.50r://melvyl.ucop.edu/mags?elecworld.v30.n19
+z39.50r://cnidr.org:2100/tmf?bkirch_rules__a1;esn=f;rs=marc
+mid:foo4%25foo1 at bar.net
+cid:foo4*foo1 at bar.net
+mid:960830.1639 at XIson.com/partA.960830.1639 at XIson.com
 [/filter]
 ]]></programlisting>
 __END__



1.1                  xmldocs/refs/CountrySubdomains


rev 1.1, prev_rev 1.0
Index: CountrySubdomains
===================================================================
__NAME__ purpose
honor ccTLD domains in IP qualification
__END__



__NAME__ synopsis
<arg choice='plain'><replaceable>country_code</replaceable></arg>
<arg choice='plain' rep='repeat'><replaceable>ccTLD_list</replaceable></arg>
__END__


__NAME__ description
This directive enables &IC; to take &ccTLD;s into account when 
&conf-DomainTail; is enabled.
</para><para>
For example, if a visit comes from an address like
"<literal>machine.example.co.uk</literal>" and <literal>co.uk</literal>
is listed as &ccTLD;, then, with
&conf-__FILENAME__;, "<literal>example.co.uk</literal>" would be used
as domain tail instead of just "<literal>co.uk</literal>".
</para><para>
&conf-__FILENAME__; accepts a list of country codes and their
subdomains. A predefined,  ready for use configuration
block can be found in file
&cvsfile-dist_subdomains.cfg; in &IC; source and
should be included from &gcf;.
__END__


__NAME__ example: Including ready-made subdomains.cfg in interchange.cfg
<programlisting>
include subdomains.cfg
</programlisting>
__END__

__NAME__ example: Appending or overwriting entries in CountrySubdomains list
<programlisting>
CountrySubdomains &lt;&lt;EOC
  ae "ac gov mil name net org pro sch"
  af "bank com edu gov hotel law music net org tv"
  ag "co com org net nom"
  al "com edu gov net org"
  ao "co ed gv it og pb"
EOC

CountrySubdomains ar "com edu gov int mil net org" at "ac co gv or priv"
</programlisting>
__END__

__NAME__ see also
DomainTail,IpHead,IpQuad,WideOpen,CountrySubdomains
__END__

__NAME__ author
&kwalsh;
__END__









More information about the docs mailing list