Permalink
Browse files

- Added a few todo items and small fixes here and there

- Added lists of attributes used for a number of tags
  • Loading branch information...
docelic committed Dec 13, 2006
1 parent f2d8fd6 commit da86c51791b3399a9901c1efa94b13fb5abd0136
View
9 TODO
@@ -17,6 +17,15 @@
- note in configuration glossentry to use '' to skip values
- Check ConfigDatabase and DirectiveDatabase. Is description correct? One seems to be wrong
- preprocessor directives in configuration ?
+- FAQ should be desintegrated to other places
+- what doesn't racke like with WHATSNEW
+- replace itemlists with sections or tables
+- component tag has wrong source context
+Entities to create:
+- \0 null char
+- table/column/key should be defined in docbook/literals.ent as ROW_TABLE...
+- DEFAULT_JOINER_N for \n
+- SAFE_DATA
Outstanding:
=======
View
@@ -353,6 +353,8 @@ sub wanted {
line_findPragmas(\%c); # See if there's a pragma on the line
line_findGlobVars(\%c); # See if there's a global var on the line
line_findCatVars(\%c); # You get the point ....
+ #line_findGlobConfs(\%c); # Read info above the function definition
+ line_findCatConfs(\%c);
} else {
die "IMPOSSIBLE case in $file:$c{file}:$c{lnum} -- $c{line}\n";
@@ -424,6 +426,8 @@ sub wanted {
# For example, this should find PGP_HOME
line_findGlobVars(\%c, {group => $c{fsubtype}, name=>$tn});
line_findCatVars(\%c, {group => $c{fsubtype}, name=>$tn});
+ #line_findGlobConfs(\%c); # Read above function definition
+ line_findCatConfs(\%c);
line_findFunctionName(\%c, {group => $c{fsubtype}, name=>$tn});
}
next;
@@ -754,6 +758,56 @@ sub line_findGlobVars {
}
}
+#
+# XXX For CatConfs and GlobConfs, the following two functions don't actually
+# discover them in the code. (We don't need discovery routines since all
+# the catalog & global config directives are listed in Config.pm, which we
+# parse with a special routine). So the code here is named that way only
+# for the same look & feel as the rest, but it does only a subset of what
+# the similarly-named routines for other symbol types do. Namely, it only
+# discovers that conf vars are used as part of some perl code, and lists
+# them in reference pages for the respective items that use them.
+#
+
+sub line_findCatConfs {
+ ######################################################
+ # Diskover catalog directives
+ my %c = %{ (shift) };
+ my $context_data = shift;
+
+ my $name;
+
+ if (
+ ($c{line} =~ /(()|\$())\$(::)?Cfg(->\2|\3){(\w+?)}/ and $name=$6)
+ or ($c{line} =~ /(()|\$())\$(::)?Config(->\2|\3){(\w+?)}/ and $name=$6)
+ ) {
+
+ push(
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{catconf}},
+ $name) unless grep {/^$name$/}
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{catconf}}
+ }
+}
+
+sub line_findGlobConfs {
+ ######################################################
+ # Diskover global config directives
+ my %c = %{ (shift) };
+ my $context_data = shift;
+
+ my $name;
+
+ if (
+ ($c{line} =~ /(()|\$())\$(::)?Vend::Cfg(->\2|\3){(\w+?)}/ and $name=$6)
+ ) {
+
+ push(
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{globconf}},
+ $name) unless grep {/^$name$/}
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{globconf}}
+ }
+}
+
sub line_findFunctionName {
######################################################
# See if it's a beginning of a subroutine name, and remember the
View
@@ -316,3 +316,7 @@ If you need commercial support, and want the authoritative people take a look at
<!ENTITY CAs "<emphasis>CommonAdjust string</emphasis>">
<!ENTITY P "<replaceable>PREFIX</replaceable>">
+
+<!ENTITY NEWLINE "A newline (<literal>\n</literal>)">
+<!ENTITY TAB "A TAB (<literal>\t</literal>)">
+
@@ -0,0 +1,25 @@
+__NAME__ purpose
+specify directory containing generated "captcha" images
+__END__
+
+__NAME__ synopsis
+<replaceable>directory_name</replaceable>
+__END__
+
+__NAME__ description
+The variable specifies a directory where the generated &glos-captcha;
+image files should be saved to.
+</para><para>
+This directory must also be available as a web server location.
+__END__
+
+__NAME__ example
+<programlisting>
+Variable __FILENAME__ __DOCROOT__/images/captcha/
+</programlisting>
+__END__
+
+__NAME__ see also
+DOCROOT
+__END__
+
View
@@ -0,0 +1,24 @@
+__NAME__ purpose
+specify web server path containing "captcha" images
+__END__
+
+__NAME__ synopsis
+<replaceable>location</replaceable>
+__END__
+
+__NAME__ description
+The variable specifies a web server location where the generated
+&glos-captcha; image files are found, and from where they can
+be requested by clients.
+__END__
+
+__NAME__ example
+<programlisting>
+Variable __FILENAME__ /images/captcha/
+</programlisting>
+__END__
+
+__NAME__ see also
+DOCROOT, CAPTCHA_IMAGE_LOCATION
+__END__
+
View
@@ -0,0 +1,24 @@
+__NAME__ purpose
+specify subdirectory containing "captcha" images
+__END__
+
+__NAME__ synopsis
+<replaceable>subdirectory_name</replaceable>
+__END__
+
+__NAME__ description
+The variable specifies just a subdirectory name where the generated
+&glos-captcha; image are to be saved, and from where they can
+be requested by clients.
+__END__
+
+__NAME__ example
+<programlisting>
+Variable __FILENAME__ captcha/
+</programlisting>
+__END__
+
+__NAME__ see also
+DOCROOT, CAPTCHA_IMAGE_LOCATION, CAPTCHA_IMAGE_PATH
+__END__
+
View
@@ -23,7 +23,7 @@ __END__
__NAME__ description
</para><para>
The directive registers a database table for use with &IC;.
-<literal>name</literal> specifies an arbitrary name &mdash; name
+<literal>table_name</literal> specifies an arbitrary name &mdash; name
that will be used to refer to the table within &IC;. Names can be composed
of alphanumeric characters including underscore, and we recommend they're in
all lower- or upper-case.
View
@@ -30,8 +30,8 @@ you run the catalog on different locations.
<literal>module</literal>.
</para>
<para>
-This directive can also used to implicitly load &PERL; modules. If you add
-a directory name as a fourth argument, the directory will included in Perl's
+This directive can also be used to implicitly load &PERL; modules. If you add
+a directory name as a fourth argument, the directory will be included in Perl's
module search path.
__END__
View
@@ -1,5 +1,5 @@
__NAME__ purpose
-assign direct values for certain steps of the checkout procedure instead of performing calculations
+assign direct values for certain steps of checkout instead of performing calculations
__END__
__NAME__ synopsis
@@ -134,7 +134,8 @@ The <option>clear</option> option will cancel <emphasis>all</emphasis>
active assignments. To clear an individual assignment, set its value
<emphasis>to an empty string</emphasis>.
(Beware, a specification such as <literal>handling=0</literal> actually sets
-handling costs to zero, it does not clear the assignment).
+handling costs to zero, it does not clear the assignment. To clear the
+assignment, you must use <literal>handling=""</literal>).
__END__
@@ -145,6 +146,7 @@ Other behavior (such as currency formatting) is, of course, not affected.
Assigning any value other than a number (or an empty string, when clearing
assignments), will result in an error being reported and the
assignment for the "subsystem" in question cleared.
+</para><para>
<emphasis role='bold'>An assignment is allowed to be a
negative number</emphasis>.
</para><para>
View
@@ -1,23 +1,50 @@
+__NAME__ purpose
+override value of MV_PAGE on a page
+__END__
+
__NAME__ synopsis
<row>
-
<entry>
- name
+ <arg choice='plain'>file</arg>
</entry>
<entry>
- <!-- POS -->
+ Yes
</entry>
<entry>
- <!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ .
</entry>
-
</row>
-&ROW_INTERPOLATE_0;
+<row>
+ <entry>
+ <arg choice='plain'>name</arg>
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ .
+ </entry>
+</row>
+&ROW_LOCALE_1;
+&ROW_INTERPOLATE_1;
&ROW_REPARSE_1;
-__END__
+__END__
+
+__NAME__ description
+__END__
+
+__NAME__ author
+&mheins;
+__END__
+
+* Allow a page to change its path in MV_PAGE, "assuming an identity". This is
+ designed to allow virtual pages to be indistinguishable from pages that
+ have files existant.
+
Oops, something went wrong.

0 comments on commit da86c51

Please sign in to comment.