Re: [kde-doc-english] Documentation pages on techbase

[Yuri Chornoivan]

написане Wed, 15 Jun 2016 21:58:07 +0300, Burkhard Lück  
:



Am Mittwoch, 20. April 2016, 17:01:52 CEST schrieb Burkhard Lück:

Hi,

we have some pages about Documentation on techbase like

Projects/Documentation


page updated


Projects/Documentation/KDE4


removed all outdated stuff


Projects/Documentation/KDE4_(health_table)

Projects/Documentation/KDE4/kdepim/kmail


has anyone enough karma to delete this page?


Done.


Projects/Documentation/KDE_(health_table)/kcontrol5

Projects/Documentation/KDE4_(health_table)/kcontrol

Projects/Documentation/KDE4_(health_table)/kioslaves

... and maybe more. How to find them?

These pages are somewhat outdated (kde4) and should be on  
community.kde.org,

right?

Techbase has a page Documentation_Primer/Manual version 0.03 2013-05-01  
and
we have another version 0.02 (2005-05-21) l10n.kde.org, that does not  
make

sense and should be cleaned up.

Please review the Documentation Primer  
https://svn.reviewboard.kde.org/r/7163/

and give https://svn.reviewboard.kde.org/r/7164/ a "Ship It".

Thanks


Thanks a lot for your work.

Best regards,
Yuri
___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation pages on techbase

[Yuri Chornoivan]

написане Wed, 11 May 2016 22:43:44 +0300, Burkhard Lück  
:



Am Donnerstag, 28. April 2016, 09:55:11 CEST schrieb Burkhard Lück:

Am Thursday 28 April 2016, 08:34:43 schrieb Yuri Chornoivan:
> написане Thu, 28 Apr 2016 00:08:59 +0300, Luigi Toscano
>
> :
> > Burkhard Lück ha scritto:
> >> Am Wednesday 20 April 2016, 17:01:52 schrieb Burkhard Lück:
> >>> Hi,
> >>>
> >>> we have some pages about Documentation on techbase like
> >>>
> >>> Projects/Documentation
> >>>
> >>> Projects/Documentation/KDE4

These pages need to be updated, if we want to keep them

> >>> Projects/Documentation/KDE4/kdepim/kmail

Projects/Documentation/KDE4/kdepim and all subpages have to be deleted  
-> 8

years old and just a draft

> >>> Projects/Documentation/KDE4_(health_table)
> >>>
> >>> Projects/Documentation/KDE_(health_table)/kcontrol5
> >>>
> >>> Projects/Documentation/KDE4_(health_table)/kcontrol
> >>>
> >>> Projects/Documentation/KDE4_(health_table)/kioslaves

KDE4_(health_table) pages have to be renamed (KDE4 is wrong) + moved

Projects/Documentation/Building_Blocks -> delete it, we have the
fundamentals docbooks

community has already a page about Documentation  
(https://community.kde.org/

KDE_Documentation), but that is apparently only about Documentation in
Wiki. How to handle this? The main content is > 6 years old.

> >>> ... and maybe more. How to find them?
> >>>
> >>> These pages are somewhat outdated (kde4) and should be on
> >>> community.kde.org,
> >>> right?
> >>>
> >>> Techbase has a page Documentation_Primer/Manual version 0.03
> >>> 2013-05-01 and
> >>> we have another version 0.02 (2005-05-21) l10n.kde.org, that does  
not

> >>> make sense and should be cleaned up.

Lets remove the Documentation Primer 0.02 from l10n.kde.org and  
replaced it

with a link to the latest page.

> > IRC discussion (#kde-docs):
> >
> > [22:59:40]  blueck: hi, about the pages on techbase, ping
> > ochurlaud who
> > is helping with the reorganization of wikis
> > [23:01:50]  tosky: so you agree the pages should go to
> > community?
> > [23:02:02]  blueck: most likely, yes
> > [23:03:23]  tosky: I'd like to push
> > https://git.reviewboard.kde.org/r/127758/ any comments/review?
> > [23:03:29]  blueck: the documentation primer was copied  
there to

> > edit
> > it in a easier way, iirc; claus_chr and yurchor should remember the
> > story
> > [23:04:40]  tosky: ok, I'll ask yurchor. but then we should
> > remove the
> > outdated primer from l10n.k.o
> > [23:05:12]  blueck: I don't think that the wiki version was
> > really
> > updated, and I have a dejavu about this discussion :)
> > [23:06:25]  tosky:  lets take this discussion to the  
mailinglist

> > yurchor can explain
> > [23:08:13]  sure
> > [23:08:20]  can I copy this discussion?
> > [23:08:40]  tosky: yes please
>
> Hi,
>
> I have not answered in this discussion because the reason to move the
> pages to community is unclear for me.

https://kate-editor.org/2010/07/26/the-mission-of-kdes-wikis/


How do we proceed here?


Anyhow. I can move the pages if needed or we can leave the pages where  
they are. It does not change anything now.

___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation pages on techbase

[Burkhard Lück]

Am Donnerstag, 28. April 2016, 09:55:11 CEST schrieb Burkhard Lück:
> Am Thursday 28 April 2016, 08:34:43 schrieb Yuri Chornoivan:
> > написане Thu, 28 Apr 2016 00:08:59 +0300, Luigi Toscano
> > 
> > :
> > > Burkhard Lück ha scritto:
> > >> Am Wednesday 20 April 2016, 17:01:52 schrieb Burkhard Lück:
> > >>> Hi,
> > >>> 
> > >>> we have some pages about Documentation on techbase like
> > >>> 
> > >>> Projects/Documentation
> > >>> 
> > >>> Projects/Documentation/KDE4
> 
> These pages need to be updated, if we want to keep them
> 
> > >>> Projects/Documentation/KDE4/kdepim/kmail
> 
> Projects/Documentation/KDE4/kdepim and all subpages have to be deleted -> 8
> years old and just a draft
> 
> > >>> Projects/Documentation/KDE4_(health_table)
> > >>> 
> > >>> Projects/Documentation/KDE_(health_table)/kcontrol5
> > >>> 
> > >>> Projects/Documentation/KDE4_(health_table)/kcontrol
> > >>> 
> > >>> Projects/Documentation/KDE4_(health_table)/kioslaves
> 
> KDE4_(health_table) pages have to be renamed (KDE4 is wrong) + moved
> 
> Projects/Documentation/Building_Blocks -> delete it, we have the
> fundamentals docbooks
> 
> community has already a page about Documentation (https://community.kde.org/
> KDE_Documentation), but that is apparently only about Documentation in
> Wiki. How to handle this? The main content is > 6 years old.
> 
> > >>> ... and maybe more. How to find them?
> > >>> 
> > >>> These pages are somewhat outdated (kde4) and should be on
> > >>> community.kde.org,
> > >>> right?
> > >>> 
> > >>> Techbase has a page Documentation_Primer/Manual version 0.03
> > >>> 2013-05-01 and
> > >>> we have another version 0.02 (2005-05-21) l10n.kde.org, that does not
> > >>> make sense and should be cleaned up.
> 
> Lets remove the Documentation Primer 0.02 from l10n.kde.org and replaced it
> with a link to the latest page.
> 
> > > IRC discussion (#kde-docs):
> > > 
> > > [22:59:40]  blueck: hi, about the pages on techbase, ping
> > > ochurlaud who
> > > is helping with the reorganization of wikis
> > > [23:01:50]  tosky: so you agree the pages should go to
> > > community?
> > > [23:02:02]  blueck: most likely, yes
> > > [23:03:23]  tosky: I'd like to push
> > > https://git.reviewboard.kde.org/r/127758/ any comments/review?
> > > [23:03:29]  blueck: the documentation primer was copied there to
> > > edit
> > > it in a easier way, iirc; claus_chr and yurchor should remember the
> > > story
> > > [23:04:40]  tosky: ok, I'll ask yurchor. but then we should
> > > remove the
> > > outdated primer from l10n.k.o
> > > [23:05:12]  blueck: I don't think that the wiki version was
> > > really
> > > updated, and I have a dejavu about this discussion :)
> > > [23:06:25]  tosky:  lets take this discussion to the mailinglist
> > > yurchor can explain
> > > [23:08:13]  sure
> > > [23:08:20]  can I copy this discussion?
> > > [23:08:40]  tosky: yes please
> > 
> > Hi,
> > 
> > I have not answered in this discussion because the reason to move the
> > pages to community is unclear for me.
> 
> https://kate-editor.org/2010/07/26/the-mission-of-kdes-wikis/

How do we proceed here?

-- 
Burkhard Lück

___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation pages on techbase

[Burkhard Lück]

Am Thursday 28 April 2016, 08:34:43 schrieb Yuri Chornoivan:
> написане Thu, 28 Apr 2016 00:08:59 +0300, Luigi Toscano
> 
> :
> > Burkhard Lück ha scritto:
> >> Am Wednesday 20 April 2016, 17:01:52 schrieb Burkhard Lück:
> >>> Hi,
> >>> 
> >>> we have some pages about Documentation on techbase like
> >>> 
> >>> Projects/Documentation
> >>> 
> >>> Projects/Documentation/KDE4
> >>> 
These pages need to be updated, if we want to keep them

> >>> Projects/Documentation/KDE4/kdepim/kmail
> >>> 
Projects/Documentation/KDE4/kdepim and all subpages have to be deleted -> 8 
years old and just a draft

> >>> Projects/Documentation/KDE4_(health_table)
> >>> 
> >>> Projects/Documentation/KDE_(health_table)/kcontrol5
> >>> 
> >>> Projects/Documentation/KDE4_(health_table)/kcontrol
> >>> 
> >>> Projects/Documentation/KDE4_(health_table)/kioslaves
> >>> 
KDE4_(health_table) pages have to be renamed (KDE4 is wrong) + moved

Projects/Documentation/Building_Blocks -> delete it, we have the fundamentals 
docbooks

community has already a page about Documentation (https://community.kde.org/
KDE_Documentation), but that is apparently only about Documentation in Wiki.
How to handle this? The main content is > 6 years old.

> >>> ... and maybe more. How to find them?
> >>> 
> >>> These pages are somewhat outdated (kde4) and should be on
> >>> community.kde.org,
> >>> right?
> >>> 
> >>> Techbase has a page Documentation_Primer/Manual version 0.03
> >>> 2013-05-01 and
> >>> we have another version 0.02 (2005-05-21) l10n.kde.org, that does not
> >>> make sense and should be cleaned up.
> >> 
Lets remove the Documentation Primer 0.02 from l10n.kde.org and replaced it 
with a link to the latest page.

> > 
> > IRC discussion (#kde-docs):
> > 
> > [22:59:40]  blueck: hi, about the pages on techbase, ping
> > ochurlaud who
> > is helping with the reorganization of wikis
> > [23:01:50]  tosky: so you agree the pages should go to community?
> > [23:02:02]  blueck: most likely, yes
> > [23:03:23]  tosky: I'd like to push
> > https://git.reviewboard.kde.org/r/127758/ any comments/review?
> > [23:03:29]  blueck: the documentation primer was copied there to
> > edit
> > it in a easier way, iirc; claus_chr and yurchor should remember the story
> > [23:04:40]  tosky: ok, I'll ask yurchor. but then we should
> > remove the
> > outdated primer from l10n.k.o
> > [23:05:12]  blueck: I don't think that the wiki version was really
> > updated, and I have a dejavu about this discussion :)
> > [23:06:25]  tosky:  lets take this discussion to the mailinglist
> > yurchor can explain
> > [23:08:13]  sure
> > [23:08:20]  can I copy this discussion?
> > [23:08:40]  tosky: yes please
> 
> Hi,
> 
> I have not answered in this discussion because the reason to move the
> pages to community is unclear for me. 

https://kate-editor.org/2010/07/26/the-mission-of-kdes-wikis/

-- 
Burkhard Lück

___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation pages on techbase

[Yuri Chornoivan]

написане Thu, 28 Apr 2016 00:08:59 +0300, Luigi Toscano  
:



Burkhard Lück ha scritto:

Am Wednesday 20 April 2016, 17:01:52 schrieb Burkhard Lück:

Hi,

we have some pages about Documentation on techbase like

Projects/Documentation

Projects/Documentation/KDE4

Projects/Documentation/KDE4_(health_table)

Projects/Documentation/KDE4/kdepim/kmail

Projects/Documentation/KDE_(health_table)/kcontrol5

Projects/Documentation/KDE4_(health_table)/kcontrol

Projects/Documentation/KDE4_(health_table)/kioslaves

... and maybe more. How to find them?

These pages are somewhat outdated (kde4) and should be on  
community.kde.org,

right?

Techbase has a page Documentation_Primer/Manual version 0.03  
2013-05-01 and
we have another version 0.02 (2005-05-21) l10n.kde.org, that does not  
make

sense and should be cleaned up.


Ping?



IRC discussion (#kde-docs):

[22:59:40]  blueck: hi, about the pages on techbase, ping  
ochurlaud who

is helping with the reorganization of wikis
[23:01:50]  tosky: so you agree the pages should go to community?
[23:02:02]  blueck: most likely, yes
[23:03:23]  tosky: I'd like to push
https://git.reviewboard.kde.org/r/127758/ any comments/review?
[23:03:29]  blueck: the documentation primer was copied there to  
edit

it in a easier way, iirc; claus_chr and yurchor should remember the story
[23:04:40]  tosky: ok, I'll ask yurchor. but then we should  
remove the

outdated primer from l10n.k.o
[23:05:12]  blueck: I don't think that the wiki version was really
updated, and I have a dejavu about this discussion :)
[23:06:25]  tosky:  lets take this discussion to the mailinglist
yurchor can explain
[23:08:13]  sure
[23:08:20]  can I copy this discussion?
[23:08:40]  tosky: yes please


Hi,

I have not answered in this discussion because the reason to move the  
pages to community is unclear for me. Olivier has already deleted all our  
pages at once for this reason and I have to restore them. I cannot  
understand what the migration to community gives us apart from new  
troubles.


The version of primer in wiki is more up-to-date than the one from l10n.  
But yes, no updates for a long time. It's a common thing for all our  
wikis. Hawthorne effect after all. As it was said it does not matter where  
users will not update the documentation. ;)


https://en.wikipedia.org/wiki/Hawthorne_effect

Best regards,
Yuri
___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation pages on techbase

[Luigi Toscano]

Burkhard Lück ha scritto:
> Am Wednesday 20 April 2016, 17:01:52 schrieb Burkhard Lück:
>> Hi,
>>
>> we have some pages about Documentation on techbase like
>>
>> Projects/Documentation
>>
>> Projects/Documentation/KDE4
>>
>> Projects/Documentation/KDE4_(health_table)
>>
>> Projects/Documentation/KDE4/kdepim/kmail
>>
>> Projects/Documentation/KDE_(health_table)/kcontrol5
>>
>> Projects/Documentation/KDE4_(health_table)/kcontrol
>>
>> Projects/Documentation/KDE4_(health_table)/kioslaves
>>
>> ... and maybe more. How to find them?
>>
>> These pages are somewhat outdated (kde4) and should be on community.kde.org,
>> right?
>>
>> Techbase has a page Documentation_Primer/Manual version 0.03 2013-05-01 and
>> we have another version 0.02 (2005-05-21) l10n.kde.org, that does not make
>> sense and should be cleaned up.
>>
> Ping?
> 

IRC discussion (#kde-docs):

[22:59:40]  blueck: hi, about the pages on techbase, ping ochurlaud who
is helping with the reorganization of wikis
[23:01:50]  tosky: so you agree the pages should go to community?
[23:02:02]  blueck: most likely, yes
[23:03:23]  tosky: I'd like to push
https://git.reviewboard.kde.org/r/127758/ any comments/review?
[23:03:29]  blueck: the documentation primer was copied there to edit
it in a easier way, iirc; claus_chr and yurchor should remember the story
[23:04:40]  tosky: ok, I'll ask yurchor. but then we should remove the
outdated primer from l10n.k.o
[23:05:12]  blueck: I don't think that the wiki version was really
updated, and I have a dejavu about this discussion :)
[23:06:25]  tosky:  lets take this discussion to the mailinglist
yurchor can explain
[23:08:13]  sure
[23:08:20]  can I copy this discussion?
[23:08:40]  tosky: yes please

-- 
Luigi
___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation pages on techbase

[Burkhard Lück]

Am Wednesday 20 April 2016, 17:01:52 schrieb Burkhard Lück:
> Hi,
> 
> we have some pages about Documentation on techbase like
> 
> Projects/Documentation
> 
> Projects/Documentation/KDE4
> 
> Projects/Documentation/KDE4_(health_table)
> 
> Projects/Documentation/KDE4/kdepim/kmail
> 
> Projects/Documentation/KDE_(health_table)/kcontrol5
> 
> Projects/Documentation/KDE4_(health_table)/kcontrol
> 
> Projects/Documentation/KDE4_(health_table)/kioslaves
> 
> ... and maybe more. How to find them?
> 
> These pages are somewhat outdated (kde4) and should be on community.kde.org,
> right?
> 
> Techbase has a page Documentation_Primer/Manual version 0.03 2013-05-01 and
> we have another version 0.02 (2005-05-21) l10n.kde.org, that does not make
> sense and should be cleaned up.
> 
Ping?

-- 
Burkhard Lück

___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

[kde-doc-english] Documentation pages on techbase

[Burkhard Lück]

Hi,

we have some pages about Documentation on techbase like

Projects/Documentation

Projects/Documentation/KDE4

Projects/Documentation/KDE4_(health_table)

Projects/Documentation/KDE4/kdepim/kmail

Projects/Documentation/KDE_(health_table)/kcontrol5

Projects/Documentation/KDE4_(health_table)/kcontrol

Projects/Documentation/KDE4_(health_table)/kioslaves

... and maybe more. How to find them?

These pages are somewhat outdated (kde4) and should be on community.kde.org, 
right?

Techbase has a page Documentation_Primer/Manual version 0.03 2013-05-01 and we 
have another version 0.02 (2005-05-21) l10n.kde.org, that does not make sense 
and should be cleaned up.

Thanks.

-- 
Burkhard Lück

___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

[kde-doc-english] Documentation of lintv in KDE4 trunk playground-multimedia

[Freek de Kruijf]

A remark from one of the Dutch translators was that KDE4 trunk playground-
multimedia messages still contains information for lintv. However there used 
to be also documentation till about 2014. I also found index.docbook for lintv 
on 
https://websvn.kde.org/trunk/playground/multimedia/lintv/lintv/doc/index.docbook?view=markup

The last change was in 2009. Is that the reason it has been removed from 
documentation?

-- 
fr.gr.

Freek de Kruijf

___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation of lintv in KDE4 trunk playground-multimedia

[Luigi Toscano]

Freek de Kruijf ha scritto:
> A remark from one of the Dutch translators was that KDE4 trunk playground-
> multimedia messages still contains information for lintv. However there used 
> to be also documentation till about 2014. I also found index.docbook for 
> lintv 
> on 
> https://websvn.kde.org/trunk/playground/multimedia/lintv/lintv/doc/index.docbook?view=markup
> 
> The last change was in 2009. Is that the reason it has been removed from 
> documentation?

I think that the documentation for lintv was never made available for
translations.

Ciao
-- 
Luigi

___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation of labplot2

[Yuri Chornoivan]

15 грудня 2015, 12:16:18, від "Freek de Kruijf" :
 
>   The Dutch translator of labplot2 told me he is unable to translate the 
> English 
> documentation. It looks like the documentation is written by a non-native 
> English speaking person. Maybe a native English speaking person can go 
> through 
> the documentation and make it more legible.

Hi,

I have tried to fix the last round changes (very buggy to be honest), but the 
meaning of the text  seemed to be quite clear.

Can we work together to fix the rest of the text? There are not much native 
speakers at hand now... :'(

Best regards,
Yuri
 
 
___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation of labplot2

[Jack]

On 2015.12.15 11:26, Yuri Chornoivan wrote:
15 грудня 2015, 12:16:18, від "Freek de Kruijf"  
:


>   The Dutch translator of labplot2 told me he is unable to  
translate the English
> documentation. It looks like the documentation is written by a  
non-native
> English speaking person. Maybe a native English speaking person can  
go through

> the documentation and make it more legible.

Hi,

I have tried to fix the last round changes (very buggy to be honest),  
but the meaning of the text  seemed to be quite clear.


Can we work together to fix the rest of the text? There are not much  
native speakers at hand now... :'(


Best regards,


I'd be interested in helping with this, but I don't think I'll  
realistically have time until January.  However, if there are specific  
paragraphs or possibly pages that need attention, I can probably manage  
that.


Jack
___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

[kde-doc-english] Documentation of labplot2

[Freek de Kruijf]

The Dutch translator of labplot2 told me he is unable to translate the English 
documentation. It looks like the documentation is written by a non-native 
English speaking person. Maybe a native English speaking person can go through 
the documentation and make it more legible.

-- 
fr.gr.

Freek de Kruijf

___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

[kde-doc-english] Documentation

[David Hall]

Although I've been working with computers for 30 years I've found your 
description of how to use KWallet and KWallet Manager very confusing.

You ramble though without mentioning important details.  

The KWallet Handbook - Introduction - Create a Wallet

what exactly is a wallet

Use the menu item 'File-> 'New Wallet'  

what menu?? where?  In this window there is a File item in the menu with just 
'Print' and 'Quit'

Use the 'New' button.

what new button where???

On the first attempt to store login information in a wallet when you did not 
create a wallet so far, ..

have someone correct your English =

If you have not created a wallet yet, then ..

Blowfish encryption

 KWallet saves this sensitive data for you in a strongly encrypted file.

 (finally a definition of what has been up to now a vague concept)

farther down

Launch KWallet Manager - how do I do that?

and select your old wallet - old wallet, new wallet, 
  I have no wallets at all at this point
  

It's all quite frustrating.

D. Hall
rapidr...@yahoo.de





 


___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

Re: [kde-doc-english] Documentation (was Re: Plasma Applet for Audio Volume for kdereview)

[Sebastian Kügler]

On Wednesday, August 12, 2015 12:20:29 Luigi Toscano wrote:
 On Wednesday 12 of August 2015 10:05:34 Sebastian Kügler wrote:
  Also, the Evolve survey was pretty clear that we utterly suck in the
  documentation arena. Playing with words doesn't solve that, writing
  documentation and maintaining it does.
  
 
  We may change the rules, and that's perhaps what we should do, but that
  doesn't begin with let's ship a new module without docbook, that should
  begin with a cunning plan to move to online docs, the wiki, etc. and
  integrate that into the help function of applications. Right now the help
  button is a sort-of catch22, docs are usually useless, so I don't see the
  necessity to write them, so they're more useless (or not present).
 
 I've seen many review requests from Burkhard to review tons of
 documentation.  He is doing a big work on many modules (few applications
 receives some hel p from the maintainers).

I know, I reviewed many of them.

 Thanks to maintainers who checked and approved the reviews, but I didn't
 see  any request for changing them or updating them before this effort,
 regardless of the format (reading the generated documentation is possible
 without dealing with DocBook).

To be clear, I didn't mean to diminish Burkhard's work, the opposite is true. 
Documentation is important, and people who care about it are doing important 
work. Simple as that. That's why I sat down and wrote the plasma-pa doc, 
instead of lamenting whether it's really needed.

 If you think that the documentation is useless, please report it, just for
 any  bug. I don't see why it can't be improved, again regardless of the
 format. Even without thinking about future formats, a simple document in
 any format with the updates is always more than welcome.
 
 About the format, personally speaking, a system which relies only on online 
 docs is not going to work, both ways should be possible (offline and
 online).

Yes and no, but it's offtopic here, so let's not get into this.

  Anyway, discussion in this thread is moot, since I've committed a docbook
  which is hopefully helpful for those who know to find it.
 
 So let's change the thread.

Indeed.
-- 
sebas

http://www.kde.org | http://vizZzion.org | GPG Key ID: 9119 0EF9

___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

[kde-doc-english] Documentation (was Re: Plasma Applet for Audio Volume for kdereview)

[Luigi Toscano]

On Wednesday 12 of August 2015 10:05:34 Sebastian Kügler wrote:
 Also, the Evolve survey was pretty clear that we utterly suck in the
 documentation arena. Playing with words doesn't solve that, writing
 documentation and maintaining it does.
 
 We may change the rules, and that's perhaps what we should do, but that
 doesn't begin with let's ship a new module without docbook, that should
 begin with a cunning plan to move to online docs, the wiki, etc. and
 integrate that into the help function of applications. Right now the help
 button is a sort-of catch22, docs are usually useless, so I don't see the
 necessity to write them, so they're more useless (or not present).

I've seen many review requests from Burkhard to review tons of documentation. 
He is doing a big work on many modules (few applications receives some hel p 
from the maintainers).
Thanks to maintainers who checked and approved the reviews, but I didn't see 
any request for changing them or updating them before this effort, regardless 
of the format (reading the generated documentation is possible without dealing 
with DocBook).

If you think that the documentation is useless, please report it, just for any 
bug. I don't see why it can't be improved, again regardless of the format. 
Even without thinking about future formats, a simple document in any format 
with the updates is always more than welcome.

About the format, personally speaking, a system which relies only on online 
docs is not going to work, both ways should be possible (offline and online).

 
 Anyway, discussion in this thread is moot, since I've committed a docbook
 which is hopefully helpful for those who know to find it.
So let's change the thread.

Ciao
-- 
Luigi
___
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

[kde-doc-english] Documentation tasks in Google Code-In / Season of KDE

[Yuri Chornoivan]

 Sat, 18 Oct 2014 23:46:12 +0300, Burkhard L?ck  
lueck at hube-lueck.de:

 Hi,

 should we (doc team) participate in:

 Google Code-in
 https://developers.google.com/open-source/gci/

 Season of KDE
 https://community.kde.org/SoK/Ideas/2014

 Some ideas:

 * i18n for the main page of d.k.o, make it translatable

 * new screenshots for docbooks in kf5

 * add kf5 docbooks into development section of d.k.o

 * replace repo based names in the tree on d.k.o with better user centric  
 names

 * add an action to khelpcenter to download the pdf from d.k.o

 * add an action to khelpcenter to open a requested, but locally not  
 installed
 handbook (Documentation not found page displayed), on d.k.o

 * add a search functionality to khelpcenter

 I have no experience as mentor for such programs, therefore I do not  
 know if
 these tasks are too simple or too difficult or my ideas are simply  
 nonsense or
 ...

 Comments and/or additional ideas for tasks please.

 Thanks.


Hi,

Some thoughts (as a mentor of some previous contests):

1. I'd better avoid screenshoting tasks as they need very low skills.

2. Participants usually have very good command in programming, so it is  
feasible for them to complete even some difficult tasks.

3. Each task needs concentration and some deep knowledge from mentors. So  
it is vital to know what the solution should look like from the beginning  
and have at least several free days to be available in IRC.

4. The list of ideas is good, but I have no idea how to test the results  
or how to explain the students what should be done to test them.

5. It would be good to have Baloo backend to search for the docs  
(*.cache.bz2 or something like this), but I do not know if it is hard/easy  
to do.

6. Google is not very generous. I do not think that many students want to  
work for some hours to obtain $2 for the results.

Best regards,
Yuri

[kde-doc-english] Documentation tasks in Google Code-In / Season of KDE

[Luigi Toscano]

Burkhard L?ck ha scritto:
 Hi,
 
 should we (doc team) participate in:
 
 Google Code-in
 https://developers.google.com/open-source/gci/
 
 Season of KDE
 https://community.kde.org/SoK/Ideas/2014


I think Season of KDE is closer to GSoC in term of involvement (less rewarding
from a monetary point of view, of course. Google Code-in, if it wasn't change
compared to last years, requires a lot of small tasks, the target are
high-school students (please note I wasn't involved, I just checked from 
outside)

Most of the points down seems more on SoK than GCI __IMHO__, and for the SoK
ones some can be probably combined:

 * i18n for the main page of d.k.o, make it translatable
Coding, SoK, not sure how small is for GCI

 
 * new screenshots for docbooks in kf5
GCI

 
 * add kf5 docbooks into development section of d.k.o
SoK, (I suspect the time required to explain how things work will take more
time than doing it myself)

 
 * replace repo based names in the tree on d.k.o with better user centric names
SoK

 
 * add an action to khelpcenter to download the pdf from d.k.o
Uhm, not sure. SoK for sure (with something else). Maybe GCI.


 * add an action to khelpcenter to open a requested, but locally not installed 
 handbook (Documentation not found page displayed), on d.k.o
Together with the one above, SoK. Maybe GCI.

 
 * add a search functionality to khelpcenter
SoK definitely.

 
 I have no experience as mentor for such programs, therefore I do not know if 
 these tasks are too simple or too difficult or my ideas are simply nonsense 
 or 
 ...

 Comments and/or additional ideas for tasks please.

Personal note: I can't personally help with mentoring those programs right now.

Ciao
-- 
Luigi

[kde-doc-english] Documentation tasks in Google Code-In / Season of KDE

[Valorie Zimmerman]

On Sat, Oct 18, 2014 at 1:46 PM, Burkhard L?ck lueck at hube-lueck.de wrote:
 Hi,

 should we (doc team) participate in:

 Google Code-in
 https://developers.google.com/open-source/gci/

 Season of KDE
 https://community.kde.org/SoK/Ideas/2014

 Some ideas:

 * i18n for the main page of d.k.o, make it translatable

 * new screenshots for docbooks in kf5

 * add kf5 docbooks into development section of d.k.o

 * replace repo based names in the tree on d.k.o with better user centric names

 * add an action to khelpcenter to download the pdf from d.k.o

 * add an action to khelpcenter to open a requested, but locally not installed
 handbook (Documentation not found page displayed), on d.k.o

 * add a search functionality to khelpcenter

 I have no experience as mentor for such programs, therefore I do not know if
 these tasks are too simple or too difficult or my ideas are simply nonsense or
 ...

 Comments and/or additional ideas for tasks please.

 Thanks.

 --
 Burkhard L?ck

First, let me just say that it makes me really happy to see this post!

Second, keep in mind that although they'll be running in close to the
same time-frame, they contrast a *lot*.

Season of KDE (SoK) lasts 3 months, and is for students and others (no
age limits, and no schooling requirement), and thus should be one
larger project. Mentors for SoK should be prepared to be helpful for
some months, but there is little need to be immediately available.

Google Code-In is for high school students, and each task should be
small. The students must be able to complete each task in less than a
day, so perhaps something YOU would be able to do in an hour or two.
Mentors should be available daily at least, to check whether or not
one of their tasks is being claimed, to help if necessary, and check
out the student's work in a timely way. They will want to be onto the
next task quickly.

All the best,

Valorie, for the SoK  GCi admins

[kde-doc-english] Documentation of Import + Export of Mails + PIM Data

[Burkhard Lück]

Hi,

there are a lot of different ways of import/export with KMail, KMailCVT, Pim 
Setting Exporter, Import Wizard etc.

To be able to provide proper documentation for KDEPim Users this needs to be 
sorted out/clarified and explained.

As first step to get there I have collected all my infos about that topic:

 Import + Export of Mails + PIM Data

0) Export / View single mails in KMail via File-Save As / Open
Import via kmailcvt (mbox), in 4.12 via mboximporter?

Use case: Transfer single mails


1) akonadi_folderarchive_agent (needs a proper Name for GUI+Docs?)
KMail Folder-Archive Folder or Archive Folder from a folders context menu
Export of a mail folder and its subfolders to zip/tar/tar.bz2/tar.gz
Import via kmailcvt (KMail Archive)

Use case: transfer single KMail folders(+subfolders) from/to accounts or 
computers


2) kmailcvt (KMailCVT)
Standalone + in KMail via File-Import Messages
Select any location of archive / mail folder from different apps + import 
In 4.11 the only application able to import kmail archive, mbox, plain text?

Use case:
Transfer mails from different apps from any account/computer, 
e.g copy a top mail folder of another application to a USB stick and import 
that?


3) pimsettingsexporter (PIM Settings Exporter)
Standalone + in KMail via Tools-Export KMail Date - Back up Data / Restore 
Data
Import + Export of settings + data to/from zip Archiv
Resources, Mail Transport, Config, Identity, Mails, Akonadi Database (more?)

Use case: Transfer a selectable set of pim data, but only whole 
resources/transport/config/mails/akonadi data, 
no single mail folders or resources or identities or ...


4) importwizard (change name in GUI to Import Wizard?)
Standalone + in KMail via Tools-Import Wizard
Detects mail from other mailer applications in user account automatically

Use case: Import all Mails from another Mail application in the user account 
into KMail, no transfer from different account/computer


Please check this info, correct all errors, comment and/or confirm if right.

Thanks.

-- 
Burkhard L?ck

[kde-doc-english] Documentation Status and Todo's for 4.11

[Burkhard Lück]

Am Sonntag, 16. Juni 2013, 18:10:25 schrieb T.C. Hollingsworth:
 Readding the list since others hopefully will have comments...
 
 On Fri, Jun 14, 2013 at 8:03 AM, Burkhard L?ck lueck at hube-lueck.de wrote:
  Here a list of missing gui elements from the 3.5 visual dictionary -most
  of
  them covered by Claus' version on userbase:
  Button, Check Box, Color Selector, Combo Box, Context Menu, Dialog Box,
  Drop Down Box, Icon List, List Box, Progress Bar, Radio Button, Scrollbar
  or Scroll Bar?, Slider, Spin Box, Tab, Tabbed Window, Text Box
 
 I've filled in the dictionary part for all these missing items now,
 except for Tabbed Window.  I'm not aware of any use of tabs that are
 not in such a configuration, so it seemed rather redundant.
 
 I also decided to distinguish a Text Box (e.g. QLineEdit) from a Text
 Area (e.g. QTextEdit) because IMHO there are enough differences in
 appearance and behavior (e.g. what happens when you press Enter) to
 warrant distinguishing the two.
 
 Is everyone okay with these two modifications?  Is the draft [1]
 missing any other widgets?  Please also have a look at the
 descriptions and suggest any improvements, some of them came out a
 little awkward and I'm not sure exactly how best to fix.
 
 Note that the PNGs are currently missing, I'm going to go fill those
 in shortly and replace some of the existing ones as well.
 
Me just realized, that the fundamentals in work/doc and kde-runtime/doc differ, 
but the version in kde-runtime/doc seem to be more up to date.
So the changes for the dictionary part should be applied to fundamentals in 
kde-runtime/doc und work/doc needs to be cleaned up later.

-- 
Burkhard L?ck

[kde-doc-english] Documentation Status and Todo's for 4.11

[David Palser]

Hi,

I have had a check through New Oxford Dictionary for Writers and Editors
for the words in preferred_forms file. Many of the more computing
specific terms are not listed, but those that are I have put in the
attached file.

The dictionary is for UK English, not US English.

I am not suggesting KDE should follow New Oxford Dictionary, KDE can
have its own style, but whatever style is decided on should be followed
consistently.

best regards,

David


On Mon, 2013-06-17 at 22:02 +0200, Burkhard L?ck wrote:
 Am Sonntag, 16. Juni 2013, 18:10:25 schrieb T.C. Hollingsworth:
  Readding the list since others hopefully will have comments...
  
  On Fri, Jun 14, 2013 at 8:03 AM, Burkhard L?ck lueck at hube-lueck.de 
  wrote:
   Here a list of missing gui elements from the 3.5 visual dictionary -most
   of
   them covered by Claus' version on userbase:
   Button, Check Box, Color Selector, Combo Box, Context Menu, Dialog Box,
   Drop Down Box, Icon List, List Box, Progress Bar, Radio Button, Scrollbar
   or Scroll Bar?, Slider, Spin Box, Tab, Tabbed Window, Text Box
  
  I've filled in the dictionary part for all these missing items now,
  except for Tabbed Window.  I'm not aware of any use of tabs that are
  not in such a configuration, so it seemed rather redundant.
  
  I also decided to distinguish a Text Box (e.g. QLineEdit) from a Text
  Area (e.g. QTextEdit) because IMHO there are enough differences in
  appearance and behavior (e.g. what happens when you press Enter) to
  warrant distinguishing the two.
  
 Makes sense to me
 
  Is everyone okay with these two modifications?  Is the draft [1]
  missing any other widgets?  Please also have a look at the
  descriptions and suggest any improvements, some of them came out a
  little awkward and I'm not sure exactly how best to fix.
  
 Some minor issues:
 
 * Reducing the width of the window leads to many line breaks in Description 
 column of the table and make the text difficult to read. Could you make the 
 Screenshot column  narrower ?
 
 * Regarding the wording/spelling of the widgets (scrollbar vs scroll bar 
 etc.) 
 I have attached the file preferred_forms used on english.breakfast.org to 
 check 
 the docbooks and a statistic from stable (4,10) of all widget names and their 
 spelling. Of course we should sync this spelling with ebn.
 
 * Should we use the The Plasma Desktop section from  
 http://userbase.kde.org/User:Claus_chr/Visual_Dictionary ?
 
 Apart from that I am ok with your proposal.
 
 Thanks.
 
 ___
 kde-doc-english mailing list
 kde-doc-english at kde.org
 https://mail.kde.org/mailman/listinfo/kde-doc-english

-- next part --
Preferred forms from New Oxford Dictionary for Writers and Editors.



cannot - except where used as - can not only...but also...

fine-tune - as a verb

infrared

lower case

pop-up - as adjective
pop up - as verb

preset

screen saver

sidebar

spellcheck
spelling checker

to-do

toolbar

upper case

web page

[kde-doc-english] Documentation Status and Todo's for 4.11

[Burkhard Lück]

Hi David,

thanks for your input.

Your list is not very different from T.C.'s comments, will add them.

Am Donnerstag, 20. Juni 2013, 14:29:57 schrieb David Palser:
 
 I have had a check through New Oxford Dictionary for Writers and Editors
 for the words in preferred_forms file. Many of the more computing
 specific terms are not listed, but those that are I have put in the
 attached file.
 
 The dictionary is for UK English, not US English.
 
 I am not suggesting KDE should follow New Oxford Dictionary, KDE can
 have its own style, but whatever style is decided on should be followed
 consistently.
 
Agreed, consistency matters

Thanks.

-- 
Burkhard L?ck

[kde-doc-english] Documentation Status and Todo's for 4.11

[Burkhard Lück]

Am Dienstag, 18. Juni 2013, 16:27:27 schrieb T.C. Hollingsworth:
 On Mon, Jun 17, 2013 at 9:18 PM, Burkhard L?ck lueck at hube-lueck.de wrote:
  The file preferred_forms is from kde3, probably time to update its
  content?
  Attached a list of all widget names used in the visual dictionary,
  spelling in preferred_forms, aspell, dictionary + in the docbooks.
  Main differences:
  Checkbox, Menubar, Scrollbar, Titlebar.
  
  I leave it to the native speakers how to sync these differences.
  
  Probably we should add the missing words to the file preferred_forms for
  ebn: combo box, context menu, list box, progress bar, scroll bar, spin
  box.
 My 2 cents:
 
 [Cc]heck [bB]ox129preferred forms / aspell ok
 [Cc]heck[bB]ox 115visual dictionary
 
 Revert to preferred forms - consistent with combo box, seems to be
 winning ever so slightly ;-)
 
 [Cc]ombo [bB]ox 61not in preferred forms / aspell ok /
 visual dictionary
 [Cc]ombo[bB]ox  34,
 
 ok
 
 [Cc]ontext [mM]enu 241not in preferred forms / aspell ok  /
 visual dictionary
 [Cc]ontext[mM]enu5
 [pP]opup [mM]enu67preferred forms - Unify to context menu?
 [pP]opup[mM]enu  1
 
 Yes, I'm pretty sure we use context menu pretty much everywhere.
 
 [dD]ialog [bB]ox   200   not in preferred forms / aspell ok /
 visual dictionary
 [dD]ialog[bB]ox  0
 
 please add
 
 [dD]rop [dD]own [bB]ox  89   preferred forms / aspell ok / visual
 dictionary [dD]rop[dD]own [bB]ox4
 [dD]rop[dD]own[bB]ox 0
 
 ok, fix the 4 holdouts
 
 [iI]con [lL]ist  2
 [iI]con[lL]ist   0
 
 ok assuming the former is the preferred form
 
 [iI]nput [bB]ox 11preferred form text box?
 [iI]nput[bB]ox   0
 [iI]nput [fF]ield   32preferred form text box?
 [iI]nput[fF]ield 0
 
 yes, please
 
 [lL]ist [bB]ox  25not in preferred forms / aspell ok /
 visual dictionary
 [lL]ist[bB]ox   25
 
 I'd suggest we go with List Box since all the other Boxes aren't combined
 
 [mM]enu [bB]ar  59aspell ok
 [mM]enu[bB]ar  233preferred forms / visual dictionary
 
 If I were king for a day I'd go with aspell on this one.  Outside of
 computing, words never get combined like with bar like this?it's
 chocolate bar, not chocolatebar or wine bar, not winebar.  I'm
 not sure what makes computing bars such special snowflakes.
 
 But it seems the rest of the project has decided on menubar, so
 let's go with that.
 
 [pP]rogress [bB]ar  13not in preferred forms / visual dictionary
 [pP]rogress[bB]ar0
 
 please add
 
 [rR]adio [bB]utton  40not in preferred forms / aspell ok /
 visual dictionary
 [rR]adio[bB]utton9(only kommander-obsolete)
 
 please add
 
 [sS]croll [bB]ar10not in preferred forms / aspell ok
 [sS]croll[bB]ar 57visual dictionary
 
 scrollbar - for consistency with menubar and it's clearly used more
 
 [sS]pin [bB]ox  17not in preferred forms / aspell ok /
 visual dictionary
 [sS]pin[bB]ox   39
 
 Spin Box - for consistency among the boxes, though there will be a
 lot of docbooks to fix.  :-/
 
 [sS]tatus [bB]ar   126preferred forms / aspell ok / visual
 dictionary [sS]tatus[bB]ar139
 
 I guess statusbar for consistency with the other bars, though this
 spelling isn't nearly as widespread as the others...
 
 [tT]ext [bB]ox 204preferred forms / aspell ok / visual
 dictionary [tT]ext[bB]ox4
 
 ok, fix those 4
 
 [tT]itle [bB]ar 17preferred forms / aspell ok
 [tT]itle[bB]ar  49visual dictionary
 
 titlebar - consistency among bars, clear winner
 
 [tT]ool [bB]ar   6
 [tT]ool[bB]ar 1125preferred forms / aspell ok / visual
 dictionary
 
 toolbar - same
 
Ok, if nobody else steps up with comments/corrections/questions in the next 
few days I'll try to get that updated and into EBN.

One personal note regarding EBN fixes:

EBN only fixes are *EVIL* 

Please keeps in mind that a commit only with with ebn issue fixes affect some 
20-30 translation teams.
In addition a change of a single char in a docbook can break the generation of 
all language docbooks, in worst case even the build of a complete language.

If you fix EBN issues in a docbook please at least proofread the docbook 
content as well to verify there is no wrong or outdated content.

   * Should we use the The Plasma Desktop section from
   http://userbase.kde.org/User:Claus_chr/Visual_Dictionary ?
  
  IDK, Fundamentals really doesn't cover much Plasma stuff at all; we
  leave that to the Plasma Handbook.
  
  You are right, it is better suited in the Plasma Handbook, between Plasma
  Widgets and Containments and Panel?
 
 Works for me.  :-)
 
See RR http://git.reviewboard.kde.org/r/10/

Thanks.

-- 
Burkhard L?ck

[kde-doc-english] Documentation Status and Todo's for 4.11

[T.C. Hollingsworth]

On Wed, Jun 19, 2013 at 9:15 PM, Burkhard L?ck lueck at hube-lueck.de wrote:
 Me just realized, that the fundamentals in work/doc and kde-runtime/doc 
 differ,
 but the version in kde-runtime/doc seem to be more up to date.
 So the changes for the dictionary part should be applied to fundamentals in
 kde-runtime/doc und work/doc needs to be cleaned up later.

Yeah, I'll just copy and paste the dictionary part to git and throw
away the rest when it's ready.  Nothing else was changed in
branches/work/doc that I know of.

Speaking of that, I got quite a bit more done with the Visual
Dictionary but I can't commit it because SVN is down.  :-(

-T.C.

[kde-doc-english] Documentation Status and Todo's for 4.11

[Burkhard Lück]

Am Montag, 17. Juni 2013, 15:52:41 schrieb T.C. Hollingsworth:
 On Mon, Jun 17, 2013 at 1:02 PM, Burkhard L?ck lueck at hube-lueck.de wrote:
  Am Sonntag, 16. Juni 2013, 18:10:25 schrieb T.C. Hollingsworth:
  Readding the list since others hopefully will have comments...
  
  On Fri, Jun 14, 2013 at 8:03 AM, Burkhard L?ck lueck at hube-lueck.de 
wrote:
   Here a list of missing gui elements from the 3.5 visual dictionary
   -most
   of
   them covered by Claus' version on userbase:
   Button, Check Box, Color Selector, Combo Box, Context Menu, Dialog Box,
   Drop Down Box, Icon List, List Box, Progress Bar, Radio Button,
   Scrollbar
   or Scroll Bar?, Slider, Spin Box, Tab, Tabbed Window, Text Box
  
  I've filled in the dictionary part for all these missing items now,
  except for Tabbed Window.  I'm not aware of any use of tabs that are
  not in such a configuration, so it seemed rather redundant.
  
  I also decided to distinguish a Text Box (e.g. QLineEdit) from a Text
  Area (e.g. QTextEdit) because IMHO there are enough differences in
  appearance and behavior (e.g. what happens when you press Enter) to
  warrant distinguishing the two.
  
  Makes sense to me
  
  Is everyone okay with these two modifications?  Is the draft [1]
  missing any other widgets?  Please also have a look at the
  descriptions and suggest any improvements, some of them came out a
  little awkward and I'm not sure exactly how best to fix.
  
  Some minor issues:
  
  * Reducing the width of the window leads to many line breaks in
  Description
  column of the table and make the text difficult to read. Could you make
  the
  Screenshot column  narrower ?
 
 I'll try, there are a couple that could stand to be narrower.
 
  * Regarding the wording/spelling of the widgets (scrollbar vs scroll bar
  etc.) I have attached the file preferred_forms used on
  english.breakfast.org to check the docbooks and a statistic from stable
  (4,10) of all widget names and their spelling. Of course we should sync
  this spelling with ebn.
 
 Excellent, I'll fix up the few that don't match that shortly.
 
The file preferred_forms is from kde3, probably time to update its content?
Attached a list of all widget names used in the visual dictionary, spelling in 
preferred_forms, aspell, dictionary + in the docbooks.
Main differences:
Checkbox, Menubar, Scrollbar, Titlebar.

I leave it to the native speakers how to sync these differences.

Probably we should add the missing words to the file preferred_forms for ebn:
combo box, context menu, list box, progress bar, scroll bar, spin box.

  * Should we use the The Plasma Desktop section from
  http://userbase.kde.org/User:Claus_chr/Visual_Dictionary ?
 
 IDK, Fundamentals really doesn't cover much Plasma stuff at all; we
 leave that to the Plasma Handbook.  

You are right, it is better suited in the Plasma Handbook, between Plasma 
Widgets and Containments and Panel?

Thanks.

-- 
Burkhard L?ck
-- next part --
docs in stable:

[Cc]heck [bB]ox129preferred forms / aspell ok
[Cc]heck[bB]ox 115visual dictionary

[Cc]ombo [bB]ox 61not in preferred forms / aspell ok / visual 
dictionary
[Cc]ombo[bB]ox  34

[Cc]ontext [mM]enu 241not in preferred forms / aspell ok  / visual 
dictionary
[Cc]ontext[mM]enu5
[pP]opup [mM]enu67preferred forms - Unify to context menu?
[pP]opup[mM]enu  1

[dD]ialog [bB]ox   200   not in preferred forms / aspell ok / visual 
dictionary
[dD]ialog[bB]ox  0

[dD]rop [dD]own [bB]ox  89   preferred forms / aspell ok / visual dictionary
[dD]rop[dD]own [bB]ox4
[dD]rop[dD]own[bB]ox 0

[iI]con [lL]ist  2
[iI]con[lL]ist   0

[iI]nput [bB]ox 11preferred form text box?
[iI]nput[bB]ox   0
[iI]nput [fF]ield   32preferred form text box?
[iI]nput[fF]ield 0

[lL]ist [bB]ox  25not in preferred forms / aspell ok / visual 
dictionary
[lL]ist[bB]ox   25

[mM]enu [bB]ar  59aspell ok
[mM]enu[bB]ar  233preferred forms / visual dictionary

[pP]rogress [bB]ar  13not in preferred forms / visual dictionary
[pP]rogress[bB]ar0

[rR]adio [bB]utton  40not in preferred forms / aspell ok / visual 
dictionary
[rR]adio[bB]utton9(only kommander-obsolete)

[sS]croll [bB]ar10not in preferred forms / aspell ok
[sS]croll[bB]ar 57visual dictionary

[sS]pin [bB]ox  17not in preferred forms / aspell ok / visual 
dictionary
[sS]pin[bB]ox   39

[sS]tatus [bB]ar   126preferred forms / aspell ok / visual dictionary
[sS]tatus[bB]ar139

[tT]ext [bB]ox 204preferred forms / aspell ok / visual dictionary
[tT]ext[bB]ox4

[tT]itle [bB]ar 17preferred forms / aspell ok
[tT]itle[bB]ar  49visual dictionary

[tT]ool [bB]ar   6
[tT]ool[bB]ar 1125preferred forms / 

[kde-doc-english] Documentation Status and Todo's for 4.11

[Scarlett Clark]

On Tuesday, June 18, 2013 06:18:55 AM Burkhard L?ck wrote:
 Documentation Status and Todo's for 4.11

I have not yet done any work with Visual dictionary, or with the docs from 
the svn for that matter, but I was asked to look at 
http://websvn.kde.org/branches/work/doc/fundamentals/
and comment/review
So here goes nothing :)

listitempara
A link linkend=visualdict-buttonButton/link to place this window on 
all
desktiops
/para/listitem
desktiops = desktops?
entryCombo Box/entry
entryA link linkend=visualdict-drop-down-boxDrop Down Box/link
that also permits the desired selection to be typed as with a
link linkend=visualdict-text-boxtext box/link well./entry
entry
Does not quite read right.
entryCombo Box/entry
entryA link linkend=visualdict-drop-down-boxDrop Down Box/link
that also permits the desired selection to be typed in the
link linkend=visualdict-text-boxtext box/link area, and it will find 
matches as you type./entry

Scarlett

-- next part --
An HTML attachment was scrubbed...
URL: 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20130618/aa7e0de3/attachment.html

[kde-doc-english] Documentation Status and Todo's for 4.11

[T.C. Hollingsworth]

On Tue, Jun 18, 2013 at 1:53 PM, Scarlett Clark
scarlett at scarlettgatelyclark.com wrote:
 I have not yet done any work with Visual dictionary, or with the docs from
 the svn for that matter, but I was asked to look at

 http://websvn.kde.org/branches/work/doc/fundamentals/

 and comment/review

 So here goes nothing :)

Thanks for taking a look!  The Visual Dictionary is mostly brand new,
so you came in right on time.  :-)

Don't worry too much about SVN.  The KDE Sysadmins are working to
phase it out so most applications and their docbooks have moved to git
now, but unfortunately I started on the Visual Dictionary about a year
ago and it fell by the wayside, so it's still there.  :-/

 listitempara

 A link linkend=visualdict-buttonButton/link to place this window on
 all

 desktiops

 /para/listitem

 desktiops = desktops?

Fixed in r1358022:
http://websvn.kde.org/?view=revisionrevision=1358022

 entryCombo Box/entry

 entryA link linkend=visualdict-drop-down-boxDrop Down Box/link

 that also permits the desired selection to be typed as with a

 link linkend=visualdict-text-boxtext box/link well./entry

 entry

 Does not quite read right.

 entryCombo Box/entry

 entryA link linkend=visualdict-drop-down-boxDrop Down Box/link

 that also permits the desired selection to be typed in the

 link linkend=visualdict-text-boxtext box/link area, and it will find
 matches as you type./entry

I decided to completely reword this because my original wording was
actually deficient in several areas.  Completion is optional, [1] and
may work in slightly different ways (autocomplete or opening the drop
down list).  Some combo boxes also let you type stuff in that isn't in
the list (like an URL bar), and my wording made it seem like it had to
be in the list.  It also uses the word combination, which provides a
nice little hint as to where the name comes from.  ;-)

Now it reads:

entryA combination of a
link linkend=visualdict-drop-down-boxDrop Down Box/link and a
link linkend=visualdict-text-boxText Box/link.  You can select an option
from the list, or type in the text box.  Some combo boxes may automatically
complete entries for you, or open the list with a list of choices that match
what you have typed./entry

Thanks,
-T.C.

[1] 
http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKComboBox.html#ae14aa07f44ab4ef1767586afe592155c

[kde-doc-english] Documentation Status and Todo's for 4.11

[Scarlett Clark]

On Tuesday, June 18, 2013 03:36:28 PM T.C. Hollingsworth wrote:
 On Tue, Jun 18, 2013 at 1:53 PM, Scarlett Clark
 
 scarlett at scarlettgatelyclark.com wrote:
  I have not yet done any work with Visual dictionary, or with the docs from
  the svn for that matter, but I was asked to look at
  
  http://websvn.kde.org/branches/work/doc/fundamentals/
  
  and comment/review
  
  So here goes nothing :)
 
 Thanks for taking a look!  The Visual Dictionary is mostly brand new,
 so you came in right on time.  :-)
 
 Don't worry too much about SVN.  The KDE Sysadmins are working to
 phase it out so most applications and their docbooks have moved to git
 now, but unfortunately I started on the Visual Dictionary about a year
 ago and it fell by the wayside, so it's still there.  :-/
 
  listitempara
  
  A link linkend=visualdict-buttonButton/link to place this window on
  all
  
  desktiops
  
  /para/listitem
  
  desktiops = desktops?
 
 Fixed in r1358022:
 http://websvn.kde.org/?view=revisionrevision=1358022
 
  entryCombo Box/entry
  
  entryA link linkend=visualdict-drop-down-boxDrop Down Box/link
  
  that also permits the desired selection to be typed as with a
  
  link linkend=visualdict-text-boxtext box/link well./entry
  
  entry
  
  Does not quite read right.
  
  entryCombo Box/entry
  
  entryA link linkend=visualdict-drop-down-boxDrop Down Box/link
  
  that also permits the desired selection to be typed in the
  
  link linkend=visualdict-text-boxtext box/link area, and it will find
  matches as you type./entry
 
 I decided to completely reword this because my original wording was
 actually deficient in several areas.  Completion is optional, [1] and
 may work in slightly different ways (autocomplete or opening the drop
 down list).  Some combo boxes also let you type stuff in that isn't in
 the list (like an URL bar), and my wording made it seem like it had to
 be in the list.  It also uses the word combination, which provides a
 nice little hint as to where the name comes from.  ;-)
 
 Now it reads:
 
 entryA combination of a
 link linkend=visualdict-drop-down-boxDrop Down Box/link and a
 link linkend=visualdict-text-boxText Box/link.  You can select an
 option from the list, or type in the text box.  Some combo boxes may
 automatically complete entries for you, or open the list with a list of
 choices that match what you have typed./entry
 
Yes! That is much better :)

Glad I could help, even if just a little!
Scarlett

 Thanks,
 -T.C.
 
 [1]
 http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKComboBox.html#a
 e14aa07f44ab4ef1767586afe592155c
 ___
 kde-doc-english mailing list
 kde-doc-english at kde.org
 https://mail.kde.org/mailman/listinfo/kde-doc-english

[kde-doc-english] Documentation Status and Todo's for 4.11

[T.C. Hollingsworth]

On Mon, Jun 17, 2013 at 9:18 PM, Burkhard L?ck lueck at hube-lueck.de wrote:
 The file preferred_forms is from kde3, probably time to update its content?
 Attached a list of all widget names used in the visual dictionary, spelling in
 preferred_forms, aspell, dictionary + in the docbooks.
 Main differences:
 Checkbox, Menubar, Scrollbar, Titlebar.

 I leave it to the native speakers how to sync these differences.

 Probably we should add the missing words to the file preferred_forms for ebn:
 combo box, context menu, list box, progress bar, scroll bar, spin box.

My 2 cents:

[Cc]heck [bB]ox129preferred forms / aspell ok
[Cc]heck[bB]ox 115visual dictionary

Revert to preferred forms - consistent with combo box, seems to be
winning ever so slightly ;-)

[Cc]ombo [bB]ox 61not in preferred forms / aspell ok /
visual dictionary
[Cc]ombo[bB]ox  34,

ok

[Cc]ontext [mM]enu 241not in preferred forms / aspell ok  /
visual dictionary
[Cc]ontext[mM]enu5
[pP]opup [mM]enu67preferred forms - Unify to context menu?
[pP]opup[mM]enu  1

Yes, I'm pretty sure we use context menu pretty much everywhere.

[dD]ialog [bB]ox   200   not in preferred forms / aspell ok /
visual dictionary
[dD]ialog[bB]ox  0

please add

[dD]rop [dD]own [bB]ox  89   preferred forms / aspell ok / visual dictionary
[dD]rop[dD]own [bB]ox4
[dD]rop[dD]own[bB]ox 0

ok, fix the 4 holdouts

[iI]con [lL]ist  2
[iI]con[lL]ist   0

ok assuming the former is the preferred form

[iI]nput [bB]ox 11preferred form text box?
[iI]nput[bB]ox   0
[iI]nput [fF]ield   32preferred form text box?
[iI]nput[fF]ield 0

yes, please

[lL]ist [bB]ox  25not in preferred forms / aspell ok /
visual dictionary
[lL]ist[bB]ox   25

I'd suggest we go with List Box since all the other Boxes aren't combined

[mM]enu [bB]ar  59aspell ok
[mM]enu[bB]ar  233preferred forms / visual dictionary

If I were king for a day I'd go with aspell on this one.  Outside of
computing, words never get combined like with bar like this?it's
chocolate bar, not chocolatebar or wine bar, not winebar.  I'm
not sure what makes computing bars such special snowflakes.

But it seems the rest of the project has decided on menubar, so
let's go with that.

[pP]rogress [bB]ar  13not in preferred forms / visual dictionary
[pP]rogress[bB]ar0

please add

[rR]adio [bB]utton  40not in preferred forms / aspell ok /
visual dictionary
[rR]adio[bB]utton9(only kommander-obsolete)

please add

[sS]croll [bB]ar10not in preferred forms / aspell ok
[sS]croll[bB]ar 57visual dictionary

scrollbar - for consistency with menubar and it's clearly used more

[sS]pin [bB]ox  17not in preferred forms / aspell ok /
visual dictionary
[sS]pin[bB]ox   39

Spin Box - for consistency among the boxes, though there will be a
lot of docbooks to fix.  :-/

[sS]tatus [bB]ar   126preferred forms / aspell ok / visual dictionary
[sS]tatus[bB]ar139

I guess statusbar for consistency with the other bars, though this
spelling isn't nearly as widespread as the others...

[tT]ext [bB]ox 204preferred forms / aspell ok / visual dictionary
[tT]ext[bB]ox4

ok, fix those 4

[tT]itle [bB]ar 17preferred forms / aspell ok
[tT]itle[bB]ar  49visual dictionary

titlebar - consistency among bars, clear winner

[tT]ool [bB]ar   6
[tT]ool[bB]ar 1125preferred forms / aspell ok / visual dictionary

toolbar - same

  * Should we use the The Plasma Desktop section from
  http://userbase.kde.org/User:Claus_chr/Visual_Dictionary ?

 IDK, Fundamentals really doesn't cover much Plasma stuff at all; we
 leave that to the Plasma Handbook.

 You are right, it is better suited in the Plasma Handbook, between Plasma
 Widgets and Containments and Panel?

Works for me.  :-)

-T.C.

[kde-doc-english] Documentation Status and Todo's for 4.11

[Burkhard Lück]

Am Sonntag, 16. Juni 2013, 18:10:25 schrieb T.C. Hollingsworth:
 Readding the list since others hopefully will have comments...
 
 On Fri, Jun 14, 2013 at 8:03 AM, Burkhard L?ck lueck at hube-lueck.de wrote:
  Here a list of missing gui elements from the 3.5 visual dictionary -most
  of
  them covered by Claus' version on userbase:
  Button, Check Box, Color Selector, Combo Box, Context Menu, Dialog Box,
  Drop Down Box, Icon List, List Box, Progress Bar, Radio Button, Scrollbar
  or Scroll Bar?, Slider, Spin Box, Tab, Tabbed Window, Text Box
 
 I've filled in the dictionary part for all these missing items now,
 except for Tabbed Window.  I'm not aware of any use of tabs that are
 not in such a configuration, so it seemed rather redundant.
 
 I also decided to distinguish a Text Box (e.g. QLineEdit) from a Text
 Area (e.g. QTextEdit) because IMHO there are enough differences in
 appearance and behavior (e.g. what happens when you press Enter) to
 warrant distinguishing the two.
 
Makes sense to me

 Is everyone okay with these two modifications?  Is the draft [1]
 missing any other widgets?  Please also have a look at the
 descriptions and suggest any improvements, some of them came out a
 little awkward and I'm not sure exactly how best to fix.
 
Some minor issues:

* Reducing the width of the window leads to many line breaks in Description 
column of the table and make the text difficult to read. Could you make the 
Screenshot column  narrower ?

* Regarding the wording/spelling of the widgets (scrollbar vs scroll bar etc.) 
I have attached the file preferred_forms used on english.breakfast.org to check 
the docbooks and a statistic from stable (4,10) of all widget names and their 
spelling. Of course we should sync this spelling with ebn.

* Should we use the The Plasma Desktop section from  
http://userbase.kde.org/User:Claus_chr/Visual_Dictionary ?

Apart from that I am ok with your proposal.

Thanks.

-- 
Burkhard L?ck
-- next part --
# Preferred forms of words for KDE user-visible strings
# Enter as:
# Deprecated form/Preferred form[/Optional comment]
# Enter one deprecated form for each possible conjugation of the word,
# including plurals and capitalizations, since we might want to enforce a
# particular capitalization (eg, for 'Internet')
# Comments must be whole line, beginning with '#'
# TODO:
# Add 'keycap' - 'keysym' corrections
# NB: keycapPage Up/, keysymLeft/Right/Up/Down Arrow/ are correct
# key(cap|sym)Ctrl - Ctrl;

Addressbook/Address book
addressbook/address book
Addressbooks/Address books
addressbooks/address books

Anti alias/Anti-alias
anti alias/anti-alias
Anti aliases/Anti-aliases
anti aliases/anti-aliases
Anti aliasing/Anti-aliasing
anti aliasing/anti-aliasing

Antialias/Anti-alias
antialias/anti-alias
Antialiases/Anti-alias
antialiases/anti-alias
Antialiasing/Anti-aliasing
antialiasing/anti-aliasing

Can not/Cannot/Only use 'can not' for emphasis
can not/cannot/Only use 'can not' for emphasis
can't/cannot
Can't/Cannot

Checkbox/Check box
checkbox/check box
Checkboxes/Check boxes
checkboxes/check boxes

#Color Selector

Dropdown list/Drop down box
dropdown list/drop down box
Drop-down list/Drop down box
drop-down list/drop down box
Drop down list/Drop down box
drop down list/drop down box

Dropdown box/Drop down box
dropdown box/drop down box
Drop-down box/Drop down box
drop-down box/drop down box
Drop-down boxes/Drop down boxes
drop-down boxes/drop down boxes
Dropdown boxes/Drop down boxes
dropdown boxes/drop down boxes


#Dialog Box

Directories/Folders/Only use 'directory' for CLI
directories/folders/Only use 'directory' for CLI
Directory/Folder/Only use 'directory' for CLI
directory/folder/Only use 'directory' for CLI

E-mail/Email
e-mail/email
E-mails/Emails
e-mails/emails

File size/Filesize
file size/filesize
File sizes/Filesizes
file sizes/filesizes

Filesystem/File system
filesystem/file system
Filesystems/File systems
filesystems/file systems

Fine tune/Fine-tune
fine tune/fine-tune
Fine tunes/Fine-tunes
fine tunes/fine-tunes

Formula-bar/Formula bar
formula-bar/formula bar
Formula-bars/Formula bars
formula-bars/formula bars

Formulabar/Formula bar
formulabar/formula bar
Formulabars/Formula bars
formulabars/formula bars

Gray scale/Grayscale
gray scale/grayscale
Gray scales/Grayscales
gray scales/grayscales
Gray scaled/Grayscaled
gray scaled/grayscaled

Harddisk/Hard disk
harddisk/hard disk
Harddisks/Hard disks
harddisks/hard disks

Highscore/High score
highscore/high score
Highscores/High scores
highscores/high scores

Hit a key/Press a key
hit a key/press a key

hz/Hz

Infra-red/Infrared
infra-red/infrared
Infra-reds/Infrareds
infra-reds/infrareds

internet/Internet

it'll/it will
It'll/It will

khz/kHz

#List Box

lower case/lowercase
lower-case/lowercase
Lower case/Lowercase
Lower-case/Lowercase


Menu bar/Menubar
menu bar/menubar
Menu bars/Menubars
menu bars/menubars

Menu-bar/Menubar
menu-bar/menubar
Menu-bars/Menubars
menu-bars/menubars

[kde-doc-english] Documentation Status and Todo's for 4.11

[T.C. Hollingsworth]

On Mon, Jun 17, 2013 at 1:02 PM, Burkhard L?ck lueck at hube-lueck.de wrote:
 Am Sonntag, 16. Juni 2013, 18:10:25 schrieb T.C. Hollingsworth:
 Readding the list since others hopefully will have comments...

 On Fri, Jun 14, 2013 at 8:03 AM, Burkhard L?ck lueck at hube-lueck.de 
 wrote:
  Here a list of missing gui elements from the 3.5 visual dictionary -most
  of
  them covered by Claus' version on userbase:
  Button, Check Box, Color Selector, Combo Box, Context Menu, Dialog Box,
  Drop Down Box, Icon List, List Box, Progress Bar, Radio Button, Scrollbar
  or Scroll Bar?, Slider, Spin Box, Tab, Tabbed Window, Text Box

 I've filled in the dictionary part for all these missing items now,
 except for Tabbed Window.  I'm not aware of any use of tabs that are
 not in such a configuration, so it seemed rather redundant.

 I also decided to distinguish a Text Box (e.g. QLineEdit) from a Text
 Area (e.g. QTextEdit) because IMHO there are enough differences in
 appearance and behavior (e.g. what happens when you press Enter) to
 warrant distinguishing the two.

 Makes sense to me

 Is everyone okay with these two modifications?  Is the draft [1]
 missing any other widgets?  Please also have a look at the
 descriptions and suggest any improvements, some of them came out a
 little awkward and I'm not sure exactly how best to fix.

 Some minor issues:

 * Reducing the width of the window leads to many line breaks in Description
 column of the table and make the text difficult to read. Could you make the
 Screenshot column  narrower ?

I'll try, there are a couple that could stand to be narrower.

 * Regarding the wording/spelling of the widgets (scrollbar vs scroll bar etc.)
 I have attached the file preferred_forms used on english.breakfast.org to 
 check
 the docbooks and a statistic from stable (4,10) of all widget names and their
 spelling. Of course we should sync this spelling with ebn.

Excellent, I'll fix up the few that don't match that shortly.

 * Should we use the The Plasma Desktop section from
 http://userbase.kde.org/User:Claus_chr/Visual_Dictionary ?

IDK, Fundamentals really doesn't cover much Plasma stuff at all; we
leave that to the Plasma Handbook.  But we cover the window border and
such in Fundamentals already, which is also more desktop than
application, so maybe we should include it?

 Apart from that I am ok with your proposal.

 Thanks.

-T.C.

[kde-doc-english] Documentation Status and Todo's for 4.11

[T.C. Hollingsworth]

Readding the list since others hopefully will have comments...

On Fri, Jun 14, 2013 at 8:03 AM, Burkhard L?ck lueck at hube-lueck.de wrote:
 Here a list of missing gui elements from the 3.5 visual dictionary -most of
 them covered by Claus' version on userbase:
 Button, Check Box, Color Selector, Combo Box, Context Menu, Dialog Box, Drop
 Down Box, Icon List, List Box, Progress Bar, Radio Button, Scrollbar or Scroll
 Bar?, Slider, Spin Box, Tab, Tabbed Window, Text Box

I've filled in the dictionary part for all these missing items now,
except for Tabbed Window.  I'm not aware of any use of tabs that are
not in such a configuration, so it seemed rather redundant.

I also decided to distinguish a Text Box (e.g. QLineEdit) from a Text
Area (e.g. QTextEdit) because IMHO there are enough differences in
appearance and behavior (e.g. what happens when you press Enter) to
warrant distinguishing the two.

Is everyone okay with these two modifications?  Is the draft [1]
missing any other widgets?  Please also have a look at the
descriptions and suggest any improvements, some of them came out a
little awkward and I'm not sure exactly how best to fix.

Note that the PNGs are currently missing, I'm going to go fill those
in shortly and replace some of the existing ones as well.

-T.C.

[1] http://websvn.kde.org/*checkout*/branches/work/doc/fundamentals/ui.docbook

[kde-doc-english] Documentation Status and Todo's for 4.11

[T.C. Hollingsworth]

On Wed, May 22, 2013 at 2:20 PM, Burkhard L?ck lueck at hube-lueck.de wrote:
 Hi,

 in 4.11 we have 158 application documentations. So far 39 (25%) of them show
 already  4.11 in releaseinfo, whereas code master is just at 4.10.60, that's
 not not too bad ;-)
 (To be honest better than ever since 3.0)

 Documentation Freeze (except kdepim) is Monday, July 8, 2013: KDE SC 4.11, so
 we have some time for improvement of docbooks.

 On my todo list are dolphin, konqueror, kwallet, kfind so far.

 Kate + KWrite - T.C. ?

I have all the stuff moved around now, just waiting for the ok to push
to master.  Other than that, I just have to finish up the new
development section and make sure everything is up to date for 4.11.
Should be done well ahead of July.

I might also work on documenting some of the new plugins, but that's a
neverending battle.  ;-)

 David, some proofreading (much appreciated) here and there?

 Yuri, any plans?

 Do the Fundamentals need updates or improvements?
 Maybe merge breadcrumb stuff from dolphin?
 What about adding/merging the Visual Dictionary from branches/work/doc and
 http://userbase.kde.org/User:Claus_chr/Visual_Dictionary

Yeah, I kind of dropped the ball on this for a long while.  :-(  I'll
revive my efforts here soon.

 KMail/kdepim doc need a lot of love, the infos on Laurents Blog
 (http://www.aegiap.eu/kdeblog/) could be used to improve some kdepim docbooks.

 Anything else you know it needs an update, has outdated info's?

 Thanks.

-T.C.

[kde-doc-english] Documentation Status and Todo's for 4.11

[Yuri Chornoivan]

 Thu, 23 May 2013 00:20:09 +0300, Burkhard L?ck  
lueck at hube-lueck.de:

 Yuri, any plans?

KJumpingCube if Ian Wadham will not update the docs. No other big plans so  
far, just random improvements.

Best regards,
Yuri

[kde-doc-english] Documentation Status and Todo's for 4.11

[David Palser]

Hi, yes where time allows, I will continue to proofread docs. If there
is anything specific you want me to look at, just let me know.

best wishes,

David

On Wed, 2013-05-22 at 23:20 +0200, Burkhard L?ck wrote:
 Hi,
 
 in 4.11 we have 158 application documentations. So far 39 (25%) of them show 
 already  4.11 in releaseinfo, whereas code master is just at 4.10.60, 
 that's 
 not not too bad ;-)
 (To be honest better than ever since 3.0)
 
 Documentation Freeze (except kdepim) is Monday, July 8, 2013: KDE SC 4.11, so 
 we have some time for improvement of docbooks.
 
 On my todo list are dolphin, konqueror, kwallet, kfind so far.
 
 Kate + KWrite - T.C. ?
 
 David, some proofreading (much appreciated) here and there?
 
 Yuri, any plans?
 
 Do the Fundamentals need updates or improvements? 
 Maybe merge breadcrumb stuff from dolphin? 
 What about adding/merging the Visual Dictionary from branches/work/doc and 
 http://userbase.kde.org/User:Claus_chr/Visual_Dictionary 
 
 KMail/kdepim doc need a lot of love, the infos on Laurents Blog 
 (http://www.aegiap.eu/kdeblog/) could be used to improve some kdepim docbooks.
 
 Anything else you know it needs an update, has outdated info's?
 
 Thanks.
 

[kde-doc-english] documentation

[Antoni Bella Pérez]

On Friday, 14 of September de 2012 17:57:38 Josef Grosch wrote:
 None of the documentation files can be found

  Hi

  This is from another thread?

  Specify the problem.

  Toni

[kde-doc-english] documentation

[Antoni Bella Pérez]

On Friday, 14 of September de 2012 18:21:26 you wrote:
 Hi,
 
 On Fri, Sep 14, 2012 at 06:08:43PM +0200, Antoni Bella P?rez wrote:
  On Friday, 14 of September de 2012 17:57:38 Josef Grosch wrote:
   None of the documentation files can be found
   
This is from another thread?

Specify the problem.
 
 I am on the page http://www.digikam.org/drupal/docs
 
 Clicking on the link 'digiKam PDF handbook' =
 http://docs.kde.org/development/en/extragear-graphics/digikam/digikam.pdf
 results in 'The file ... could not be found.'
 
 Many messages found by Google report this problem.
 
 Best regards, Josef

  Ok! This server updates the documentation on weekends. Is there anything 
wrong.

  I send a copy to the mailing list and we will respond. 
 
  Toni

[kde-doc-english] Documentation submission for Step

[Aidan Fell]

Hi, I'd like to submit this piece of documentation I did for Step about the
example eightpendulum.step. I don't see anything for it, so this is a start.

It's also in plain text, not DocBook (I'm learning!).

Thanks,
Aidan Fell
-- next part --
An HTML attachment was scrubbed...
URL: 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20111212/f47f3b45/attachment.html
-- next part --
 eightpendulum.step
This example is a simple demonstration of the famous Newton's cradle. It is 
done in Step using sticks, discs and a box. The six balls in the middle aren't 
moving because they have been pinned.

[kde-doc-english] Documentation submission for Step

[Yuri Chornoivan]

 Mon, 12 Dec 2011 19:50:12 +0200, Aidan Fell  
jamiefell55 at gmail.com:

 Hi, I'd like to submit this piece of documentation I did for Step about  
 the
 example eightpendulum.step. I don't see anything for it, so this is a  
 start.

 It's also in plain text, not DocBook (I'm learning!).

 Thanks,
 Aidan Fell

Hi,

Thanks for your work.

KDE Documentation is in a freeze now [1]. If you want to add something to  
documentation you have to wait until 4.8 release (January 25, 2012) or ask  
kde-i18n-doc at kde.org for exception (inclusion into 4.8.0).

Best regards,
Yuri

[1] http://techbase.kde.org/Schedules/KDE4/4.8_Release_Schedule

[kde-doc-english] Documentation submission for Step

[Aidan Fell]

So if I want to submit it again, would I have to do it between
the general 4.8 release and 4.8.1 (to be used in 4.8.1)?

