Kpairs Theme Schema

[Marco Calignano]

On 09/08/2011 12:31 AM, todd rme wrote:
> On Wed, Sep 7, 2011 at 11:29 PM, Marco Calignano<marco.calignano at web.de>  wrote:
>>
>> On 09/07/2011 10:38 PM, todd rme wrote:
>>> First, has a consensus been reached on whether a new file format or an
>>> extension to the existing kvtml would be used?  The conversation seems
>>> to have gotten cut short.
>> I answered to this in a long email and I don't think that using kvtml give
>> us any advantage
> I know this was your conclusion, but there didn't seem to be a
> consensus on this and nobody got a chance to respond to your post.
so let hear some responces.
>
> [snipped things we agree on]
>
>>> 4. An explicit version number
>> we already the date field why do you need a version number?
> Because people seem to like using version numbers for keeping track of
> versions.  I would say it is the same reason why any other software
> uses versions instead of dates.  It is also quicker and easier to
> process visually.
ok
>>> 7. A sound for turning the card over
>> This we thought it was too much
> Why?
>
>>> Can the theme be set to use icons from the current icon theme in
>>> places where pictures are normally used?
>> I guess it could by why?
> See the next question (for instance it would be easier to just ask to
> use the "speaker" or "sound file" icon than packaging an svg).
we could also support this in later version.
>>> Shouldn't we figure out how to do translations before we finalize the
>>> format?  These might require more fundamental changes to the format.
>> <word lang='en'>lion</word>
>> here the attribute 'lang' is mandatory and one element word has to be
>> specified for each different language.
>> So the translation is already there.
> What about for the intro section?  The format example in the first
> email says the translations of this part need to be worked out.
>
> Also, should sound files be localizable as well, since they could
> contain speech?  What about videos, that could have speech or text?
> Pictures may have text in them as well.  So should these support an
> optional language tag?
Ok!
>>> Regarding files, we have discussed how the xml file will be formatted,
>>> but presumably there will need to be a package that contains the
>>> images, sounds, and/or videos to go along with it.  How will these
>>> files be formatted?  I assume they will be tarballs, but she would
>>> come up with a new extension name for them?  What compressed
>>> containers will be supported?
>> The supported compress containers are:
>> compressed tarballs   (tar.gz, tar.bz2)
>> in each tarball there are al the multimedia files plus a .game file that
>> contains the theme specific.
> So how are the files organized?  Should they be organized by category,
> file type, a flat list, or some other structure?  Should they go in
> the root directory or be organized into one big "files" directory (or
> something like that)?  What will the directories, if any, be called?
> Where will the xml file go?  Does the xml file need to have a specific
> name?  Will the tarball have a specific custom extension or just use
> tar.gz, tar.bz2, etc?  What is the .game file (your sentence appears
> to have gotten cut off)?
Till now the tarball is just a collection of all the multimedia file 
plus the .game file (our xml).
All the files are in the root directory of the tarball.
The are no restriction on names.


> -Todd
> _______________________________________________
> kde-edu mailing list
> kde-edu at mail.kde.org
> https://mail.kde.org/mailman/listinfo/kde-edu
>


And here then another example with all changes we are discussing:
zoo.game:


<?xml version="1.0"?>

<pairs>
<title>Zoo</title>
<description>Little zoo</description> <!--todo: we'll have to figure out 
how to get this translated-->
<author>Marco Calignano</author>
<date>21/03/2012</date>
<version>1.0</version>


<!-- we can use the same semantics as in the elements -->
<sound type='missed' src='missed.ogg' />
<sound type='found' src='found.ogg' />
<sound type='turn' src='turn.ogg' />
<image type='back' src='zoo.svg' />
<image type='trasparent_back' src='backtr.svg' />
<image type='bakcground' src='all_animal.svg' />

<main type='image' />

<!-- now come the list of the elements -->
<element>
<sound src='lion.ogg' lang='en' />
<video src='lion.ogv' lang='en' />
<image src='lion.svg' lang='en'/>
<image src='baby_lion.svg' lang='en' category='babies'/>
<sound src='baby_lion.ogg' lang='en' category='babies'/>
<video src='baby_lion.ogv' lang='en' category='babies'/>
<image src='baby_lionit.svg' lang='it' category='babies'/>
<sound src='baby_lionit.ogg' lang='it' category='babies'/>
<video src='baby_lionit.ogv' lang='it' category='babies'/>

<word lang='en'>lion</word>
<word lang='it'>leone</word>
<word lang='de'>loewe</word>
</element>
</pairs>


Cheers
Marco