Re: [openMSX-devel] Status of dumps in the software database

[Manuel B. <ma...@ms...>]

Hi Wouter and all,

Initially I just wanted to parse the <original> tag in openMSX to show 
info about it to the user, to fix the problem I explained in my previous 
mail. All, without any real changes to the existing format; as I said it 
already works right now with the current format and data.

Then I thought that it might be good to formalize the values we could 
use in the tags (that doesn't really change the format itself), so I 
wrote the proposal. I already knew it was mixing up stuff, as I wrote in 
the original mail.

Wouter's proposal seems very good to me: it still doesn't involve many 
changes (unless info gets added) and gives the same information, but 
then much better modeled, without mixing things up.

So, now I'm calling all parties to give more comments, so that we can 
adopt or reject this proposal for the format of our common software 
database.

Especially blueMSX folks, let yourself be heard!

Wouter Vermaelen wrote:
> I propose to split this infomation in three separate tags:
>  - <original>
>      Mostly compatible with the existing <original> tag, it has a
>      required 'value' attribute with possible values 'true', 'false' or
>      'unknown'. The data of this tag provides additional information:
>      For value=true it indicates the source that confirmed originality.
>      For value=false it indicates why it's not an original (e.g. modified
>      to work with a different mapper type or modified with 99 lives
>      cheat).
>      In the previous proposal this tag was required. I'd like to relax
>      this: when this tag is missing it defaults to
>         <original value=unknown"/>
> 
>  - <working>
>      A required 'value' attribute with possible values 'true', 'false'
>      or 'unknown'. Again the data provides additional info, most likely
>      a description of why the rom is not working (e.g. hangs at intro
>      screen).
>      When this tag is missing it defaults to
>         <working value="true"/>
>      if there is an <original> tag with value=true and to
>         <working value="unknown"/>
>      otherwise
> 
>  - <translated>
>      A required tag 'language' that indicates the target language (still
>      need to discuss the format of this target language). The data part
>      could give additional information (who did the translation, quality
>      of the translation, ...).
>      When this tag is missing the rom is assumed to be not translated.
> 
> 
> Examples (all redundant tags are left out):
> 
>   ## original, working rom (confirmed by GoodMSX), not translated
>   <original value="true">GoodMSX</original>
>     implicit information: <working value="true"/>
>                           not translated
> 
>   ## not much known about this rom
>     (no <original> <working> or <translated> tags)
>     implicit information <original value="unknwon"/>
>                          <working value="unknown"/>
>                          assumed not translated
> 
>   ## translated rom, working ok
>     <original value="false"/>
>     <working value="true"/>
>     <translated language="en"/>
> 
>   ## Non-working rom. Probably non-original rom, but not known for sure
>     <working value="false">Only works with RAM in unexpanded slot 3</working>
>     implicit information: <original value="unknown"/>
>                           assumed not translated
> 
> 
> Required changes to the existing database:
>   If we accept this complete proposal then some (or all?)
>      <original value="false"/>
>   tags need to be removed from the database.

(thinking out loud)
They don't really hurt, though, do they? They're just not very 
informative. But you probably mean that it should be set to 'unknown'. 
OK, so you're right :)

>   AFAICS this is the only required change, all the rest are just
>   additional (non-required) tags.

When we add data about translations, and whether they are working, that 
data should be added of course, and the code that makes it XML should be 
adjusted. AFAIK Patrick maintains that code and also the database. So, 
we need to ask him to do the necessary changes (which you already 
explained at the top part of your mail).
Of course only if this proposal is accepted by both teams.

-- 
Grtjs, Manuel

PS: MSX FOR EVER! (Questions? http://faq.msxnet.org/ )
PPS: Visit my homepage at http://manuel.msxnet.org/