[kde-doc-english] Fwd: Re: [Kde-imaging] Update kipi-plugins docbooks

[Burkhard Lück]

Hello,

I'd like to invite you to help updating the kipi-plugins docbooks.

What I have in mind:

* Merge everything into one docbook

* Structure similar to Konqueror or Kate plugins. Write at least one or two 
sentences about a plugin and its usecase and - if there is more up to date 
infos - link to a separate section like the current Send Images docs.
Use the order of the menuitems in the Tools menu for the plugins.

Using that workflow we can strip off all outdated nonsense and quickly have a 
docbook with limited, but valid content. And later this can be extended easily 
with additional sections for a plugin.

Where to do this? As usual in branches/work/doc or in an own git branch in 
kipi-plugins-doc, which has to be merged with master/latest stable in git  
then?

I see the Acquire Images plugin as a special issue. Afaik it looks like it is 
not much more than a shell around the scanwidget from 
kdegraphics/libs/libksane.

libksane is used from the Acquire Images plugin, skanlite and apparently a lot 
of other applications applications (kolourpaint, calligra/koffice, etc).
Sanning is a common task, sounds like a candidate for the KDE Fundamentals?
Then we could simply use a link to that section in fundamentals here and may 
be also replace some parts of the skanlite docbook with a link to that 
section?

CC'ing Kåre Särs, the libksane + skanlite maintainer therefore.

Any comments, ideas, plans to improve this?

Thanks
----------  Weitergeleitete Nachricht  ----------

Betreff: Re: [Kde-imaging] Update kipi-plugins docbooks
Datum: Samstag, 19. Mai 2012, 20:40:13
Von: Gilles Caulier <caulier.gilles at gmail.com>
An: kde-imaging at kde.org

Burkhard,

All improvements are welcome here. There is no maintainers for this
handbooks since a long time.

Fell free to to polish and make it better for the future.

Best

Gilles Caulier

2012/5/19 Burkhard Lück <lueck at hube-lueck.de>:
> Am Freitag, 4. Mai 2012, 12:25:17 schrieb Burkhard Lück:
>> Hi,
>>
>> reading http://docs.kde.org/development/en/extragear-graphics/kipi-
>> plugins/index.html I noticed, that this documention is in a really bad
>> shape and needs some love.
>>
>> It is a waste of time for users to read and the i18n teams to translate it.
>>
>> What should be done:
>>
>> 1) index.docbook
>> Add
>> <para id="mising-plugin-docs">
>> A lot Kipi plugins currently have no
>> documentation.  If you are interested in rectifying that situation,
>> please contact the Kipi team mailing list at <email>kde-
>> imaging at kde.org</email>.
>> </para>
>> and adapt all X-DocPath entries in kipiplugin desktop files without
>> documentation to this anchor.
>>
>> 2) Acquire Images
>> Scan - update with a stripped copy of skanlite docbook
>> Screenshot - remove it, no code
>>
>> 3) Calendar
>> remove docbook
>>
>> 4) Color Images
>> looks ok, needs additional info?
>>
>> 5) Convert Images
>> ok, needs additional info (see ?-Help)
>>
>> 6) Effect Images
>> ok, needs additional info (see ?-Help)
>>
>> 7) Filter Images
>> ok, needs additional info (see ?-Help)
>>
>> 8) Find Duplicate Images
>> remove docbook, no code?
>>
>> 9) Flickr Export
>> ok?, needs new screenshots?
>> change that to a chapter for all exports to image hosting services?
>>
>> 10) Gallery Export
>> remove docbook
>>
>> 11) Geolocation Editor
>> ok?, needs new screenshots?
>>
>> 12) Images Gallery
>> remove docbook, no code?
>> (looks like konquerors plugin Image Gallery)
>>
>> 13) OpenGL Imageviewer
>> ok?
>>
>> 14) JPEG Loss Less
>> is there really a plugin special für JPEG?
>>
>> 15) Digital Camera Client
>> remove docbook
>>
>> 16) Metadata Editor
>> ok, needs additional info, screenshot?
>>
>> 17) Print Wizard
>> ok, needs additional info, screenshot?
>>
>> 18) Raw Image Converter
>> No raw files here - can't check it.
>>
>> 19) Recompress Images
>> ok?, needs additional info, screenshot?
>>
>> 20) Rename Images
>> ok?, needs additional info, screenshot?
>>
>> 21) Resize Images
>> ok?, needs additional info, screenshot?
>>
>> 22) Send Images
>> up to date docbook + screenshots :)
>>
>> 23) Advanced Slide Show
>> needs update  and new screenshots
>>
>> 24) Time Adjust
>> remove docbook
>>
>> Thanks.
>
> Ping?
>
> Wrong list?
>
> No objections?
>
> Comments please, thanks.
>
> --
> Burkhard Lück
> _______________________________________________
> Kde-imaging mailing list
> Kde-imaging at kde.org
> https://mail.kde.org/mailman/listinfo/kde-imaging
_______________________________________________
Kde-imaging mailing list
Kde-imaging at kde.org
https://mail.kde.org/mailman/listinfo/kde-imaging

-------------------------------------------------------------
-- 
Burkhard Lück