AdminAndUseDocumentation2007Story

Acceptance Criteria

Write user manual, administration manual, configuration manual and technical documentation. Write them in English, and if there are time enough, in Spanish also.

Additional Specification Comments

The user manual should explain the usage of the application from the point of view of a user, it should include screenshots if needed. Could be done using OpenOffice^? and then saved in that format and also exported to PDF and HTML.

The administration manual should explain the usage of the application from the point of view of a business manager. It should introduce the different type of tasks and the motivation of this taxonomy. It should also explain the meaning and usage of the different reports and queries, the process of user creation, contracts, holidays, etc...

The configuration manual should explain the installation process (both from Debian package and from tgz), the authentication backend configuration (SQL and LDAP), the table schema and fields, and provide some examples and hints of SQL custom queries at the result extraction section.

The technical documentation should show again the table schema, including a relational plot (to be done with some helper program like Datastudio), and also introduce the architecture of the application (templates, utility library, internationalization, page structure...) and provide some advices for extending it.

Implementation Notes

-- AndresManeiro - 03 Aug 2007

Today, i start to write outline about each document.

-- AndresManeiro - 06 Aug 2007

I resolve a foo problem today when i connect to test database. For testing i created an user who connected to test database, but i created the user and his password without md5($password) clausule from psql client. For this, when i tried to connect to test database from web interface i couldn't. Once i did some test and reviewed the code where the connection is (login.php) ... i knewn that the fail was. Now, i start to write about user and admin can do with phpreport.

-- AndresManeiro - 07 Aug 2007

Today, i had completed user manual and administrator manual sections. Now, i have that make page design and include some aplication screen shot.

In this moment, with phpreport you can do nine diferent reports (as well as much more personalized queries):

-- AndresManeiro - 08 Aug 2007

These are the queries wich you can execute from phpreport to this day. Some queries only can be executed by administrator and other by both (administrator and user roles):

The queries Q22 and Q23 seem the same but they aren't. "Date", "project" and "type" fields are required, but not "task" fields. That's what make them different:

• Returning registers

If you execute Q22 query and there is a register in database wich task value is null, the execution result don't return this register. Even though, the Q23 execute result returns the null task field too.

• Filtering registers

If you filter the Q22 query where task value equals to "analisis", it only returns registers which task value is "analisis". Even though, the Q23 query returns register which task value is "analisis" or null.

-- AndresManeiro - 08 Aug 2007

Technical document requires relational plot. In order to draw it, i found postgresql_autodoc tool wich to generate several output format files (docbook, dia, html, dot).

-- AndresManeiro - 09 Aug 2007

I am doing "reverse enginering" in order to build and document database relational plot. As i have to look for expresions like "select" or "insert" in several files, i had write a script wich does hard work for me. The script is called with one parameter (the string/regexp that you want find):

for i in `ls *.php`; do
        echo " "
        echo " ------------------------- $i: searching $1"
        cat $i | grep -ni $1
        #echo $i
done

-- AndresManeiro - 09 Aug 2007

I am writing about phpreport internationalization in technical document. In order to build phpreport internationalization, the igalia team was use gettext functions wich you must read more info about.

-- AndresManeiro - 10 Aug 2007

I start to create styles for documentation in the openoffice enviroment. I created a styles couple wich i will reuse in all documents.

-- AndresManeiro - 13 Aug 2007

Writing about what each query do (view above all queries) and its specific questions. Some tips and advices:

• Format date in database is Day-Month-Year
• Hack % is valid in order to fill text fields
• Igalian people distinguish between project task ("task or ttype") and company task ("type"). Firsts are task wich are made at a project (Analysis, Design, Publication, ...); however, company task are long time tasks (RRHH, Holidays, Hackfest, Sales, ...).

-- AndresManeiro - 14 Aug 2007

All this time i had been working with OpenOffice^? plataform in order to write documentation. Now, i write here two useful tricks wich wasted my time:

• Create a Table Of Contents with index to sections
• Tables and formats. I created a conditional style PHPreport-table to format tables, it had as conditions

In spite of this, the borders and spacing to contents weren't as i setted. It was because the table had both my custom style and other object style for table. So, i had to edit this object style too to my custom style taked effect.

-- AndresManeiro - 04 Oct 2007

I include "id" querys to table above. This "ids" are id field into "consult" table in database.

I am capturing some images from phpreport aplication in order to explain how it goes. For this, igalian people said me about two useful tools:

• import (from command line)
• screengrab (firefox extension)

Delay Causes

Final or Pending Considerations

Tasks in this story

div class="twikiTopicInfo twikiRevInfo twikiGrayText twikiMoved"<&/div>-->