====== dpkq: data picker ======
===== Introduction =====
//dpkq// is a tool from the //Epeios// project which picks a random record stored in a XML file and put it in another XML file with an XSL file association so it can be displayed in a Web Browser in a HTML layout.

#@OS_HTML~dpkq~@#

===== Installation =====

See the [[computing:epeios:compilation:|compilation dedicated page]] to see how to obtain the binaries.

Two files called ''dpkq.xcfg'' and ''dpkq.xlcl'' have to be in the same directory as the one containing the binary.

===== The data file =====

See the [[.data:|dedicated page]].

Take also a look to the [[.examples:|examples page]].

===== The output file =====

See the [[.output:|dedicated page]].

===== Configuration =====

See the [[computing:epeios:configuration:|configuration dedicated page]].

Other configurations parameters are generally put in a project file, which filename is given as a command-line argument (see ''dpkq %%--%%help''), like following:

<code xml>
<?xml version="1.0" encoding="utf-8"?>
<Projects>
	<Project target="dpkq">
		<Parameters>
			<Output>OutputFilename</Output>
			<Data>DataFilename</Data>
			<XSL>XSLFilename</XSL>
			<Context>ContextFilename</Context>
			<SessionMaxDuration>SessionDuration</SessionMaxDuration>
			<Viewer>ViewerCommand</Viewer>
		</Parameters>
	</Project>
</Projects>
</code>

  * ''//OutputFilename//'' is the name of the generated XML file (hence generally suffixed with ''.xml'') which contains the picked record,
  * ''//DataFilename//'' is the name of the XML file (hence also generally suffixed with ''.xml'') from where the record is picked, 
  * ''//XSLFilename//'' is the name of the file containing the XSL stylesheet (hence generally suffixed with ''.xsl'') which should be applied on the file referenced by ''//OutputFilename//'' ; ''//XSLFilename//'' is added in a ''<?xml-stylesheet ...?>'' processing instruction into the ''//OutputFilename//'' file, so that the XSLT processing is performed automatically when the output file is opened in a Web browser,
  * if the delay between two successive calls of ''dpkq'' on project files using same ''//ContextFilename//'' (which is generated by ''dpkq'') exceeds ''//SessionDuration//'' minutes, the session related data are reseted.
  * ''//ViewerCommand//'' usually contains the command to launch to open the output file name in a Web Browser ; it can contain following markers:
    * ''**$RI$**'': the record index,
    * ''**$RL$**'': the record label,
    * ''**$TI$**'': the table index,
    * ''**$TL$**'': the table label,
    * ''**$LB$**'': the last box for the current session,
    * ''**$CB$**'': the box containing the record,
    * ''**$Data$**'': the data filename,
    * ''**$Output$**'': the output filename,
    * ''**$XSL$**'': the XSL filename,
    * ''**$$**'': the ''$'' character.


===== License =====

#@H_LICENSE_HTML~dpkq~@#

===== Status =====
  * Last stable release: 20150630
  * [[http://github.com/epeios-q37/epeios/tree/master/tools/dpkq/CHANGELOG.txt|Changelog]].

===== Download =====

http://q37.info/download/computing/tools/dpkq/.

===== Author =====

#@H_AUTHOR_HTML~dpkq~@#

===== Other resources =====
  * [[computing:epeios:tools:dpkq:manual:|User manual]],
  * [[http://github.com/epeios-q37/epeios/tree/master/tools/dpkq/|source repository of the tool]],
  * //dpkq// is hosted((submission: http://savannah.gnu.org/task/index.php?13660)) on [[http://savannah.nongnu.org/projects/dpkq/|GNU Savannah]]((http://savannah.nongnu.org/projects/dpkq/)) ; you will find there some other resources for this tool (bug tracking service, tech support manager...),
  * //dpkq// is also on [[http://freshcode.club/projects/dpkq|Freshcode]], with its own RSS/Atom feed to which you can subscribe to be informed when there are new releases.