[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-devel
Subject: Re: KFile plugins
From: Fred Schaettgen <kde.sch () ttgen ! net>
Date: 2005-10-16 8:51:00
Message-ID: 200510161051.00438.kde.sch () ttgen ! net
[Download RAW message or body]
Egon Willighagen wrote:
> How do you document your plugins? Just ApiDox, or did you write user
> documentation too? I've started a bit of that, but could not find any
> kfile documentation in the KDE help... where should I look?
I don't really see the need for *user* documentation. The plugins are not
supposed to be configureable and the only question I can think of is where to
find a plugin for a given file type.
The output of the plugin should be so simple that you don't need documentation
to understand it.
Most people don't know about the kfile plugin system, so they won't search for
kfile plugin documentation. It's just konqueror etc. showing the properties
of a file to them.
Maybe it's not the kfile-plugins that should get user documentation, but
mimetypes instead. This documentation could be linked to from the docs of
applications supporting it (section "supported file types"), from the file
association dialogs and from somewhere in the file properties.
There you could describe what "interlace mode" means (or link to external
documentation) for png files and say what a png file is and can do in
general . The kfile plugin should simply reuse the existing terminology for
its attribute names.
regards
Fred
--
Fred Schaettgen
kde.sch@ttgen.net
>> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to unsubscribe <<
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic