[Jajuk-developers] Re: Label Edits and Documentation Status

[Bertrand F. <ber...@fl...>]

> In that case, I am done with the labels for now.
OK

>
> I have also worked on the banner some and will send that soon or should=
 I
> commit that to go with the other pictures as well?

Please commit with pictures in image directrory (image/included dir is
only for images inside the app itself). Please give me your sourceforge
login for me to add you commit rights.

> I will begin on the docs as soon as possible and will let you know of
> anything
> I am unsure of. If that is okay with you I am probably going to start b=
y
> redoing any screenshots to make them look more professional.

Do you mean manual screenshots like in playlist repository view page ?
For the manual, please note that according to me, we must avoid to includ=
e
panel screenshots but only screen parts at best because:
- it takes far too mush space and increase distribution size.
- it changes with releases and it should be mainteded later and this is
*very* time consumming and pretty useless.
This is why we just show function icons that can be easily updated or
screen parts if really needed.

> Also, if you have could provide some instructions on how to compile and
> use my working version of Jajuk with labels and documentation modified =
I
would appreciate it. I haven't worked on any larger java software
projects so
> I'm not as familiar with the build processes in Eclipse as I wish.

you can use the build-dist.xml ant script (javahelp target) provided in
scripts directory and adapt it for your own system but I'm not sure it is
really useful for you to package javahelp by yourself as it can be simply
seen as standard HTML pages. According to me, all you should have to deal
with is to work on standard HTML pages, simplest as possible and make sur=
e
images and icons href are releative, not absolute ( see current html page=
s
for directories). The way you will see the doc in your navigator is the
same than in javahelp panel.
Nevertheless, when the doc will be ready, we will work together to change
the javahelp conf files (XML) mapping the HTML files.

About the doc itself:
- Don't be too ambitious and do not plan to rewrite everything as writing
doc is increadibly time consuming, it toke me hours for a single page, so
make sure you really have time to work on it and maintening it later.
- Note that French doc is currently a simple translation of the english
manual. If you change everything, I will not be able to adapt it and the
two documentations will be desynchronized. It is not a huge probleme, jus=
t
anoying.
- Before starting on new doc structure, please tell us to check we are al=
l
OK.
- Think about maintenance for people who will work on the doc after you i=
f
you give up: be short, avoid repeating.
- Be short and informative: many of users will never read this manual. Fo=
r
others, the manual should be really informative (not just telling this
button does that... they can read, you have to bring added value) and
short.

According to me, the most useful way to work on doc right now should be:
- To keep current strucuture and making only few changes
- to fix current manual on grammar and improve global quality.
- To add the new 1.2 features (not a big deal)
It would be nice to get this work done for 1.2 (may). If you think we
should have a deep manuel structure review, this can be done during 1.3
dev.

Thanks,

Bertrand
>
> Thanks,
> Mike Kelp
> Edom Group
>
> On Tuesday 11 April 2006 4:05 pm, you wrote:
>> Mike Kelp wrote:
>> >Sorry for sending this to you directly, but I tried to send this to t=
he
>> > list but got a returned message error that I will forward to you.
>> >
>> >I'm almost finished editing the entire labels file for correctness, b=
ut
>> >would like to know the following:
>> >1) Where is the Automatic DJ settings, etc.?
>> >2) Where is the Wikipedia settings?
>> >
>> >I should be ready to commit tonight or tomorrow. After this I will
>> begin
>> >working on the documentation.
>> >
>> >Thanks.
>> >
>> >--
>> >Mike Kelp
>> >
>> >--Education's purpose is to replace an empty mind with an open one.
>> >~Malcolm S. Forbes
>> >--If knowledge is power, know this is tyranny.
>> >~Thrice
>>
>> Hi Mike,
>>
>> I believe SF experienced some mailing list issues, hope it will be OK
>> now.
>>
>> 1) DJ settings dev is not finished and I'm currently working with wiza=
rd
>> projet (from java.net) team to produce a working wizard but I'm afraid=
 I
>> will have to give for now. All of this will be implemented for 1.2 so
>> you have time, you can come back later to check labels when dev will b=
e
>> over. For doc, I will tell you when all new features will be ready for
>> 1.2. Current features are mainly unchanged from 1.1 except some
>> enhancements I will detail for you to update doc.
>>
>> 2) Wikipedia view is implemented but disabled because JDIC browser is
>> too buggy for now (memory leaks...). I will make it online as soon as
>> jdic will be fixed. You have not to document this for now but you can
>> check labels in advance.
>>
>> For commit, I have to give you commit rights. For that, can you give m=
e
>> your sourceforge unix login ?
>>
>> Thanks for your help.
>>
>> Bertrand
>