On 12 December 2011 18:15, Yuri Chornoivan yurchor at ukr.net wrote:

  Mon, 12 Dec 2011 19:50:12 +0200, Aidan Fell 
 jamiefell55 at gmail.com:


  Hi, I'd like to submit this piece of documentation I did for Step about
 the
 example eightpendulum.step. I don't see anything for it, so this is a
 start.

 It's also in plain text, not DocBook (I'm learning!).

 Thanks,
 Aidan Fell


 Hi,

 Thanks for your work.

 KDE Documentation is in a freeze now [1]. If you want to add something to
 documentation you have to wait until 4.8 release (January 25, 2012) or ask
 kde-i18n-doc at kde.org for exception (inclusion into 4.8.0).

 Best regards,
 Yuri

 [1] 
 http://techbase.kde.org/**Schedules/KDE4/4.8_Release_**Schedulehttp://techbase.kde.org/Schedules/KDE4/4.8_Release_Schedule

-- next part --
An HTML attachment was scrubbed...
URL: 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20111212/6e701482/attachment.html

[kde-doc-english] Documentation submission for Step

[Yuri Chornoivan]

 Mon, 12 Dec 2011 22:15:42 +0200, Burkhard L?ck  
lueck at hube-lueck.de:

 Am Montag, 12. Dezember 2011, 19:15:06 schrieben Sie:

 KDE Documentation is in a freeze now [1]. If you want to add something  
 to
 documentation you have to wait until 4.8 release (January 25, 2012) or  
 ask
 kde-i18n-doc at kde.org for exception (inclusion into 4.8.0).

 Hmm, [1] says: Monday, December 19, 2011: KDE SC 4.8 Documentation Freeze


Hmm, it seems that someone is changing rules during the game. ;) I think  
freeze change is applied for the next cycle, but...

Well, committed:

http://commits.kde.org/step/b72c1d715d3c33104060458d7afaf6aff5373691

Thanks for the correction.

Best regards,
Yuri

[kde-doc-english] documentation backport to 4.7.2

[Yuri Chornoivan]

Hi!

 Wed, 07 Sep 2011 23:15:48 +0300, Burkhard L?ck  
lueck at hube-lueck.de:

 Backported.
 Yuri, please keep an eye on these doc when translating branch and check  
 if I
 missed something (png's).

In this case there are some extra files left from old KStars documentation:

calc-precess.docbook calc-precess.png

and old Kalzium docs:

infodialog_overview.png

Should they be deleted?

The rest seems to be good. Thanks for this tremendous work.

Best regards,
Yuri

[kde-doc-english] documentation backport to 4.7.2

[Burkhard Lück]

Am Donnerstag, 8. September 2011, 19:55:31 schrieb Yuri Chornoivan:
  Wed, 07 Sep 2011 23:15:48 +0300, Burkhard L?ck  
 
 lueck at hube-lueck.de:
  Backported.
  Yuri, please keep an eye on these doc when translating branch and check  
  if I
  missed something (png's).
 
 In this case there are some extra files left from old KStars documentation:
 
 calc-precess.docbook calc-precess.png
 
 and old Kalzium docs:
 
 infodialog_overview.png

Oh, sorry.

Removed them with all language docmessage.po's.

stable/l10kde4 is clean now , thanks for the hint.

-- 
Burkhard L?ck

[kde-doc-english] documentation backport to 4.7.2

[Burkhard Lück]

Am Dienstag, 6. September 2011, 22:00:34 schrieb T.C. Hollingsworth:
 On Mon, Sep 5, 2011 at 8:27 AM, Burkhard L?ck lueck at hube-lueck.de wrote:
  Hi,
  
  looking at
  http://techbase.kde.org/Projects/Documentation/KDE4_(health_table) I
  found these documentation ready for backport to 4.7.2 the next days:
  
  Konsole, Glossary, kcmlaunch, autostart, clock, workspaceoptions, Plasma-
  Desktop, Kalzium, KBruch, KStars, KWordQuiz, GwenView, KSnapShot, KMix,
  KPPP, KMail, KNode, KOrganizer, Kate, KGPG, KWallet, KFileReplace,
  KImageMapEditor, KLinkStatus.
  
  Anything I missed here?
  
Backported.
Yuri, please keep an eye on these doc when translating branch and check if I 
missed something (png's).

  Next possible documentation backport is for 4.7.3 is in four weeks, which
  documentation needs update/rewrite most?
  Any hints?
  
  What comes to my mind:
  
  1) For the kdemain modules:
  JuK, Kopete, KAddressbook (missing), Parley (update on userbase, adapt to
  typographic guidelines and export), kcontrol: phonon, autostart,
  kcmsmserver
  
  2) For extragear/trunk:
  KIPI-plugins. kcolorchooser for trunk, solve kate/kwrite split in
  branches/work and move bach to git?
 
 I was going to commit the Kipi-Plugin stuff back to git the other day
 but Yuri made some changes in git I didn't notice and I haven't had
 time to merge them yet.
 
 Kate in branches/work/doc can go ahead and go for 4.7.2 if possible,

Not possible due to updates to 4.8 + splitting into different docbooks than in 
branch. It can never go into 4.7.

 KWrite should stay behind until I pull the chapters we don't want and
 fix all the links.  I'd commit to git right now but annoyingly I don't
 have the right SSH key on this machine.  I'll try and do that ASAP
 unless someone beats me to it.  ;-)  (But if it's already too late for
 4.7.2 don't worry about it, I'll get it in time for 4.7.3.)
 
KWrite with the changed docbook layout can never go into branch 4.7, that's 
impossible!

 Unfortunately, I'm trying to start a new semester and move
 simultaneously so I haven't been able to find time to do much of
 anything lately.  Everything should be settled within two weeks which
 should give me plenty of time to get some stuff done for 4.7.3.
 
No need to rush as it is not possible to backport kate/kwrite from 
branches/work into 4.7. 
Try to keep kate/kwrite up to date in master, that will be available via 
docs.kde.org.

  3) Updating the documentation primer and get it online, remove all links
  to old versions (l10n.kde.org?).
  
  4) The other To-Dos listed here:
  http://lists.kde.org/?l=kde-doc-englishm=131222445905684w=2
  

Thank.

-- 
Burkhard L?ck

[kde-doc-english] documentation backport to 4.7.2

[T.C. Hollingsworth]

On Mon, Sep 5, 2011 at 8:27 AM, Burkhard L?ck lueck at hube-lueck.de wrote:
 Hi,

 looking at http://techbase.kde.org/Projects/Documentation/KDE4_(health_table)
 I found these documentation ready for backport to 4.7.2 the next days:

 Konsole, Glossary, kcmlaunch, autostart, clock, workspaceoptions, Plasma-
 Desktop, Kalzium, KBruch, KStars, KWordQuiz, GwenView, KSnapShot, KMix, KPPP,
 KMail, KNode, KOrganizer, Kate, KGPG, KWallet, KFileReplace, KImageMapEditor,
 KLinkStatus.

 Anything I missed here?

 Next possible documentation backport is for 4.7.3 is in four weeks, which
 documentation needs update/rewrite most?
 Any hints?

 What comes to my mind:

 1) For the kdemain modules:
 JuK, Kopete, KAddressbook (missing), Parley (update on userbase, adapt to
 typographic guidelines and export), kcontrol: phonon, autostart, kcmsmserver

 2) For extragear/trunk:
 KIPI-plugins. kcolorchooser for trunk, solve kate/kwrite split in
 branches/work and move bach to git?

I was going to commit the Kipi-Plugin stuff back to git the other day
but Yuri made some changes in git I didn't notice and I haven't had
time to merge them yet.

Kate in branches/work/doc can go ahead and go for 4.7.2 if possible,
KWrite should stay behind until I pull the chapters we don't want and
fix all the links.  I'd commit to git right now but annoyingly I don't
have the right SSH key on this machine.  I'll try and do that ASAP
unless someone beats me to it.  ;-)  (But if it's already too late for
4.7.2 don't worry about it, I'll get it in time for 4.7.3.)

Unfortunately, I'm trying to start a new semester and move
simultaneously so I haven't been able to find time to do much of
anything lately.  Everything should be settled within two weeks which
should give me plenty of time to get some stuff done for 4.7.3.

 3) Updating the documentation primer and get it online, remove all links to
 old versions (l10n.kde.org?).

 4) The other To-Dos listed here:
 http://lists.kde.org/?l=kde-doc-englishm=131222445905684w=2

 Thanks.

 --
 Burkhard L?ck

-T.C.

[kde-doc-english] documentation backport to 4.7.2

[Burkhard Lück]

Hi,

looking at http://techbase.kde.org/Projects/Documentation/KDE4_(health_table) 
I found these documentation ready for backport to 4.7.2 the next days:

Konsole, Glossary, kcmlaunch, autostart, clock, workspaceoptions, Plasma-
Desktop, Kalzium, KBruch, KStars, KWordQuiz, GwenView, KSnapShot, KMix, KPPP, 
KMail, KNode, KOrganizer, Kate, KGPG, KWallet, KFileReplace, KImageMapEditor, 
KLinkStatus.

Anything I missed here?

Next possible documentation backport is for 4.7.3 is in four weeks, which 
documentation needs update/rewrite most?
Any hints?

What comes to my mind:

1) For the kdemain modules:
JuK, Kopete, KAddressbook (missing), Parley (update on userbase, adapt to 
typographic guidelines and export), kcontrol: phonon, autostart, kcmsmserver

2) For extragear/trunk:
KIPI-plugins. kcolorchooser for trunk, solve kate/kwrite split in 
branches/work and move bach to git?

3) Updating the documentation primer and get it online, remove all links to 
old versions (l10n.kde.org?).

4) The other To-Dos listed here:
http://lists.kde.org/?l=kde-doc-englishm=131222445905684w=2

Thanks.

-- 
Burkhard L?ck

[kde-doc-english] Documentation System

[Burkhard Lück]

Am Donnerstag, 1. September 2011, 23:00:55 schrieb Jonathan Ryshpan:
 Are pages supposed to be folded so that complete lines can be read?  If
 so they aren't; about half of each line in the attached image is off
 screen.  Is there any way to make the help system fold pages?
 
Your screenshot shows a kde system 3.5.9 or early kde 4.x release apparently 
modified by a distribution (kde afaik never had a top level item Help in 
khelpcenters navigation tree).
I can read all lines in khelpcenter with = 10 kde versions (either compiled 
from sources or in VM's with Kubuntu/SuSe) from 3.5.9 up to master, so I guess 
you have a system broken by your distribution (which one, which kde version?).
 
 Also, why is claws the default mailer for the help center?  I have
 evolution set as the default mail handler in
 
 System Settings-Default Applications-Email Client.
 
Not enough info (distribution, KDE version) to give any help :-(

Please press Alt+F2, enter 'gg:esr smart questions' and read the first hit ...

Thanks.

-- 
Burkhard L?ck

[kde-doc-english] Documentation System

[Burkhard Lück]

Am Freitag, 2. September 2011, 01:03:03 schrieb Jonathan Ryshpan:

 My system runs Fedora-15: System IDs are:
 
 Distribution: Fedora-15 all upgrades installes
 Kernel: 2.6.40.3-0.fc15.x86_64
 KDE: kdebase-4.6.5-1.fc15.x86_64
 KDE Help: (part of) kdebase-runtime-libs-4.6.5-1.fc15.x86_64
 Claws: claws-mail-3.7.9-5.fc15.x86_64
 
 Sorry about that.
 
   Also, why is claws the default mailer for the help center?  I have
   evolution set as the default mail handler in
   
   System Settings-Default Applications-Email Client.
  
Fedora 15 KDE 4.6.5 in a VM:
Khelpcenter text is properly wrapped, but the fix for this bug 
(http://bugs.kde.org/show_bug.cgi?id=271331) is missin, so I have no 
Previous/Next button on the pages

System Settings-Default Applications-Email Client: Setting Konsole as the 
default mail handler works in my VM.

-- 
Burkhard L?ck

[kde-doc-english] Documentation System

[Jonathan Ryshpan]

On Fri, 2011-09-02 at 16:48 +0200, Burkhard L?ck wrote:

 Am Freitag, 2. September 2011, 01:03:03 schrieb Jonathan Ryshpan:
 
  My system runs Fedora-15: System IDs are:
  
  Distribution: Fedora-15 all upgrades installes
  Kernel: 2.6.40.3-0.fc15.x86_64
  KDE: kdebase-4.6.5-1.fc15.x86_64
  KDE Help: (part of) kdebase-runtime-libs-4.6.5-1.fc15.x86_64
  Claws: claws-mail-3.7.9-5.fc15.x86_64
  
  Sorry about that.
  
Also, why is claws the default mailer for the help center?  I have
evolution set as the default mail handler in

System Settings-Default Applications-Email Client.
   
 Fedora 15 KDE 4.6.5 in a VM:
 Khelpcenter text is properly wrapped, but the fix for this bug 
 (http://bugs.kde.org/show_bug.cgi?id=271331) is missin, so I have no 
 Previous/Next button on the pages
 
 System Settings-Default Applications-Email Client: Setting Konsole as the 
 default mail handler works in my VM.

Thanks again for your very quick reply.  On my own system the problem is
exactly the opposite of what you report: Khelpcenter does have
Previous/Next
buttons, but it does not wrap text.  

Just to verify the version, here is what

Help-About KDE Help Center

reports on my system:

KDE Help Center
Version 4.6.5 (4.6.5)
Using KDE Development Platform 4.6.5 (4.6.5)

All very mysterious.

jon

-- next part --
An HTML attachment was scrubbed...
URL: 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20110902/3b0f21e7/attachment.html

[kde-doc-english] Documentation System

[Jonathan Ryshpan]

Are pages supposed to be folded so that complete lines can be read?  If
so they aren't; about half of each line in the attached image is off
screen.  Is there any way to make the help system fold pages?

Also, why is claws the default mailer for the help center?  I have
evolution set as the default mail handler in 

System Settings-Default Applications-Email Client.

Many Thanks - jon

-- next part --
An HTML attachment was scrubbed...
URL: 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20110901/36d96123/attachment-0001.html
-- next part --
A non-text attachment was scrubbed...
Name: helpCenter.jpeg
Type: image/jpeg
Size: 380687 bytes
Desc: not available
URL: 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20110901/36d96123/attachment-0001.jpeg

[kde-doc-english] Documentation not found handbook in KHelpcenter - terminology

[Anne Wilson]

On Wednesday 22 Sep 2010 20:56:29 Jack wrote:
  1) Handbook - the application help lanched via F1/Help menu
 
 This is always clear, although I have sometimes referred to the  
 handbook as the manual.  KDE seems to use handbook specifically for  
 this, where non-KDE apps and systems might use manual.  In English, I'm  
 not sure the difference between the words is significant.

In British English, Handbook is a term rarely heard - it's considered an 
Americanism.  OTOH, clarity is needed from your PoV, and while most people 
here wouldn't say Handbook they would understand it to mean what they call 
the manual.

Anne
-- 
KDE Community Working Group
New to KDE Software? - get help from http://userbase.kde.org
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part.
Url : 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20100923/6d66830c/attachment.sig
 

[kde-doc-english] Documentation not found handbook in KHelpcenter

[Anne Wilson]

On Tuesday 21 Sep 2010 21:52:04 Burkhard L?ck wrote:
 I am too much involved in the kde documentation system, so I can't imagine
 if  this draft is really suited for Joe User.
 
 So please anybody on this list step up and comment/improved this draft:
 
 Does Joe User understand what to do?

Speaking as someone who writes for Joe User, I think this is excellent.  It 
clearly addresses the different scenarios the average user might find and the 
solutions for his problems.  I heartily support the use of this as the 'not 
found' landing page.

Anne
-- 
KDE Community Working Group
New to KDE Software? - get help from http://userbase.kde.org
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part.
Url : 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20100922/ab3ed6ba/attachment.sig
 

[kde-doc-english] Documentation not found handbook in KHelpcenter

[Burkhard Lück]

Am Dienstag, 21. September 2010, um 23:32:35 schrieb Jack:
 I would only suggest some minor change in wording, and an added
 paragraph explaining the problem before addressing the solution.
 
 One question - it would be nice if we could be consistent with use of
 the words documentation, manual, and handbook.  They seem to be used
 almost interchangeably.  This confused me a bit as a new KDE user,
 until I just got used to the terminology.  I don't know if this is
 addressed anywhere in the KDE documentation.
 
Me did not notice an inconsistency so far, but from a new KDE users PoV that 
could be really different.

An attempt for a definition of these terms from my pov:

1) Handbook - the application help lanched via F1/Help menu
2) Manual - man(ual) page
3) Help for System Setting modules, ioslaves and the like, technically usually 
a docbook article, what to use for them?
Documentation as general term for all types of help (1-3)

In bugreports often the term Help is used.

Jack, could you please give some examples for this inconsistent usage?

 One other possible reason for not finding the manual is that it got
 installed in the wrong place.  I believe this is only likely if the
 user compiled/installed the application himself - in which case he
 should know better, and should probably go to the application team and
 not the general KDE help, so I think it's OK to not address that
 problem here.
 
 On 2010.09.21 16:52, Burkhard L?ck wrote:
  Hi,
  
  until 4.4 the KHelpcenter/konqueror displayed the error message
  There is no documentation available for %1. and additionally a
  modal dialog with the error message The file or folder help://%1
  does not exist in case a documentation was not found for what ever
  reason (not installed, no documentation, bug like wrong/missing
  X-DocPath etc.)
  
  Dealing with bug reports on b.k.o I get the impression this behaviour
  is not more user friendly than a KDebug() output in a konsole, it
  does not give Joe User any hint how to get the missing documentation.
  
  In kde 4.5 the behaviour changed. If a documentation was not found, a
  docbook named documentationnotfound will be displayed. This docbook
  should explain what happened and what to do to get the requested
  information.
  
  I have quickly written a draft for this document:
  
  The requested documentation was not found on your computer.
 
 Normally, KDE looks for application manuals in a location that depends
 on how KDE was installed on your computer.  There are a number of
 possible reasons why it could not find the documentation you
 requested.  The document might not exist, or it may not have been
 installed along with the application.
 
  How to solve this issue:
  
  Search on the ulink url=http://docs.kde.org/;KDE Documentation
  site/ulink for the requested documentation. If you find the
  documentation on that site, maybe your distribution ships a separate
  package for documentation (eg; called kdepim-doc for all
  applications from the kdepim module like kmail; kontact; etc;).
  Please use the package manager of your distribution to install the
  missing documentation.
 
 Start by searching the ulink url=http://docs.kde.org/;KDE
 Documentation site/ulink for the requested documentation. If you find
 the documentation on that site, your distribution might ship a separate
 package for documentation (eg;  called kdepim-doc for all applications
 from the kdepim module, like kmail;, kontact;, etc;). Please use the
 package manager of your distribution to find and install the missing
 documentation.
 
  If you have done that, but still get this page displayed instead of
  the application handbook, you probably found a bug in the kde; help
  system. please report this on the ulink
  url=http://bugs.kde.org/;KDE Bug Tracker/ulink.
 
 If you have done that, but still get this page displayed instead of the
 application handbook, you probably found a bug in the kde; help
 system.  In this case, please report this on the ulink
 url=http://bugs.kde.org/;KDE Bug Tracker/ulink.
 
  If you find no documentation on the ulink
  url=http://docs.kde.org/;KDE Documentation site/ulink the
  application does not have an offline documentation, please report
  this on the ulink url=http://bugs.kde.org/;KDE Bug Tracker/ulink.
 
 If you do not find any documentation on the ulink
 url=http://docs.kde.org/;KDE Documentation site/ulink, the
 application may not have offline documentation.  Please report this on
 the ulink url=http://bugs.kde.org/;KDE Bug Tracker/ulink.  (I
 would either say offline documentation or an offline manual)
 
  In case the application does not have an offline documentation use
  the online ressources ulink url=http://userbase.kde.org/;Userbase
  Documentation/ulink and ulink url=http://forum.kde.org/;KDE
  Community Forums/ulink to get help.
 
 In case the application does not have offline documentation, you should
 use the online ressources ulink
 url=http://userbase.kde.org/;Userbase 

[kde-doc-english] Documentation not found handbook in KHelpcenter - terminology

[Jack]

On 2010.09.22 14:57, Burkhard L?ck wrote:
 Am Dienstag, 21. September 2010, um 23:32:35 schrieb Jack:
...

 One question - it would be nice if we could be consistent with use  
 of the words documentation, manual, and handbook.  They seem to be  
 used almost interchangeably.  This confused me a bit as a new KDE  
 user, until I just got used to the terminology.  I don't know if  
 this is addressed anywhere in the KDE documentation.

 Me did not notice an inconsistency so far, but from a new KDE users  
 PoV that could be really different.
Maybe it is not as much of a problem as I thought.

 An attempt for a definition of these terms from my pov:

 1) Handbook - the application help lanched via F1/Help menu
This is always clear, although I have sometimes referred to the  
handbook as the manual.  KDE seems to use handbook specifically for  
this, where non-KDE apps and systems might use manual.  In English, I'm  
not sure the difference between the words is significant.

 2) Manual - man(ual) page
I'm so used to Unix-speak, that I had almost forgotten that man was  
short for manual.  I don't think I've ever seen anyone say manual  
instead of man-page.  In general English usage, I think of most  
man-pages as a summary or abbreviated form of a manual, although there  
are certainly exceptions.  Perhaps it is best just to explicitly say  
man-page and avoid use of the work manual.

 3) Help for System Setting modules, ioslaves and the like,  
 technically usually a docbook article, what to use for them?
Perhaps help-page can be used as a general reference for anything too  
short or too narrow in scope to be called a handbook, and not written  
in the specific style of a man-page (or not documenting a single  
command).

 Documentation as general term for all types of help (1-3)
I agree.

 In bugreports often the term Help is used.
I would use Help in a broader way, including documentation, but also  
any context-sensitive assistance provided within an application itself,  
such as tool-tips.

 Jack, could you please give some examples for this inconsistent usage?
I don't have any concrete examples - it is mainly from memory, so  
probably nothing needs to be done about this unless anyone else speaks  
up.  I just need to stop saying manual when I mean handbook.
 
[]
 Excellent improvement, I'll use it in the docbook.
Thanks.


Jack

[kde-doc-english] Documentation not found handbook in KHelpcenter - terminology

[Burkhard Lück]

Am Mittwoch, 22. September 2010, um 21:56:29 schrieb Jack:
 On 2010.09.22 14:57, Burkhard L?ck wrote:
  Am Dienstag, 21. September 2010, um 23:32:35 schrieb Jack:
 ...
 
  One question - it would be nice if we could be consistent with use
  of the words documentation, manual, and handbook.  They seem to be
  used almost interchangeably.  This confused me a bit as a new KDE
  user, until I just got used to the terminology.  I don't know if
  this is addressed anywhere in the KDE documentation.
  
  Me did not notice an inconsistency so far, but from a new KDE users
  PoV that could be really different.
 
 Maybe it is not as much of a problem as I thought.
 
  An attempt for a definition of these terms from my pov:
  
  1) Handbook - the application help lanched via F1/Help menu
 
 This is always clear, although I have sometimes referred to the
 handbook as the manual.  KDE seems to use handbook specifically for
 this, where non-KDE apps and systems might use manual.  In English, I'm
 not sure the difference between the words is significant.
 
  2) Manual - man(ual) page
 
 I'm so used to Unix-speak, that I had almost forgotten that man was
 short for manual.  I don't think I've ever seen anyone say manual
 instead of man-page.  In general English usage, I think of most
 man-pages as a summary or abbreviated form of a manual, although there
 are certainly exceptions.  Perhaps it is best just to explicitly say
 man-page and avoid use of the work manual.
 
  3) Help for System Setting modules, ioslaves and the like,
  technically usually a docbook article, what to use for them?
 
 Perhaps help-page can be used as a general reference for anything too
 short or too narrow in scope to be called a handbook, and not written
 in the specific style of a man-page (or not documenting a single
 command).
 
  Documentation as general term for all types of help (1-3)
 
 I agree.
 
  In bugreports often the term Help is used.
 
 I would use Help in a broader way, including documentation, but also
 any context-sensitive assistance provided within an application itself,
 such as tool-tips.
 
  Jack, could you please give some examples for this inconsistent usage?
 
 I don't have any concrete examples - it is mainly from memory, so
 probably nothing needs to be done about this unless anyone else speaks
 up.  I just need to stop saying manual when I mean handbook.
 
I just found an example, Khelpcenter has Application Manuals as top level 
item.
Maybe this has to be changed to Application Handbooks?

-- 
Burkhard L?ck

[kde-doc-english] Documentation not found handbook in KHelpcenter

[Burkhard Lück]

Hi,

until 4.4 the KHelpcenter/konqueror displayed the error message There is no 
documentation available for %1. and additionally a modal dialog with the 
error message The file or folder help://%1 does not exist in case a 
documentation was not found for what ever reason (not installed, no 
documentation, bug like wrong/missing X-DocPath etc.)

Dealing with bug reports on b.k.o I get the impression this behaviour is not 
more user friendly than a KDebug() output in a konsole, it does not give Joe 
User any hint how to get the missing documentation.

In kde 4.5 the behaviour changed. If a documentation was not found, a docbook 
named documentationnotfound will be displayed. This docbook should explain 
what happened and what to do to get the requested information.

I have quickly written a draft for this document:

The requested documentation was not found on your computer.

How to solve this issue:

Search on the ulink url=http://docs.kde.org/;KDE Documentation site/ulink 
for the requested documentation. If you find the documentation on that site, 
maybe your distribution ships a separate package for documentation (eg; 
called kdepim-doc for all applications from the kdepim module
like kmail; kontact; etc;). Please use the package manager of your 
distribution to install the missing documentation.

If you have done that, but still get this page displayed instead of the 
application handbook, you probably found a bug in the kde; help system. 
please report this on the ulink url=http://bugs.kde.org/;KDE Bug 
Tracker/ulink.

If you find no documentation on the ulink url=http://docs.kde.org/;KDE 
Documentation site/ulink the application does not have an offline 
documentation, please report this on the ulink url=http://bugs.kde.org/;KDE 
Bug Tracker/ulink.

In case the application does not have an offline documentation use the online 
ressources ulink url=http://userbase.kde.org/;Userbase 
Documentation/ulink and ulink url=http://forum.kde.org/;KDE Community 
Forums/ulink to get help.

I am too much involved in the kde documentation system, so I can't imagine if 
this draft is really suited for Joe User.

So please anybody on this list step up and comment/improved this draft:

Does Joe User understand what to do?

What is missing, much/less to technical, needs more explanation?

Better wording?

Any more examples how distributions seperate and name the documentation for an 
application or module?

Thanks. 

-- 
Burkhard L?ck

[kde-doc-english] documentation of 'Rename Tab Dialog'

[Yuri Chornoivan]

 Fri, 16 Jul 2010 04:35:58 +0300, Jim Anderson  
jjanderson52000 at yahoo.com:



 I have  been trying to set the name of my tabs to fixed names.


 One would think that typing in a name with no tokens would
 fix the name of the tab. But this is not the case. The konsole
 resets the name of the tabs according to it's own liking, and one
 which I have yet to figure out.


 In the documentation, I would like to see a statement describing
 the behavior for naming a tab when the 'Tab title format' is left
 blank, or when a fixed set of characters is entered, i.e. with no
 tokens present.


 I would also like to see a statement added describing how to
 set the name of a tab to a fixed name.


 Jim Anderson


Hi!

Thank you for the report.

Can you please file the bug reports on bugs.kde.org with this text against  
Konsole and KDE documentation?

It will be much more easier to track it with the fixed bug report number,  
schedule, etc.

Thanks in advance.

Yuri

[kde-doc-english] Documentation

[Yuri Chornoivan]

Hi!

 Wed, 14 Apr 2010 21:37:44 +0300, Tomas Straupis  
tomasstraupis at gmail.com:

 Hello

   Where can I get information about plans on documentation in  
 docmessages?
   It is kind of strange that the main problem when TRANSLATING
 documentation is to find out which document is still valid.

Please refer to this table:

http://techbase.kde.org/Projects/Documentation/KDE4_(health_table)

   Are there any plans to remove deprecated documentation to ease this  
 task?

Please refer to this folder (boilerplate of the new documentation):

http://websvn.kde.org/branches/work/doc/


   I see docmessages as primary source of documentation while userbase
 as secondary. So translating docmessages seems more important...

I agree with you. But nobody wants to write common documentation (except  
those valuable developers and translators who made cells in heath table  
green).

Hope someday when documentation on Userbase become oldish and deprecated  
(if today's state of art does not change it will be very soon), somebody  
will say Hey, let's write docbooks: its' much easier than this oldish  
wikis. Dialectics... ;)


   Thank you


Best regards,
Yuri

[kde-doc-english] Documentation

[Tomas Straupis]

Hello

  Where can I get information about plans on documentation in docmessages?
  It is kind of strange that the main problem when TRANSLATING
documentation is to find out which document is still valid.
  Are there any plans to remove deprecated documentation to ease this task?

  I see docmessages as primary source of documentation while userbase
as secondary. So translating docmessages seems more important...

  Thank you

-- 
Tomas Straupis

[kde-doc-english] documentation on docs.kde.org

[Vikram Dhillon]

Hi all,
 Hope everyone is doing good. I am currently working on bugs in
kde-docs and hope to get it down to 0 soon. There are some problems
however that I have noticed, a major one being that a lot of
documentation in kde is outdated, especially the screen-shots on
docs.kde.org. Now I do understand that the documentation writers
(including me) are working hard to keep everything up-to-date, but we
need to find another way of updating this information, I don't mean
for this email to come across as criticism, but as a brainstorm on
what can be done to assure that our documentation doesn't fall behind.
Here are some ideas, I thought about that we can use:

1. Add a new tag, something like release-specific to some parts of
the docs. that are new features in that release, there is a good part
of docs. that we can use again only updating some of it such as the
new features.. This tag can be used to filter out the docs. using a
script or something similar.

2. Adopt some docs. from userbase and techbase, they can be really
good resources and they stay pretty updated.

3. Develop a system of automatically adding docbook tags, this can
help us with adopting documentation from other sources.

Again, these are just some ideas I thought about what do you guys think :)

-- 
Regards,
Vikram Dhillon

~~~
There are lots of Linux users who don't care how the kernel works, but
only want to use it. That is a tribute to how good Linux is.
-- Linus Torvalds

[kde-doc-english] Documentation update for Device Actions KCM

[Ben Cooksley]

Hi documentation team,

please find the update to the Device Actions KCM documentation below,
its user interface has changed for KDE 4.4, so new screenshots will be
needed as well.
The section Edit requirement is now deprecated, and needs to be
removed as well

Regards and Thanks,
Ben Cooksley
Device Actions KCM maintainer.

== Update for Edit Action section of Device Actions KCM Documentation ==

This includes the icon, the action name, the action command and the
various parameters.
You can change the icon by clicking on it.

The parameters are displayed in a tree, the top item having to be true
in order for the action to be shown.

Edit parameter:
= Parameter type: This controls what can be contained inside it, or
what matching is performed to check if it is true.

- Property Match: Compares the specified property of the Device (
using Device Type and Value name )
  and using the evaluator, compares it aganist the
text provided.

- Content Conjunction: All sub-properties of this must be true for
it to be true itself.
- Content Disjunction: Any sub-property of this may be true for it
to be true itself.
- Device interface match: Checks to see if the Device can be
classed as the selected Device type.

= Device type: These are the possible device types supported by KDE on
your system.
   They are used in both Property and Device interface matches.

= Value name: This is a list of all possible property names for the
selected device type.
  It also provides the selection of the value evaluator (
which is either Equals or Contains ), and allows
  entry of the text to be compared with.

= Reset Parameter: Reverts any unsaved changes you have made to this parameter
= Save Parameter: Saves the changes you have made to the parameter.

[kde-doc-english] Documentation update for Device Actions KCM

[Burkhard Lück]

Am Samstag, 21. novembre 2009 11:37:37 schrieb Ben Cooksley:
 Hi documentation team,
 
 please find the update to the Device Actions KCM documentation below,
 its user interface has changed for KDE 4.4, so new screenshots will be
 needed as well.
 The section Edit requirement is now deprecated, and needs to be
 removed as well
 
I'll put it into the dockook, thanks.

Any doc update for other kcms you are involved and/or know how to updae them?

-- 
Burkhard L?ck

[kde-doc-english] Documentation for KTron

[Burkhard Lück]

Am Samstag 17 Januar 2009 14:58:23 schrieb Legolas:
 Hello doc-list,

 I've been working on KTron for KDE4 for quite some time now and I think
 it's about time to start documentation. KTron has had major changes and
 even got a new sub-application (SnaKe). So most of the documentation is
 outdated.

 I must say I never touched any KDE documentation before (documentation
 isn't something I'm good at).
 So, is there someone who can help me get started with documenting?

Please have a look at:
http://techbase.kde.org/Projects/Games/Documentation_progress

There you find information about the kdegames documentation team, writing 
guidelines and the docbook skeleton used in kdegames.


-- 
Burkhard L?ck

[kde-doc-english] Documentation for KTron

[Legolas]

Hello doc-list,

I've been working on KTron for KDE4 for quite some time now and I think
it's about time to start documentation. KTron has had major changes and
even got a new sub-application (SnaKe). So most of the documentation is
outdated.

I must say I never touched any KDE documentation before (documentation
isn't something I'm good at).
So, is there someone who can help me get started with documenting?

Stas Verberkt
(LegolasV @ FreeNode)

[kde-doc-english] Documentation for Konsole

[Jonathan Jesse]

Good morning Lesely,

As you are working on setting up your Konsole profiles feel free to document
the changes that need to be made in either a text file or an open office
document and submit it to the list.  That way it can be put into Docbook XML
and corrected in the help manual.

Jonathan


On 12/15/08, Lesley Longhurst Lesley.Longhurst at opus.co.nz wrote:

 You've probably got this on your list already, but I'd really like a
 proper reference for all the possible entries in profile definition file.

 I've just upgraded Ubuntu from 1.04 (Hardy) to 8.10 (Intrepid) which
 gave me an upgraded KDE, and now my Konsole profiles don't work.



 --
 Lesley Longhurst (previously Walker)
 Linux Systems Administrator
 Opus International Consultants Ltd
 Email lesley.longhurst at opus.co.nz
 Tel +64 4 471 7002, Fax +64 4 473 3017
 http://www.opus.co.nz
 Level 9  Majestic Centre, 100 Willis Street, PO Box 12 343
 Wellington, New Zealand

 ___
 kde-doc-english mailing list
 kde-doc-english at kde.org
 https://mail.kde.org/mailman/listinfo/kde-doc-english

-- next part --
An HTML attachment was scrubbed...
URL: 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20081216/f6fd154d/attachment.htm
 

[kde-doc-english] Documentation for Gwenview

[Manfred Mislik]

On Freitag 12 Dezember 2008 18:57:13 Barry Demers wrote:
 I have been in contact with Aurelien Gateau regarding writing an updated
 document for Gwenview, targeted to run under KDE4.3.

 While I have had some experience writing documentation, this would be my
 first attempt in the Docbook environment.  I did notice that  a plain
 text  document would be considered acceptable by you, as  I'd certainly
 fall into the never get around to the writing group. I feel quite
 intimidated even supplying only a text version, as  coming up with the
 4.3 version is not going to be any small feat for me.  If I can avoid
 the Docbook formatting for the time being, and if I can figure out how
 to get KDE4.3 running (wherever it is), then I think I'll be on the
 downhill side of the mountain.

If you want to have the latest development status running on your computer to 
describe new features in the application you want to document have a look at:

https://techbase.kde.org/Getting_Started

I don't know if that's very advanced for you but you can always come back for 
more questions. And Aurelien is certainly also going to help you with that.

Manfred


 Any insight you can provide would be greatly appreciated
 ___
 kde-doc-english mailing list
 kde-doc-english at kde.org
 https://mail.kde.org/mailman/listinfo/kde-doc-english

-- 
tictric at jabber.ccc.de

[kde-doc-english] Documentation for Gwenview

[Barry Demers]

I have been in contact with Aurelien Gateau regarding writing an updated 
document for Gwenview, targeted to run under KDE4.3.

While I have had some experience writing documentation, this would be my 
first attempt in the Docbook environment.  I did notice that  a plain 
text  document would be considered acceptable by you, as  I'd certainly 
fall into the never get around to the writing group. I feel quite 
intimidated even supplying only a text version, as  coming up with the 
4.3 version is not going to be any small feat for me.  If I can avoid 
the Docbook formatting for the time being, and if I can figure out how 
to get KDE4.3 running (wherever it is), then I think I'll be on the 
downhill side of the mountain.

Any insight you can provide would be greatly appreciated

[kde-doc-english] Documentation

[Stan Tontas]

Burkhard L?ck wrote:
 Am Donnerstag 11 September 2008 07:54:46 schrieb Erik Kj?r Pedersen:
 My scripts don't work see below

 svn co https://svn.kde.org/home/kde/branches/stable/l10n-kde4/documentation
  U   documentation

 Fetching external item into 'documentation/kdelibs'
 svn: Can't connect to host 'anonsvn.kde.org': Connection refused

 That's not only a documentation related problem, I get the same error with 
 everything pulled in via svn:externals from anonsvn.kde.org.
 
 I suppose something on anonsvn.kde.org is broken, but the server is not down.
 
Something similar was mentioned on planetkde:
http://people.fruitsalad.org/adridg/bobulate/index.php?/archives/641-anonsvn.kde.org.html

I guess it's fixed now.

S.

[kde-doc-english] Documentation

[Erik Kjær Pedersen]

My scripts don't work see below

svn co https://svn.kde.org/home/kde/branches/stable/l10n-kde4/documentation
 U   documentation

Fetching external item into 'documentation/kdelibs'
svn: Can't connect to host 'anonsvn.kde.org': Connection refused

best Erik

[kde-doc-english] Documentation Format

[Mark Shelby]

Well, I am going to assume that

a) either everyone associated with kde-doc-english is very busy
writing for 4.0 or
b) No one seems to want to step forward and assume leadership of this group.or
c) Everyone is on vacation/holiday...

Either way, I'll just throw out the questions I have and hope that
someone can answer them. I ask them in the hope that someone can point
me in the direction of being a productive member of the group.

