Sophie

Sophie

distrib > Mandriva > 9.1 > ppc > media > main > by-pkgid > 6c1629ca18f6adf273e73d0f5069fa8c > files > 337

Borges-doc-0.7.12-1mdk.noarch.rpm

<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter>
  <chapterinfo>

<!-- Please, do NOT edit the following revision history by hand. Use the
"make <module_name>.revision" target instead.  -->

<revhistory><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>write</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>translate</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>tproof</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>pproof</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>ispell</revremark> </revision><revision><revnumber>0.8</revnumber><date>YYYY-MM-DD</date><authorinitials>tbn</authorinitials><revremark>lproof</revremark> </revision>
      <revision>
        <revnumber>1.en.lproof</revnumber>
        <date>YYYY-MM-DD</date>
        <authorinitials>tbn</authorinitials>
      </revision>
      <revision>
        <revnumber>1.en.ispell</revnumber>
        <date>YYYY-MM-DD</date>
        <authorinitials>tbn</authorinitials>
      </revision>
      <revision>
        <revnumber>1.en.pproof</revnumber>
        <date>YYYY-MM-DD</date>
        <authorinitials>tbn</authorinitials>
      </revision>
      <revision>
        <revnumber>1.en.tproof</revnumber>
        <date>YYYY-MM-DD</date>
        <authorinitials>tbn</authorinitials>
      </revision>
      <revision>
        <revnumber>1.en.write</revnumber>
        <date>2002-12-10</date>
        <authorinitials>cb</authorinitials>
      </revision>
    </revhistory></chapterinfo>
  <title>Features for the Project Manager</title>
  <abstract>
    <para>The previous chapter was dedicated to the working masses. We
    will now concentrate on a few &prog-borges; features to assist
    the projet manager.</para>
  </abstract>

  <para>The project reports (<xref linkend="borges-global-report"/>)
  are of great help. But there are additional tools to remind authors
  of their current tasks (<xref linkend="borges-send-mails"/>), and to
  evaluate the work made by each author (<xref linkend="borges-accounting"/>).</para>

  <sect1 id="borges-send-mails">
    <title id="borges-revision-features-sect1-ti30">Sending Mails to
    Authors</title>
    <abstract>
      <para id="borges-revision-features-sect1-pa56">This very useful
    feature allows to prepare mails for every authors implied in the
    project. Those mails will list all tasks the author should be
    working on currently.</para>
    </abstract>
    <note>
      <para id="borges-revision-features-sect1-pa57">This feature is
      particularly useful for project managers willing to regularly
      (through cron jobs) send updated todo lists to their
      team..</para>
    </note>
    <para id="borges-revision-features-sect1-pa58">To generate the
    mails, run:

<programlisting id="borges-revision-features-sect1-pl13">make
mails</programlisting>

    in the <filename>reports/</filename> directory. That will generate
    files for each author whom has pending tasks. The filename is the
    author's email address, and the content is the body of the
    message. You can then dispatch the mails with the command:

<programlisting id="borges-revision-features-sect1-pl14">
for f in $(find . -name \*@\* -exec basename {} \;); 
  do cat $f | mail $f -s &quot;Your current tasks list for manuals&quot;;
done</programlisting></para>

    <tip>
      <para id="borges-revision-features-sect1-pa59">You can put
      additionnal information at the end of the mail, simply by
      writing your footer in the file
      <filename>conf/mailfooter.txt</filename>. You can put there
      information related to the place where to find the modules by
      CVS, WebCVS, the URL for the compiled version of the documents,
      etc.</para>
    </tip>

  </sect1>

  <sect1 id="borges-accounting">
    <title>Accounting Report</title>

    <para>This special report is made of tables for each manual and
    for the the whole project that summarizes the authors
    contributions for each modules and for each manual.</para>

    <para>To generate these reports, simply run <command>make -C
    reports/ accounting.html</command>. Then point your browser to the
    resulting file <filename>reports/accounting.html</filename>. The
    table gives all the project's super-documents in column, with the
    respective contribution of each authors on each line. There are
    totals on each line for each author, and totals for each manuals,
    plus a grand total for the whole project on the bottom right
    corner.</para>

    <para>Additionally, you will find under
    <filename>reports/&lt;Manual-Name&gt;/costs.html</filename> some more
    details reports per manual which list authors contributions to
    each module. You can also generate those manuals specific reports
    by running <command>make -C manuals/&lt;Manual-Name&gt;/
    costs.html</command></para>

    <para>Now some details on the way those casts are
calculated.</para>

    <para>The script scans all modules and calculates each
contribution with the following formula:</para>

    <programlisting>C=N*P*W/10

C=task Cost
N=number of text characters in the module
P=price per translated character
W=task weight</programlisting>

    <para>the <literal>P</literal> and <literal>W</literal> parameters
    are defined in <filename>conf/repository.xml</filename>. You
    should adjust them to your needs.</para>
  </sect1>

</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: xml
sgml-parent-document: ("../../manuals/module/psgml-top.xml" "chapter")
End:
-->