libkeduvocdocument name

Wed Aug 13 13:37:59 UTC 2014

Hello,

If we are going to abandon the library for a new library with the new format
, then I think we should stop work on libkdeedudocument now and not read 
any further in this email.

I think that we should keep the library and iterate toward a new api and the 
new file format, maintaining functionality for artikulate, kanagram and parley 
as we proceed.

I think that the name of the library should be meaningful even if only used
in conversations about the library.  In libkdeeduvocdocument, the kdeedu 
portion is just preamble and the document portion is misleading, because it is
more a collection of vocabulary related sets and things.

As a name I like libLexikon. It is meaningful, with fun short forms liblexi and lexi.

If we keep this library, then I think that the next 2 steps are:

1. Split the kvtml2 writer away from the core object and set it up with
unittests and a writerManager in the same way as the readerManager.
This supports future multiple output formats and will speed up development.

2. Write unittests around the individual chunks of KEduVocDocument and make 
it into a QObject with everything a property, signal, slot or overloaded function for maximum 
future source and binary compatibility. 

Give me a sign and I can start this work or not.

Andreas

---- On Mon, 11 Aug 2014 11:56:39 -0700 Inge Wallin  wrote ---- 

> Hi guys,
>  
> Sorry to be a bit late to the table, but here is my input anyway...
>  
> On Wednesday, July 30, 2014 14:41:12 Jeremy Whiting wrote:
> > Peter,
> > 
> > You make a good point. Actually the name being old isn't the only
> > reason to change it. There are two reasons. One is that
> > libkeduvocdocument is quite a mouthful. But the more important one is
> > that in the future we plan to update the library to use a new file
> > format. 
>  
> Well, this is not completely accurate, at least not if I only go the plans that are still only in my head and not written down.
>  
> It's true that we want to create the new file format but I am not sure that putting the code in the old library is the way to go. Perhaps we will create a new library that uses keduvocdocument or perhaps we will introduce incompatibilities that make the new file format not use pure keduvocdocument. 
>  
> Parley, the application, will of course still support the old formats, so no change there.
>  
> In short, do not support the name change of the repository. I think we should keep keduvocdocument for the old format and (maybe) lexikon for the new format.
>  
>  -Inge
>  
> > The technical details haven't been ironed out completely yet,
> > but ideally we want the xml and any accompanying image and sound files
> > to be included within one compressed file (most likely zip) for
> > simpler uploading, downloading, and sharing of vocabulary files. A bit
> > of work has been done looking at existing file formats and standards,
> > but nothing has been set in stone yet (or in code either) and I'd like
> > the change to be gradual rather than all at once if we can. However
> > since libkeduvocdocument has it's own git repository now I'd like to
> > have a name for the git repository and the library to begin with, it
> > will be much harder to rename the git repository or library after we
> > have a few releases with the long libkeduvocdocument name.
> > 
> > BR,
> > Jeremy
> > 
> > On Wed, Jul 30, 2014 at 2:34 PM, Peter Hedlund <peter at peterandlinda.com> wrote:
> > > Hello,
> > > 
> > > Not that I am going to argue one way or other since I am not very involved
> > > these days, but it seems that if the only reason for a change is that the
> > > name is old then I don’t see the point. It appears your real issue is
> > > with the kvtml extension but changing that would confuse existing users.
> > > 
> > > Thanks,
> > > Peter
> > > 
> > > On Jul 30, 2014, at 1:13 PM, Jeremy Whiting <jpwhiting at kde.org> wrote:
> > >> Hey all,
> > >> 
> > >> IRC has been a bit quiet the past few days since I got back from my
> > >> vacation, so I thought I'd give the mailing list a try.
> > >> libkeduvocdocument needs a new name. the current name (and new git
> > >> repo) are old, kvoctrain has been renamed to Parley for quite a long
> > >> time. kvtml derives it's name from kvoctrain, so doesn't make a lot of
> > >> sense going forward. A couple of weeks ago a discussion on irc led to
> > >> the suggestion of liblexikon which is a swedish word for dictionary
> > >> from what I understand (and is close enough to other latin based words
> > >> to be recognizable also).
> > >> 
> > >> So I propose to rename libkeduvocdocument (the library based on
> > >> frameworks and qt5, and the git repo itself) to liblexikon. If nobody
> > >> speaks up in the next week or so I'll make it happen. If anyone has a
> > >> better idea, speak now :)
> > >> 
> > >> thanks,
> > >> Jeremy
> > >> _______________________________________________
> > >> kde-edu mailing list
> > >> kde-edu at mail.kde.org
> > >> https://mail.kde.org/mailman/listinfo/kde-edu
> > > 
> > > _______________________________________________
> > > kde-edu mailing list
> > > kde-edu at mail.kde.org
> > > https://mail.kde.org/mailman/listinfo/kde-edu
> > 
> > _______________________________________________
> > kde-edu mailing list
> > kde-edu at mail.kde.org
> > https://mail.kde.org/mailman/listinfo/kde-edu
>_______________________________________________ 
>kde-edu mailing list 
>kde-edu at mail.kde.org 
>https://mail.kde.org/mailman/listinfo/kde-edu 
>
>