fd-dictionaries
fd-dictionaries copied to clipboard
freedict
implement <appInfo> to document importer script for imported dictionary
The TEI specification lists a <appInfo/> tag, see
http://www.tei-c.org/release/doc/tei-p5-doc/en/html/HD.html#HDAPP.
It would be good to have such a tag to document the script or program with which
the dictionary was imported. It should contain:
- application name
- application version
- path to script (or its directory) relative to the tools/ directory
<appInfo>
<application version="1.5"
ident="ImageMarkupTool"
<label>Image Markup Tool</label>
<ptr target="#P1"/>
<ptr target="#P2"/>
</application>
</appInfo>
The notAfter attribute (referenced in the URL above) could be omitted, application version is given in the above example and everything else is tracked by Git.
The following would need to be adapted:
- the shared/freedict-P5.dtd
- the shared/freedict-P5.rng
- tools/xsl/inc/(?)
Please document any progress here.
I'd suggest not omitting @notAfter -- let's not change the default where such a change is not necessary, and we cannot envision if a future tool (VLE, perchance?) wants to use this info and complains when it is not present. We lose nothing by keeping it.
It is also worth tracing the issue https://github.com/TEIC/TEI/issues/1516.
The .dtd and .rng will follow from the redone ODD. And it can be done without breaking backwards compatibility. XSLT will have to definitely be adapted. Another thing is whether to duplicate this info in the changelog in the header. I would at this moment say yes, because the changelog is for humans, while appInfo is for tools, primarily.
I would rather not dupplicate this information in the change log. I'd rather transform it to something human-readable if required (e.g. for the dict 00-entry*). Strictly speaking, it's not a change.
@bansp What would be the way to move forward? Is this now all standardised and can be go and modify our tools?