Permalink
Browse files

- Makefile: remove ordercheckout document which I'll decompose to dif…

…ferent

  locations and remove

- bin/icsdf2xml.pl: little conversion improvements

- bin/generic-autogen: just extra newlines for eyecandy

- docbook/html-*.xsl: add Interchange icon at the bottom of html pages
  along with w3c and css

- docbook/literals.ent: supporting entities

- docbook/xmldocs.css: underline html links when hovered upon,
  designer sites suggest that

- guides/ordercheckout.xml: completely formatted first section
  ("Ordering") and moved to glossary/order file.

- images/bb_interchange*: different background color

- glossary: supporting elements
  • Loading branch information...
1 parent b9dbad9 commit 2767140987f3dcc18d86a84d8d3c2d2d1bb103d8 @docelic docelic committed Dec 27, 2004
View
3 TODO
@@ -2,6 +2,7 @@
- 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.
- Finish proper formatting for online examples
+- Add ROW_REPARSE along ROW_INTERPOLATE in tag refs
Outstanding:
- why email, email-raw, SendMailProgram produce errors about usertags olink ID
@@ -27,6 +28,7 @@ DOCUMENTATION SYSTEM:
Mid-term:
+- List of mv_s, descriptions and shortcuts
- for "online" docs, also provide a form where users can add comments or
ask for clarification. (this could be done with either pure IC (forum?), or
XML forms capability, or wiki?)..
@@ -39,6 +41,7 @@ DOCUMENTATION SYSTEM:
- If filter returns Vend::xxx::something(), include that function in context
reports, and try to determine the "Uses" field (which also needs to be
added to filter refentry template or something)
+- icsdf2xml.pl -> =item/=back should be <listitem><para> not, just <para>
Tags:
aliases
View
@@ -31,7 +31,7 @@ my %header = ( # item head
",
);
my %footer = ( # item tail
- glossary => "\n</para>\n</glossdef>\n</glossentry>",
+ glossary => "\n</para>\n</glossdef>\n</glossentry>\n\n",
);
# HEAD
View
@@ -26,7 +26,10 @@
s#^=item\s+.*#</para> <para>#;
s#^=back\s*.*#</para> <para>#;
- !&in_pl and s/&/&amp;/g;
+ !&in_pl and do {
+ s/&/&amp;/g;
+ s/interchange/&IC;/gi;
+ }
s/(<[\w_-]+)/lc $1/ge and do {
s/( [A-Z]+=)/lc $1/ge;
View
@@ -46,7 +46,7 @@ my %dups; # List of symbols names that are not unique
my $last_path; # Last version we want docs generated for (say, 5.2.0).
my $compounds = 1; # Summarize similar symbol groups to single page?
-my @page_order = (qw/purpose default structure synopsis description online example notes bugs/, "symbol type", "source", "author", "copyright", "see also", "directive type");
+my @page_order = (qw/purpose default structure synopsis description online example notes bugs/, "symbol type", "source", "author", "copyright", "see also", "directive type", "variable type");
unless ( GetOptions (
"verbosedb|dumpdb|d!" => \$dumpdb,
@@ -1096,6 +1096,79 @@ $ag{source}
__ENDP__
+$templates{mv} = <<'__ENDP__';
+<refentry id="$ag{id}">
+
+<refmeta>
+<refentrytitle>$ag{"name"}</refentrytitle>
+<manvolnum>7ic</manvolnum>
+<refmiscinfo class="title">$ag{"name"}</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>$ag{"name"}</refname>
+<refpurpose>$ag{"purpose"}</refpurpose>
+</refnamediv>
+
+<refsect1 id='$ag{"name"}_synopsis'>
+<title>VALUE</title>
+<cmdsynopsis>
+$ag{"synopsis"}
+</cmdsynopsis>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_default'>
+<title>DEFAULT</title>
+<para>$ag{"default"}</para>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_description'>
+<title>DESCRIPTION</title>
+<para>$ag{"description"}</para>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_type'>
+<title>VARIABLE TYPE</title>
+<para>$ag{"variable type"}</para>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_examples'>
+<title>EXAMPLES</title>
+$ag{"example"}
+</refsect1>
+
+<refsect1 id='$ag{"name"}_notes'>
+<title>NOTES</title>
+<para>$ag{"notes"}</para>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_availability'>
+<title>AVAILABILITY</title>
+<para>$ag{"name"} is available in Interchange versions:
+</para><para>
+$ag{"available in"}</para>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_source'>
+<title>SOURCE</title>
+<para>Interchange $ag{"source ver"} ($ag{"ctxs shown"}/$ag{"ctxs total"} contexts shown):</para>
+$ag{source}
+</refsect1>
+
+<refsect1 id='$ag{"name"}_authors'>
+<title>AUTHORS</title>
+<para>$ag{"author"}</para>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_seeAlso'>
+<title>SEE ALSO</title>
+<para>$ag{"see also"}</para>
+</refsect1>
+
+</refentry>
+__ENDP__
+
+
$templates{filter} = <<'__ENDP__';
<refentry id="$ag{id}">
View
@@ -35,6 +35,12 @@
alt="Valid XHTML 1.0!"
class='w3cimg'/>
</a>
+ <a href="http://www.icdevgroup.org/">
+ <img
+ src="../images/bb_interchange.png"
+ alt="Interchange!"
+ class='w3cimg'/>
+ </a>
</p>
</xsl:template>
@@ -23,6 +23,12 @@
alt="Valid XHTML 1.0!"
class='w3cimg'/>
</a>
+ <a href="http://www.icdevgroup.org">
+ <img
+ src="images/bb_interchange.png"
+ alt="Interchange!"
+ class='w3cimg'/>
+ </a>
</p>
</xsl:template>
View
@@ -1,4 +1,7 @@
+<!-- first IC release shipping with xmldocs -->
+<!ENTITY first-xmldocs-release "5.6">
+
<!-- GENERAL ENTITIES -->
<!ENTITY GNU "<ulink url='http://www.gnu.org'>GNU</ulink>">
<!ENTITY IC "<ulink url='http://www.icdevgroup.org'>Interchange</ulink>">
@@ -247,6 +250,11 @@ option) any later version.</para>">
</row>
">
-<!-- first IC release shipping with xmldocs -->
-<!ENTITY first-xmldocs-release "5.6">
+
+<!ENTITY COMMERCIAL-SUPPORT-BLURB "
+<para>
+If you need commercial support, and want the authoritative people take a look at your problem, please join and post your request to the
+<ulink url='http://www.icdevgroup.org/mailman/listinfo/interchange-biz'>Interchange-biz</ulink> mailing list.
+</para>
+">
View
@@ -8,6 +8,10 @@
/* General */
body { background-color: #fff; }
a { text-decoration: none; }
+
+/* Let's play nice */
+a:hover { text-decoration: underline; }
+
.errortext { color: red }
View
@@ -727,3 +727,32 @@ PREFIX-field"]PREFIX-field (Optimization note- one query per field if you use th
</section>
<para>
+
+
+
+
+
+
+
+
+
+
+
+
+<!-- TODO
+
+Explain quoting here
+
+<programlisting><![CDATA[
+<a href="[area form="
+mv_todo=refresh
+mv_order_item=000101
+mv_order_fly=description=An on-the-fly item|price=100.01
+"]">Order item 000101</a>
+]]></programlisting>
+
+
+
+
+
+-->
View
No changes.
View
No changes.
Oops, something went wrong.

0 comments on commit 2767140

Please sign in to comment.