1) How does one start writing documentation? I looked on the
techbase website, but the info there is a little sketchy. Techbase
talks about using EBN to check your documentation once it's written,
but there don't seem to be any documentation suggesting:
  a) What software to use to write the documentation
  b) What format / template the documentation needs to follow
  c) What to do with the documentation once it's written.

2) Shouldn't there be a page devoted solely to the development of
kde-documentation? I've seen the wonderful page at http://docs.kde.org
that allows you to search documentation, but that page needs to be
combined with the info on the main documentation page on
http://www.kde.org/documentation.

3) One of the reasons I love KDE is because of it's consistency of
'look  feel' across the spectrum of the user interface. Unless I am
missing something, I don't see the same continuity in kde
documentation. There should really be an app (maybe in koffice?) which
allows one to write documentation (or suggested revisions) and upload
it to the kde-doc team for review and inclusion in kde releases and
updates. That app should include some type of template for writing
documentation.

4) Maybe one should have the option to never download documentation,
but view it online from within the kde helpcenter.

I think more people would contribute if the process were made more simple.

Look at me, I am trying to contribute but can't really seem to get
answers on even where to start.
I have been trying to get involved for a week now. Someone really
should have contacted me indiviidually by now and told me what tools I
needed and assigned me a document to edit and submit for
consideration.

I as a new member to this group, I certainly don't mean to rant, but
these 'new' observations from a fresh perspective might just help the
doc team improve in what has to be a thankless task.

[kde-doc-english] Documentation Format

[Antonio Salazar]

Interestingly enough, the information about writing documentation
isn't at http://docs.kde.org but rather at http://i18n.kde.org/

Specifically, http://i18n.kde.org/docs/ . There's a documentation
primer, a style guide, and a docbook quick reference.

Hope that helps!
Antonio

On Mon, Apr 14, 2008 at 9:15 AM, Mark Shelby mshelby1 at gmail.com wrote:
 Well, I am going to assume that

  a) either everyone associated with kde-doc-english is very busy
  writing for 4.0 or
  b) No one seems to want to step forward and assume leadership of this 
 group.or
  c) Everyone is on vacation/holiday...

  Either way, I'll just throw out the questions I have and hope that
  someone can answer them. I ask them in the hope that someone can point
  me in the direction of being a productive member of the group.

  1) How does one start writing documentation? I looked on the
  techbase website, but the info there is a little sketchy. Techbase
  talks about using EBN to check your documentation once it's written,
  but there don't seem to be any documentation suggesting:
   a) What software to use to write the documentation
   b) What format / template the documentation needs to follow
   c) What to do with the documentation once it's written.

  2) Shouldn't there be a page devoted solely to the development of
  kde-documentation? I've seen the wonderful page at http://docs.kde.org
  that allows you to search documentation, but that page needs to be
  combined with the info on the main documentation page on
  http://www.kde.org/documentation.

  3) One of the reasons I love KDE is because of it's consistency of
  'look  feel' across the spectrum of the user interface. Unless I am
  missing something, I don't see the same continuity in kde
  documentation. There should really be an app (maybe in koffice?) which
  allows one to write documentation (or suggested revisions) and upload
  it to the kde-doc team for review and inclusion in kde releases and
  updates. That app should include some type of template for writing
  documentation.

  4) Maybe one should have the option to never download documentation,
  but view it online from within the kde helpcenter.

  I think more people would contribute if the process were made more simple.

  Look at me, I am trying to contribute but can't really seem to get
  answers on even where to start.
  I have been trying to get involved for a week now. Someone really
  should have contacted me indiviidually by now and told me what tools I
  needed and assigned me a document to edit and submit for
  consideration.

  I as a new member to this group, I certainly don't mean to rant, but
  these 'new' observations from a fresh perspective might just help the
  doc team improve in what has to be a thankless task.
  ___
  kde-doc-english mailing list
  kde-doc-english at kde.org
  https://mail.kde.org/mailman/listinfo/kde-doc-english




-- 
A handful of patience is worth more than a bushel of brains.

I'm a card-carrying member of the American Civil Liberties Union and
encourage you to join! Check out http://www.aclu.org/, become a member
at http://www.aclu.org/join and get active at
http://www.aclu.org/action.

[kde-doc-english] Documentation Format

[Mark Shelby]

Hey thanks, Antonio. That is just the kind of info I was looking for.
It is odd that it's in the i18 section...

Hate to say it, but that just sort of re-enforces the notion that
documentation for kde / linux in general seems to be an after thought.



On Mon, Apr 14, 2008 at 9:29 AM, Antonio Salazar
savedfastcool at gmail.com wrote:
 Interestingly enough, the information about writing documentation
 isn't at http://docs.kde.org but rather at http://i18n.kde.org/

 Specifically, http://i18n.kde.org/docs/ . There's a documentation
 primer, a style guide, and a docbook quick reference.

 Hope that helps!
 Antonio


 On Mon, Apr 14, 2008 at 9:15 AM, Mark Shelby mshelby1 at gmail.com wrote:
  Well, I am going to assume that
 
   a) either everyone associated with kde-doc-english is very busy
   writing for 4.0 or
   b) No one seems to want to step forward and assume leadership of this 
  group.or
   c) Everyone is on vacation/holiday...
 
   Either way, I'll just throw out the questions I have and hope that
   someone can answer them. I ask them in the hope that someone can point
   me in the direction of being a productive member of the group.
 
   1) How does one start writing documentation? I looked on the
   techbase website, but the info there is a little sketchy. Techbase
   talks about using EBN to check your documentation once it's written,
   but there don't seem to be any documentation suggesting:
a) What software to use to write the documentation
b) What format / template the documentation needs to follow
c) What to do with the documentation once it's written.
 
   2) Shouldn't there be a page devoted solely to the development of
   kde-documentation? I've seen the wonderful page at http://docs.kde.org
   that allows you to search documentation, but that page needs to be
   combined with the info on the main documentation page on
   http://www.kde.org/documentation.
 
   3) One of the reasons I love KDE is because of it's consistency of
   'look  feel' across the spectrum of the user interface. Unless I am
   missing something, I don't see the same continuity in kde
   documentation. There should really be an app (maybe in koffice?) which
   allows one to write documentation (or suggested revisions) and upload
   it to the kde-doc team for review and inclusion in kde releases and
   updates. That app should include some type of template for writing
   documentation.
 
   4) Maybe one should have the option to never download documentation,
   but view it online from within the kde helpcenter.
 
   I think more people would contribute if the process were made more simple.
 
   Look at me, I am trying to contribute but can't really seem to get
   answers on even where to start.
   I have been trying to get involved for a week now. Someone really
   should have contacted me indiviidually by now and told me what tools I
   needed and assigned me a document to edit and submit for
   consideration.
 
   I as a new member to this group, I certainly don't mean to rant, but
   these 'new' observations from a fresh perspective might just help the
   doc team improve in what has to be a thankless task.
   ___
   kde-doc-english mailing list
   kde-doc-english at kde.org
   https://mail.kde.org/mailman/listinfo/kde-doc-english
 



 --
 A handful of patience is worth more than a bushel of brains.

 I'm a card-carrying member of the American Civil Liberties Union and
 encourage you to join! Check out http://www.aclu.org/, become a member
 at http://www.aclu.org/join and get active at
 http://www.aclu.org/action.
 ___
 kde-doc-english mailing list
 kde-doc-english at kde.org
 https://mail.kde.org/mailman/listinfo/kde-doc-english

[kde-doc-english] Documentation Format

[Malcolm Hunter]

Hi Mark,

On Mon, April 14, 2008 2:58 pm, Mark Shelby wrote:
 Hey thanks, Antonio. That is just the kind of info I was looking for.
 It is odd that it's in the i18 section...

 Hate to say it, but that just sort of re-enforces the notion that
 documentation for kde / linux in general seems to be an after thought.

I'm sorry you're having difficulties getting the info you need. As Phil
said, people seem to be away at the moment. Most, if not all, of the
contributors are volunteers who have lives outside of KDE. Sometimes it
takes a little while to get a response, but you want be ignored.

I work mainly on the strings in the GUI source code, but I can help with
some stuff or try to point you in the right direction at least. Have you
followed the Getting Involved link on http://www.kde.org? It's just
above the Documentation link in the Develop section.

Regards,
Malcolm
-- 
Web Development, Technical Copy-Editing  Proofreading

KDE Proofreading Team
KDE British English Translation Team

http://l10n.kde.org/team-infos.php?teamcode=en_GB

[kde-doc-english] documentation backports for 3.5

[Philip Rodrigues]

Hi Burkhard,
Thanks for checking these. From the docs point of view, of course, it should 
be fine to backport all the docs you intend to.

Regards,
Philip
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20070310/488cd058/attachment.sig
 

[kde-doc-english] documentation backports for 3.5

[Burkhard Lück]

Hi,

I would like to backport some documentations from trunk to stable.

1. New docs I found so far
ksig (75 messages), kompare (280 messages)
Ok to backport?

2. Docs with bug fixes, changed and sometimes additional content and also ebn 
fixes like eg kbackgammon, kshisen, kpdf, kpercentage, ktouch, kturtle, juk, 
kaudiocreator, kmix, kscd. I suppose there will be some more docs in the other 
kde modules.
There should be no objections to backport this stuff.

3. Docs only with ebn, typo and markup fixes, in addons, admin, edu, games, 
graphics, multimedia all together 32 doc with about 100 fuzzies. There are 
more docs with these changes in the other modules.
I will not backport these docs, except you give me your explicit Ok to do so.

For all backports I can provide a plain text file with message number, 
msgid-previous and msgid-new for the fuzzy messages like the attached example 
for kmix.

Burkhard L?ck
-- next part --

kmix.po

msg number: 15
msgid prev: Christian Esken amp; Matt Johnston
msgid new : Christian Esken amp; Matt.Johnston;

msg number: 31
msgid prev: If you have both ALSA and Open Sound System drivers installed, KMix 
will use the ALSA driver.
msgid new : If you have both ALSA and Open Sound System drivers installed, 
kmix; will use the ALSA driver.

msg number: 34
msgid prev: kmix; usage is straightforward. Every mixer device that your 
soundcard provides is represented by a volume slider. Mono devices have a 
single slider, stereo devices can have either one or two sliders, depending on 
your choice. Additionally there is a panning slider at the bottom of the kmix; 
window. If you have more than one soundcard, a list will be displayed on the 
top of the window, where you can choose between your soundcards.
msgid new : kmix; usage is straightforward. Every mixer control that your 
soundcard provides is represented by a volume slider. Mono controls have a 
single slider, stereo controls can have either one or two sliders, depending on 
your choice. Additionally there is a panning slider at the bottom of the kmix; 
window. If you have more than one soundcard, a list will be displayed on the 
top of the window, where you can choose between your soundcards.

msg number: 38
msgid prev: Output: This holds the controls that are most likely playback 
related, like the \Master\ volume control.
msgid new : guilabelOutput/guilabel: This holds the controls that are most 
likely playback related, like the guilabelMaster/guilabel volume control.

msg number: 39
msgid prev: Input: This holds all controls that are most likely record related, 
like \Capture\.
msgid new : guilabelInput/guilabel: This holds all controls that are most 
likely record related, like guilabelCapture/guilabel.

msg number: 40
msgid prev: Switches: This holds all controls, that allows only to switch some 
functionality ON or OFF (like \Mic Boost (+20dB)\), and multiple-choice 
controls (like \Microphone Select: Mic1 or Mic2\).
msgid new : guilabelSwitches/guilabel: This holds all controls, that allows 
only to switch some functionality ON or OFF (like \Mic Boost (+20dB)\), and 
multiple-choice controls (like guilabelMic Select/guilabel: 
guilabelMic1/guilabel or guilabelMic2/guilabel).

msg number: 41
msgid prev: Besides volumes controls, KMix also features LED's. The general 
coloring rule is:
msgid new : Besides volumes controls, kmix; also features LED's. The general 
coloring rule is:

msg number: 47
msgid prev: The volume controls in section \Output\ and \Input\ consist of 
(top to bottom):
msgid new : The volume controls in section guilabelOutput/guilabel and 
guilabelInput/guilabel consist of (top to bottom):

msg number: 48
msgid prev: screeninfoVolume control (\Input\ Section)/screeninfo
msgid new : screeninfoVolume control (guilabelInput/guilabel 
Section)/screeninfo

msg number: 49
msgid prev: phraseVolume control (\Input\ Section)/phrase
msgid new : phraseVolume control (guilabelInput/guilabel Section)/phrase

msg number: 55
msgid prev: screeninfoVolume control with Recording Switchi 
(\Output\Section)/screeninfo
msgid new : screeninfoVolume control with Recording Switch 
(guilabelOutput/guilabel Section)/screeninfo

msg number: 56
msgid prev: phraseVolume control with Recording Switchi 
(\Output\Section)/phrase
msgid new : phraseVolume control with Recording Switch 
(guilabelOutput/guilabel Section)/phrase

msg number: 57
msgid prev: The volume sliders have a context menu, accessible by right 
clicking on the slider or device icon (at the top). Several entries are 
possible, but only those applicable are shown.
msgid new : Most of these controls have a context menu, accessible by right 
clicking on the control or device icon. Several entries are possible in the 
context menu, but only those applicable are shown.

msg number: 63
msgid prev: If you are not interested in regulating this device you can hide it 
with this option. If you want to show it again, you can only do this by 
selecting 

[kde-doc-english] documentation backport for 3.5.7

[Stephan Johach]

Hi Burkhard!
Am Mittwoch 17 Januar 2007, 00:01:59 schrieb Burkhard L?ck:
 3.5.6 was tagged yesterday, 3.5.7 will come.

...

 I think it's time to ask the translators on kde-i18n-doc at kde.org and our
 release dude for a new docmessage unfreeze.

I'm for it. 

Stephan

[kde-doc-english] documentation backport for 3.5.7

[Burkhard Lück]

Hi,

3.5.6 was tagged yesterday, 3.5.7 will come.

Since the last docmessage freeze for 3.5.6 (16.12.2006) I have fixed some bugs 
in this documentations:
kpackage
kmix
ktouch
kturtle
kaudiocreator
glossary
ksirc
kaddressbook
kscd (I am still working on this doc)

I found some more commits with fixes since 16.12.2006:
blinken
kgeography
khexedit
kwin4
faq
akregator

And two new documentations:
kompare
ksig

I think it's time to ask the translators on kde-i18n-doc at kde.org and our 
release dude for a new docmessage unfreeze.

Burkhard L?ck

[kde-doc-english] documentation backport for 3.5.7

[Burkhard Lück]

Am Mittwoch, 17. Januar 2007 00:10 schrieb Philip Rodrigues:
 On Tuesday 16 January 2007 11:01:59 pm Burkhard L?ck wrote:
  Hi,
 
  3.5.6 was tagged yesterday, 3.5.7 will come.
 
  Since the last docmessage freeze for 3.5.6 (16.12.2006) I have fixed some
  bugs in this documentations:

 snip list

  I think it's time to ask the translators on kde-i18n-doc at kde.org and our
  release dude for a new docmessage unfreeze.

 Thanks for making the list. 

These are only the changed docs from my commit filters, maybe there are some 
more in other modules. I left out everything with only ebn and markup fixes 
and no changes in content, please don not backport such documentations. 
It is only work for the translators, but mostly unvisible for users.

I missed some docs of control center modules:
windowmanagement
see http://lists.kde.org/?l=kde-doc-englishm=116470349523873w=2
path
thinkpad
kvaio
I'm working on this stuff.

I checked the helpcenter and found some additional missing docs:
Games-knetwalk
Graphics-kfaxview
Information-view1394
Settings Modules-Internet  Network-Bluetooth Services
Utilities-Accessibility-KSayIt
Utilities-File-KHexEdit has to be changed to section Editors
Utilities-File-KPalmDOC
Control Center Modules-Display-kcmdisplay
Control Center Modules-User Accounts-userinfo

kio-slaves, see http://lists.kde.org/?l=kde-doc-englishm=116886505723784w=2.
I have written docs for ar, zip, and started with audiocd, but not yet 
commited someting.
Execute kcmshell ioslaveinfo in konsole and check all entries in the list 
for missing docs, you wil find a lot of them :-(

An other important job is to sync docs in branch and stable (missing forward 
or backword ports):
I have already done this in the last doc freeze lifts for AFAIR access, 
addons, admin, edu (except kalzium, where it is desperately needed!), games 
and graphics.

Has to be done for all other modules too.

There is a mail from Nicolas Goutte 
(http://lists.kde.org/?l=kde-i18n-docm=113951101721162w=2) with a list for 
some modules.

 I agree that we should ask for an unfreeze. 
 What would be ideal is if we could somehow reduce the number of fuzzies
 that the translators have to deal with manually - this makes things easier
 for them, and therefore (in the long run), easier for us. Does anyone know
 enough about the translation system to know if there's some way we could do
 this? 

Yes, as I work mainly as translator. I'm only here because I don't like to 
translate outdated or wrong docs ;-)

 Perhaps marking some commits with a keyword, or by making all the 
 fuzzy-only commits (ie, no new content) in one go?

Please no backports with no new or unchanged content!

Create a diff between the docmessage template in stable and trunk and upload 
to somewhere on docs.kde.org would help translators, which have only a 
checkout of stable, to see the changes in the messages.

Burkhard L?ck

[kde-doc-english] documentation backport for 3.5.7

[Philip Rodrigues]

On Wednesday 17 January 2007 7:50:01 am Burkhard L?ck wrote:
 Am Mittwoch, 17. Januar 2007 00:10 schrieb Philip Rodrigues:
  On Tuesday 16 January 2007 11:01:59 pm Burkhard L?ck wrote:
   Hi,
  
   3.5.6 was tagged yesterday, 3.5.7 will come.
  
   Since the last docmessage freeze for 3.5.6 (16.12.2006) I have fixed
   some bugs in this documentations:
 
  snip list
 
   I think it's time to ask the translators on kde-i18n-doc at kde.org and
   our release dude for a new docmessage unfreeze.
 
  Thanks for making the list.

 These are only the changed docs from my commit filters, maybe there are
 some more in other modules. I left out everything with only ebn and markup
 fixes and no changes in content, please don not backport such
 documentations. It is only work for the translators, but mostly unvisible
 for users.

Agreed. It might be nice to backport typo fixes and spelling/grammar fixes 
though, if it's possible to do this without creating fuzzies that have to be 
dealt with manually.

  Perhaps marking some commits with a keyword, or by making all the
  fuzzy-only commits (ie, no new content) in one go?

 Please no backports with no new or unchanged content!

Do you just mean markup and EBN fixes, or are you including 
typos/spelling/grammar fixes?

 Create a diff between the docmessage template in stable and trunk and
 upload to somewhere on docs.kde.org would help translators, which have only
 a checkout of stable, to see the changes in the messages.

I don't quite understand. Do you mean that the translators would be able to 
see what the old message was before it was changed?

Regards,
Philip
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20070117/fb5a232e/attachment.sig
 

[kde-doc-english] documentation backport for 3.5.7

[Burkhard Lück]

Am Mittwoch, 17. Januar 2007 19:27 schrieb Philip Rodrigues:

  These are only the changed docs from my commit filters, maybe there are
  some more in other modules. I left out everything with only ebn and
  markup fixes and no changes in content, please don not backport such
  documentations. It is only work for the translators, but mostly unvisible
  for users.

 Agreed. It might be nice to backport typo fixes and spelling/grammar fixes
 though, if it's possible to do this without creating fuzzies that have to
 be dealt with manually.

Every typo fix or spelling/grammar fix creates a fuzzy message in all 
docmessage files with a translation of this message.

  Please no backports with no new or unchanged content!

 Do you just mean markup and EBN fixes, or are you including
 typos/spelling/grammar fixes?

See above, as a change of one char in the docbook generates fuzzies in about  
20-40 translations, i won't backport a doc only with typos/spelling/grammar 
fixes.

In the docs I have commited to trunk and want to backport you will find also 
markup, EBN and  typos/spelling/grammar fixes, but only together with changes 
in content.

  Create a diff between the docmessage template in stable and trunk and
  upload to somewhere on docs.kde.org would help translators, which have
  only a checkout of stable, to see the changes in the messages.

 I don't quite understand. Do you mean that the translators would be able to
 see what the old message was before it was changed?

See the attachment, a diff between kmix in stable (before a backport) and 
trunk postprocessed with grep -v #.

But it would be a much better solution if scripty could use a msgmerge from 
gettext 0.16.1 with the --previous option.
I just try to backport gettext 0.16.1 to my dapper and edgy systems to see if 
it works as expected.

Whom to ask for scripty's machine and distribution, and if it is possible to 
install a backported gettext?

Burkhard L?ck
-- next part --
A non-text attachment was scrubbed...
Name: kmix.diff
Type: text/x-diff
Size: 24039 bytes
Desc: not available
Url : 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20070117/6be3bcd1/attachment.bin
 

[kde-doc-english] documentation backport for 3.5.7

[Philip Rodrigues]

On Tuesday 16 January 2007 11:01:59 pm Burkhard L?ck wrote:
 Hi,

 3.5.6 was tagged yesterday, 3.5.7 will come.

 Since the last docmessage freeze for 3.5.6 (16.12.2006) I have fixed some
 bugs in this documentations:
snip list

 I think it's time to ask the translators on kde-i18n-doc at kde.org and our
 release dude for a new docmessage unfreeze.

Thanks for making the list. I agree that we should ask for an unfreeze. What 
would be ideal is if we could somehow reduce the number of fuzzies that the 
translators have to deal with manually - this makes things easier for them, 
and therefore (in the long run), easier for us. Does anyone know enough about 
the translation system to know if there's some way we could do this? Perhaps 
marking some commits with a keyword, or by making all the fuzzy-only 
commits (ie, no new content) in one go?

Regards,
Philip
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20070116/05cb6d4e/attachment.sig
 

[kde-doc-english] Documentation problem

[Rainer Endres]

Hi

Am Saturday 28 October 2006 11:46 schrieb Gordon Lack:

 It seems to be a problem with the stylesheet, since if I
 switch off styles in Firefox I can then follow the links
 successfully.



Yes, these are stylesheet problems, which were gone for a while. 
Either I managed to pick up an old stylesheet when we moved to 
the new server or the rendering on Gecko and KHTML changed 
again.

The documentation stylesheets on docs are reworked ATM. So stay 
tuned for the new ones ASAP.

Thanks

Rainer

[kde-doc-english] Documentation problem

[Gordon Lack]

There is a problem with this page:

  http://docs.kde.org/development/en/kdebase/userguide/index.html

in that many of the links do not work.  They seem to have some action 
defined on them instead.  For example, try the Desktop one under III. KDE 
Components

They fail in both Firefox (2.0) and konqueror (3.5.4)

It seems to be a problem with the stylesheet, since if I switch off styles 
in Firefox I can then follow the links successfully.


PS:  What  was looking for was a way to add multi-line decriptions to icons 
on the Desktop.

[kde-doc-english] Documentation Job

[Sander Koning]

Nate Peck wrote on 2006-09-24 21:48 -0700 regarding [kde-doc-english] 
Documentation Job:
 Dear Documentation Team,
   I would like to apply for the documentation job, if something
 still needs writing.
 
From,
Nate Peck

Hello Nate,

Apologies for a late reply!

Sure, there are a lot of things that you can do. For example, we have a number
of so-called Junior Jobs which are listed at our bugtracking system
http://bugs.kde.org - click the Junior Jobs entry and look for bugs that are
assigned to kde-doc-english kde org.

Doing a shameless plug for my own pet project, you can also contribute fairly
well to the KOffice documentation. There is an open jobs list (work-in-progress)
at http://koffice.org/getinvolved/doc-writers.php.

Basically, if you think that there is something you'd like to work on, or if you
think that stuff is missing, you're welcome to contribute. Don't hesitate to ask
for more details if you are unsure about something.

Cheers,
-- 
Sander Koning  (askie)   |   sanderkoning - at - kde -.- nl
KDE Nederland|   http://www.kde.nl/
KOffice  Krita  |   http://koffice.org/http://koffice.org/krita/
KDE documentation|   http://docs.kde.org/
--

-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20060928/23230ca3/attachment.sig
 

[kde-doc-english] Documentation Job

[Nate Peck]

Dear Documentation Team,
  I would like to apply for the documentation job, if something
still needs writing.

   From,
   Nate Peck

[kde-doc-english] Documentation/Example for CGI kioslave

[Juergen Pfennig]

Hi there,

Michael Pyne recently repaired an ugly bug in CGI kioslave and encouraged me
to contribute some documentation directly to KDE (thread in kfm-devel).

 Documentation for the CGI kioslave would indeed be nice however.  It doesn't 
 even have to be marked up or anything, the documentation team is fine with 
 plain text submissions.
 
 Does anyone on the list have objections to me committing the fix then?  If 
 not 
 I'll probably commit tomorrow.
 
 Regards,
  - Michael Pyne

The text listed below (can be used freely by KDE under whatever license) could 
be added behind the current CGI kioslave documentation. It's goal is to enable
experienced Linux Users to use the power of CGI/Bash/Konqueror for their own
scripts. The old documentation was not very helpfull without the source code.

An example of a more komplex CGI kioslave app can be found under:

 http://www.j-pfennig.de/LinuxImHaus/SyslogEinrichtenUndAnsehen.html

Yours J?rgen

==
 KDE 3.5.3 documentation text 

Please note:


The cgi kioslave needs to know where to find the script (or program) to
be executed. It searches in special folders that can be configured using
the kcontrol application (search for cgi). Alternatively you might press
Alt+F2 and type in kcmshell kcmcgi. Add the folder where you keep
your script (or program) to the list.

Another important point is that your script must be executable. Type
something like chmod 755 myscript to be sure.

Examples:
-

Two examples using bash scripting follow next to give you a starting
point and to demonstrate the power of the CGI kioslave. Combining
Bash (or another scripting language) with HTML (eventually using CSS
and Javascript) will allow you to write powerfull GUI applications
without any C++ programming!

Example 1
=

This is the minimal CGI hello world program. The important line of
code is here the Content-Type: text/html thing that instructs konqueror
to render the output of the script as HTML.

---
#!/bin/bash

# The HTTP header followed by an empty line:
echo -e Content-Type: text/html\n

# The content:
echo htmlh1Hello World!/h1/html
---

To make it work create a folder, save the above example as demo1 and type
in a console window:

chmod 775 demo1
kwriteconfig --file kcmcgirc --group General --key Paths $PWD
konqueror cgi:demo1

Beware: The way kwriteconfig is used above would clear all other registered
CGI paths. Consider 1st reading the Paths with kreadconfig and then merging
it with the new one.

Example 2
=

The second example is a bit more complex and demonstrates four features:

1) Finding out if a script is called via CGI or from the command line
2) Checking if the script got input from an HTML Form
3) Converting the url encoded form input to text in bash variables
4) Escaping  and  in output to become HTML compatible

The example itself displays two pages, one prompts for input and the other
shows a result. The result page echoes the text from the input page and can
optionally display the environtment variables of the executing shell.

---
#!/bin/bash

# function called when run from command line ...
commandline_call() {
echo Please open Konqueror and enter 'cgi:${0##*/}' as url
exit 1
}

# function to format html content - input form
input_page() {
cat EOF
h2An Input Form/h2
form action=cgi:${0##*/} method=GET
tabletr
td align=rightDisplay environment settings:/td
tdinput name=chkBox1 type=checkbox value=x/td
/tr
tr
td align=rightType some text please:/td
tdinput name=txtText1/td
/tr
tr
td colspan=2 align=center
INPUT type=reset INPUT type=submit/td
/tr/table
/form
EOF
}

# Function to format html content - result page
output_page() {

# (3) convert url encoded query string to bash variables...
set x ${QUERY_STRING/// }
while [ $# -gt 1 ] ; do
local nam=${2%%=*} ; val=${2#*=} ; shift
local val=${val//\%5C/ } ; val=${val//+/ }
read $nam $(printf ${val//\%/\x})
done

# (4) prepare html output: '' - 'amp;' and '' - 'lt'
local ltxt=${txtText1///amp;} ; ltxt=${ltxt///lt;}

# now create the output...
echo h2This is the Output Page/h2
echo h3Here comes the echo text: $ltxt/h3
[ -n $chkBox1 ] 
echo h3The environment is:/h3pre$(set)/pre
}

# (1) Are we called from the command line?

[ -z $REQUEST_METHOD ]  commandline_call

# (2) Called via cgi - What action to take?

echo -e Content-Type: text/html\n
echo htmltitleThis is CGI Demo2/title

[ -z $QUERY_STRING ]  input_page || output_page

echo 

[kde-doc-english] Documentation in stable and trunk

[Burkhard Lück]

Hi,

I am just checking the state of documentations in the kde modules kdeaddons, 
kdeaccess, kdeedu, kdegamesand kdegraphics between stable nach trunk.

These docs in stable are newer than in trunk, which has to be changed soon, so 
I want to copy them from stable to trunk:

kdeaccessibility:
man-kmousetool.1.docbook
ktts.docbook

kdeaddons: ok

kdeedu:
kalzium
kbruch
keduca
kgeography
khangman
kig
klettres
kturtle

kdegames ok

kdegrapics ok

Any objections?

Burkhard L?ck

[kde-doc-english] Documentation in stable and trunk

[Philip Rodrigues]

Hi Burkhard,

[kde-doc-english] Documentation in stable and trunk

[Burkhard Lück]

Am Dienstag, 30. Mai 2006 14:35 schrieb Philip Rodrigues:
 Hi Burkhard,
 From the documentation point of view, we should forward port all changes
 to trunk, so please go ahead, unless the translators object.

Will do.
Why should translators object, it is trunk!

But somebody else has to do the same check for the documentations in all other 
modules as well, see also this thread:
http://lists.kde.org/?l=kde-doc-englishm=113622277726087w=2

Burkhard L?ck

[kde-doc-english] Documentation

[Dominic Genest]

Hi,

I'm a C++ and QT coder since many years, and I would like to start contribute 
for KDE. Still, I got French good writing skills so maybe it would be 
interesting to start documenting instead. English is not my mother language, 
so I am not a good English writer, but maybe documentation written with my 
poor English would be better than nothing anyways. Besides, I could document 
in bad Spanish, and maybe in very bad German :)

Could someone help me finding a way to start contributing ?

Thanks a lot

Dom

-- 
Dominic Genest
Charg? de cours
D?partement d'Informatique et de G?nie Logiciel
Universit? Laval

[kde-doc-english] Documentation Discussions

[Erik K. Pedersen]

Torsdag den 23. februar 2006 18:16 skrev Lauri Watts:
 Could I politely remind everyone that this is not the right list to have
 documentation discussions, and if you'd like the documentation team to
 actually see them, you might direct issues to kde-doc-english@ instead?

 Thanks,

Ok let me summarize the discussion.

If the docbooks are not frozen at least for a little while before a release, 
it is not possible to produce translated documentation. We can discuss the 
length of the freeze period, but it does not work with no freeze period. This 
time for koffice there were changes made up to the day of the suggested 
release date.

Erik (Danish team)

[kde-doc-english] documentation unfreeze for 3.5.2

[Anders Lund]

On Monday 23 January 2006 23:06, Burkhard L?ck wrote:
 But am I the only one with updated/changed docbooks for 3.5.2?
 Does no one else from the documentation team want to have a documentation
 unfreeze for 3.5.2?

I'd like to add a few things to Kates docs as well.

-anders
-- 
www: http://alweb.dk
jabber: anderslund at jabber.dk

[kde-doc-english] documentation unfreeze for 3.5.2

[Burkhard Lück]

Am Samstag 21 Januar 2006 22:37 schrieb Erik Kj?r Pedersen:

 As I have said before, if there is to be an unfreeze, now is the time to
 have it right after the release, and not in two weeks. When late unfreezes
 are done we have no time to get back on track. Last week in february is
 very alte for 3.5.2

In general I agree to have a documentation unfreeze as early as possible, but 
my personal time planning is: bugfixing koffice docs and translating koffice 
gui until February 2, then translating the docs for koffice and 
updating/bugfixing docs in kdegraphics, kdeedu, kdegames until February 23.
So the last week in february is the best time for me, than I have about two 
weeks left to translate the changed docs for 3.5.2 (until March 17th).

But am I the only one with updated/changed docbooks for 3.5.2?
Does no one else from the documentation team want to have a documentation 
unfreeze for 3.5.2?

Burkhard L?ck

[kde-doc-english] documentation unfreeze for 3.5.2

[Philip Rodrigues]

 But am I the only one with updated/changed docbooks for 3.5.2?
 Does no one else from the documentation team want to have a documentation
 unfreeze for 3.5.2?

I'm in favour of the idea (I think it worked well for us for 3.5.1), but I 
don't have time to work on any docs in the immediate future, unfortunately.

Regards.
Philip
-- 
KDE Documentation Team: http://i18n.kde.org/doc
KDE Documentation Online: http://docs.kde.org
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20060123/18ee1d04/attachment.sig
 

[kde-doc-english] documentation unfreeze for 3.5.2

[Burkhard Lück]

Hi,

I would like to have a documentation unfreeze for 3.5.2.

During the translations of the docbooks changed in december unfreeze 
period I found and fixed some errors in about 15 handbooks.

I would like to work on all documentations in kdegraphics and kdeedu, I could 
not deal with in the december period.

I propose the last week in february for this unfrezze period after tagging 
koffice 1.5 rc, when the translators are done with koffice. 

Then there are two weeks left until the release date of 3.5.2 (March 17th) for 
the translation updates.

Burkhard L?ck

[kde-doc-english] documentation unfreeze for 3.5.2

[Erik Kjær Pedersen]

L?rdag 21 januar 2006 16:28 skrev Burkhard L?ck:
 Hi,

 I would like to have a documentation unfreeze for 3.5.2.

 During the translations of the docbooks changed in december unfreeze
 period I found and fixed some errors in about 15 handbooks.

 I would like to work on all documentations in kdegraphics and kdeedu, I
 could not deal with in the december period.

 I propose the last week in february for this unfrezze period after tagging
 koffice 1.5 rc, when the translators are done with koffice.

 Then there are two weeks left until the release date of 3.5.2 (March 17th)
 for the translation updates.

 Burkhard L?ck

As I have said before, if there is to be an unfreeze, now is the time to have 
it right after the release, and not in two weeks. When late unfreezes are 
done we have no time to get back on track. Last week in february is very alte 
for 3.5.2

Erik

[kde-doc-english] Documentation Patches for 3.5

[Sander Koning]

Lauri Watts wrote on 2005-10-04 19:52 +0200 regarding Documentation Patches for 
3.5:
 In any case I would like to propose that I commit the patches to the 3.5 
 branch just _after_ the release is done, so they go into 3.5.1.  The net 
 effect for translation is minimal, if any, you would normally have got those 
 updates the first time the templates were updated in the branch anyway.  The 
 impact for the English docs is that they won't go into the 3.5 release, but 
 will be available online at docs.kde.org and in the 3.5.1 release.
 
 Comments, objections, please speak up.

I don't really think it's a problem. Not desirable, but with the huge load of
work that overall still needs to be done, it's not really disturbing if some
patches are only available from 3.5.1.

 We've previously discussed with Coolo setting up a docs branch for this kind 
 of thing, which is now, in hindsight, seeming like an even more smashing idea 
 than it did at the time, so either way, I'll see this is done asap after the 
 release.

:)


Cheers,

-- 
Sander Koning   |   sanderkoning - at - kde -.- nl
Documentation coordinator, KDE-NL   |   Documentation maintainer, Krita
http://www.kde.nl/  |   http://koffice.org/krita/
---

-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : 
http://mail.kde.org/pipermail/kde-doc-english/attachments/20051004/9f27243f/attachment.sig
 

[kde-doc-english] Documentation Patches for 3.5

[Philip Rodrigues]

On Tuesday 04 October 2005 18:52, Lauri Watts wrote:
snip
 Comments, objections, please speak up.

No objection here.

 We've previously discussed with Coolo setting up a docs branch for this
 kind of thing, which is now, in hindsight, seeming like an even more
 smashing idea than it did at the time, so either way, I'll see this is done
 asap after the release.

Just to clarify, would this be a branch to which we could commit docs changes 
during the string freeze, and then the changes would be merged back to the 
main branch just before release, as usual? If so, it sounds great, and solves 
all the problems with the current system.

Regards,
Philip
-- 
KDE Documentation Team: http://i18n.kde.org/doc
KDE Documentation Online: http://docs.kde.org

[kde-doc-english] Documentation Patches for 3.5

[Lauri Watts]

Hi all,

I normally collect patches for a new release and apply them to the branch just 
before the final release tarballs are made, after the final generation of 
translated docs.  

This time around however I've dropped the ball and almost certainly won't get 
this done in time.[1] 

In any case I would like to propose that I commit the patches to the 3.5 
branch just _after_ the release is done, so they go into 3.5.1.  The net 
effect for translation is minimal, if any, you would normally have got those 
updates the first time the templates were updated in the branch anyway.  The 
impact for the English docs is that they won't go into the 3.5 release, but 
will be available online at docs.kde.org and in the 3.5.1 release.

Comments, objections, please speak up.

We've previously discussed with Coolo setting up a docs branch for this kind 
of thing, which is now, in hindsight, seeming like an even more smashing idea 
than it did at the time, so either way, I'll see this is done asap after the 
release.

Regards,
-- 
Lauri Watts
KDE Documentation: http://docs.kde.org
KDE on FreeBSD: http://freebsd.kde.org

[1] If anyone cares, I do have good excuses honest.  Between some personal 
stuff (my partner and I are both starting new jobs this month) and a fairly 
beautifully timed hardware failure (my workstation motherboard has died, so 
the machine is unbootable. Worse, in an uncharacteristic fit of modernity, I 
put all SATA drives in it when I specced it, and don't have anything else to 
read them on to get the nearly prepared patch set off, since my dusty old 
laptop can't cope, and the only other SATA machines around here are the RAID 
arrays :)