[interchange-docs] xmldocs - docelic modified 24 files
Kevin Walsh
kevin at cursor.biz
Fri Oct 13 16:48:40 EDT 2006
docs at icdevgroup.org wrote:
> rev 1.1, prev_rev 1.0
> Index: Accounting
> ===================================================================
> __NAME__ purpose
> specify accounting software and accounting options
> __END__
>
>
> __NAME__ synopsis
> <arg choice='plain'>Class <replaceable>MODULE_NAME</replaceable></arg><sbr />
> assign_username
> <group choice='plain'>
> <arg choice='plain'><replaceable>1</replaceable></arg>
> <arg choice='plain'><replaceable>0</replaceable></arg>
> </group>
> __END__
>
>
> __NAME__ description
> The directive specifies the accounting software and accounting options
> to use.
> <itemizedlist>
> <listitem><para>
> <literal>Class</literal> - name of the accounting software. Accounting
> programs are supported through the appropriate &PERL; module interfaces
> which must exist in the
> <filename class='directory'>&glos-ICROOT;/lib/Vend/Accounting/</filename>
> directory. An appropriate setting for this option is the class name;
> for instance, class name of the &PERL; module
> <filename>&glos-ICROOT;/lib/Vend/Accounting/SQL_Ledger.pm</filename>
> is <classname>Vend::Accounting::SQL_Ledger</classname>.
> </para></listitem>
> <listitem><para>
> <literal>assign_username</literal> - default 1 <!-- TODO -->
> </para></listitem>
> </itemizedlist>
> __END__
>
> __NAME__ missing
> description for assign_username
> __END__
>
> __NAME__ example: Defining __FILENAME__
> <programlisting>
> Accounting Class Vend::Accounting::SQL_Ledger
> Accounting assign_username 0
> </programlisting>
> __END__
>
>
> __NAME__ notes
> To check out which accounting modules (and therefore accounting software)
> can be used with your version of &IC;, simply invoke
> <command>ls -al <replaceable>ICROOT</replaceable>/lib/Vend/Accounting/</command>.
> __END__
>
Readable version here:
http://www.icdevgroup.org/xmldocs/confs/Accounting.html
I don't mean to stomp all over your Accounting config documentation,
but I must point out that most of it is incorrect. For instance:
Synopsis - Wrong.
Description - The assign_username part is wrong.
Example - Wrong.
Availability - Wrong (introduced in version 4.9.2, and so was
available in 5.0.0).
Source - Wrong (irrelevant block of code shown).
The "Class" text is salvageable, but the rest of the text needs to be
replaced or removed.
--
_/ _/ _/_/_/_/ _/ _/ _/_/_/ _/ _/
_/_/_/ _/_/ _/ _/ _/ _/_/ _/ K e v i n W a l s h
_/ _/ _/ _/ _/ _/ _/ _/_/ kevin at cursor.biz
_/ _/ _/_/_/_/ _/ _/_/_/ _/ _/
More information about the docs
mailing list