User Tools

Site Tools


computing:epeios:tools:dpkq:manual

Table of Contents

dpkq user manual

Name

dpkq - data picker based on the Epeios framework.

Synopsis

dpkq --help
    Displays this page.
dpkq --version
    Displays the version of the program.
dpkq --license
    Displays the program license.
dpkq [-p|--process] [-n|--namespace=<ns>] <project> [<id>]
    Process data.

<ns> ('Parameters/Namespace/Label'(='dpk')):
    Namespace to use.
<project> ('Parameters/ProjectFilename'):
    Project file name.
<id> ('Parameters/Id'):
    Record id ('0': all records; missing: random record).

Description

dpkq is a data picker based on the Epeios framework. It randomly picks a record from a table stored in an XML file, putting this unique record in another XML file, associating it with an XSL file, so it can be displayed with an HTML layout in a Web browser.

<project> is the project file name, which contains, under other, the filename containing the data, and the XSL filename.

For a typical use of dpkq, you don't give an <id>, but, if you want to display a specific record, give its index as <id>, and to display all records; give 0 as <id>.

When dpkq picks randomly a record, it never picks an already picked record until all other records were picked at least once. The file used to keep the trace of already picked records are stored in a file defined in the project file.

When all records were picked, recently picked records are not picked again, unless you begin a new session, and all the record were picked in the previous session. All calls belong to the same session as long then the previous call occurs in a delay lesser the defined in the project file.

License

dpkq is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

dpkq is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with dpkq. If not, see <http://www.gnu.org/licenses/>.

Author

dpkq is developed by Claude SIMON (http://q37.info/contact/).

computing/epeios/tools/dpkq/manual.txt · Last modified: Wed Oct 14 12:12:23 2015 (14/10/15) by Claude SIMON