[docs] xmldocs - docelic modified 3 files
docs at icdevgroup.org
docs at icdevgroup.org
Sun Dec 18 07:51:13 EST 2005
User: docelic
Date: 2005-12-18 12:51:13 GMT
Modified: refs counter.tag export.tag field.tag
Log:
* Two updates, one new
Revision Changes Path
1.4 +1 -1 xmldocs/refs/counter.tag
rev 1.4, prev_rev 1.3
Index: counter.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/counter.tag,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- counter.tag 18 Dec 2005 11:32:11 -0000 1.3
+++ counter.tag 18 Dec 2005 12:51:12 -0000 1.4
@@ -375,7 +375,7 @@
__END__
__NAME__ example: MySQL database counter
-Create table <database>table2</literal> and a sequence <literal>counter2</literal> in that database:
+Create table <database>table2</database> and a sequence <literal>counter2</literal> in that database:
<programlisting>
create table table2(counter2 int NOT NULL AUTO_INCREMENT PRIMARY KEY);
</programlisting>
1.2 +105 -6 xmldocs/refs/export.tag
rev 1.2, prev_rev 1.1
Index: export.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/export.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- export.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ export.tag 18 Dec 2005 12:51:12 -0000 1.2
@@ -1,8 +1,16 @@
+__NAME__ purpose
+export a database to a text file
+__END__
+
__NAME__ synopsis
<row>
<entry>
- delete
+ <group choice='opt'>
+ <arg choice='plain'>table</arg>
+ <arg choice='plain'>database</arg>
+ <arg choice='plain'>base</arg>
+ </group>
</entry>
<entry>
<!-- POS -->
@@ -14,14 +22,14 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Table name to export
</entry>
</row>
<row>
<entry>
- verify
+ field
</entry>
<entry>
<!-- POS -->
@@ -33,14 +41,94 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ The column to add or delete
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ file
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ Filename to export to. Note that &conf-NoAbsolute; directive and other
+ conditions may affect the range of possible locations
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ sort
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ Sorting option in format of
+ <literal><replaceable>sort_field</replaceable>:<replaceable>sort_option</replaceable></literal>.
</entry>
</row>
<row>
<entry>
- hide
+ type
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ Output format
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ delete
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ Instead of adding, delete column specified by the
+ <literal>field</literal> attribute?
+ (In effect only if <literal>verify</literal> attribute is enabled)
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ verify
</entry>
<entry>
<!-- POS -->
@@ -56,6 +144,17 @@
</entry>
</row>
+&ROW_HIDE_0;
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+
+__NAME__ see also
+import, mv_sort_option
+__END__
+
+
+__NAME__ description
+The tag exports named &glos-database; to a text file.
+__END__
1.2 +68 -0 xmldocs/refs/field.tag
rev 1.2, prev_rev 1.1
Index: field.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/field.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- field.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ field.tag 18 Dec 2005 12:51:12 -0000 1.2
@@ -0,0 +1,68 @@
+__NAME__ purpose
+quickly retrieve field from Products database
+__END__
+
+
+__NAME__ synopsis
+<row>
+
+ <entry>
+ <group choice='optional'>
+ <arg choice='plain'>name</arg>
+ <arg choice='plain'>column</arg>
+ <arg choice='plain'>col</arg>
+ <arg choice='plain'>field</arg>
+ </group>
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ <group choice='optional'>
+ <arg choice='plain'>code</arg>
+ <arg choice='plain'>row</arg>
+ </group>
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ </entry>
+</row>
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;
+__END__
+
+__NAME__ see also
+data, description, price
+__END__
+
+__NAME__ description
+The tag conveniently retrieves the field from the &glos-database;s listed
+under &conf-ProductFiles;.
+It will return the first entry found in the series of product databases,
+so if you are only looking for a specific table, better use the generic
+&tag-data; tag.
+__END__
+
+__NAME__ notes
+If you only have one &conf-ProductFiles; database — <database>products</database>, then <code>[field <replaceable>column</replaceable> <replaceable>key</replaceable>]</code> is, of course, the same as <code>[data products <replaceable>column</replaceable> <replaceable>key</replaceable>]</code>.
+__END__
More information about the docs
mailing list