[freedict] Re: revisionDesc/change

  • From: Sebastian Humenda <shumenda@xxxxxx>
  • To: freedict@xxxxxxxxxxxxx
  • Date: Wed, 6 Dec 2017 22:07:16 +0100

Hi

Karl Bartel schrieb am 06.12.2017, 17:35 +0000:

The description of revisionDesc/change in or HOWTO at
https://github.com/freedict/fd-dictionaries/wiki/FreeDict-HOWTO-%E2%80%93-Writing-Text-Encoding-Initiative-XML-Files#revisiondescchange
raises some questions for me:
My answers here are based on what I've seen so far and what *I* think is
sensible.

1. Is <change n="0.1" supposed to be <change version="0.1" ? If so,
shouldn't it be in the attributes section of
http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-change.html ? I see
neither n nor version there.
Not specified doesn't necessarily mean it's not allowed, IIRC we're free to
define attributes. I find version more sensible, but virtually all our
dictionaries use n, so let's stick to that (if it doesn't clash with TEI).

2. The date of the change is encoded in both the date tag and the when
attribute. Which one is the preferred way to encode it? Or should I really
use both?
Good question. The date tag isn't mandatory, so the API generator uses whatever
is available. I usually use both.

3. How should I encode the person doing the change? The example shows
who="#some_user". This seems to reference a user declaration somewhere
else. Do we have an example how that "somewhere else" should look? Or
should I use <name> tags instead, like we do in at least some of our
dictionaries?
The who is for the user name and the name for the full name. IMHO the `<name/>`
is better, it names a real person. Is the # mandatory for the who attribute?
I've released all dictionaries without the hash, so might need to change it. :)

In summary, I'm not sure that we need standardisation on these points, although
I wouldn't mind it.
For instance, there could potentially be changes without a new release, so it's
fine to have changes without a release indication. Regarding the date: the only
requirement is that there is a date and again, I don't mind whether it's in the
revisionDesc or somewhere else. The code to handle this is in in place.  Feel 
free
to propose something more strict, if it is in line with the TEI guidelines.

Sebastian
-- 
Web: https://www.crustulus.de ;(English|Deutsch)  | Blog: 
https://www.crustulus.de/blog
FreeDict: Free multilingual dictionaries - http://www.freedict.org
Freies Latein-Deutsch-Wörterbuch: https://www.crustulus.de/freedict.de.html

Attachment: signature.asc
Description: PGP signature

Other related posts: