More Documentation fixes
Burkhard Lück
attached a patch to remove some obsolete stuff:
editors-note.docbook:
Sourceforge documentation tarballs are from 2009-04-21, outdated -> removed
faq.docbook:
Krusader-doc (last mail from Nov 11 2006) and Krusader-i18n (last mail from
Aug 8 2008) removed, the corresponding feeds as well.
The viewer-editor.docbook needs a general review (it has outdated/missing
stuff), but because the viewer is using the kde editor component (kate/kwrite),
it makes sense to reuse the existing and up to date menu + settings
documentation from kwrite, therefor the Kate/KWrite documentation maintainer
is cc'ed.
There are several ways to include the editor component docs:
1) Copy the relevant parts from KWrite, no Installation of KWrite required,
but the documentation manually has to be keept in sync with KWrite.
2) Link to them, but that requires KWrite and it's documentation to be
installed.
3) Move kde's editor component menu + settings documentation from kwrite into
kdelibs, then this documentation is always available on a system running
Krusader.
1) + 2) can be done for 4.8, 3) not before 4.9.
At the moment I tend to no 1) as temporary solution until the proper(?)
solution no 3) is in place, but I'd like to get some input on that, especially
from kate's doc maintainer.
Thanks.
--
Burkhard Lück
Burkhard Lück
> Hi Burkhard and Krusader devs!
>
> On Wed, Dec 7, 2011 at 5:54 AM, Burkhard Lück <lu...@hube-lueck.de> wrote:
> > The viewer-editor.docbook needs a general review (it has outdated/missing
> > stuff), but because the viewer is using the kde editor component
> > (kate/kwrite), it makes sense to reuse the existing and up to date menu
> > + settings documentation from kwrite, therefor the Kate/KWrite
> > documentation maintainer is cc'ed.
> >
> > There are several ways to include the editor component docs:
> >
> > 1) Copy the relevant parts from KWrite, no Installation of KWrite
> > required, but the documentation manually has to be keept in sync with
> > KWrite.
>
> kwrite's menu.docbook and configuring-part.docbook with the <sectN>
> tags dropped one level. I'll come up with a patch.
>
I'd really appreciate that, thanks.
> > 2) Link to them, but that requires KWrite and it's documentation to be
> > installed.
> >
> > 3) Move kde's editor component menu + settings documentation from kwrite
> > into kdelibs, then this documentation is always available on a system
> > running Krusader.
>
> I think it would be great to have a katepart docbook in kdelibs that
> everything can link to or pull in. I'll get that done for 4.9 come
> summer; I already did most of the work needed to get this done with
> the shuffling around I did for 4.8. ;-)
>
Ha, now I know why you splitted the kate/kwrite docs this way ;-)
> > 1) + 2) can be done for 4.8, 3) not before 4.9.
> >
> > At the moment I tend to no 1) as temporary solution until the proper(?)
> > solution no 3) is in place, but I'd like to get some input on that,
> > especially from kate's doc maintainer.
>
> Sounds good to me.
>
Fine, attached a patch using solution no 1), just to illustrate what I have in
mind.
Thanks.
--
Burkhard Lück
T.C. Hollingsworth
>> That shouldn't be a big deal: it looks like krusader just needs
>> kwrite's menu.docbook and configuring-part.docbook with the <sectN>
>> tags dropped one level. I'll come up with a patch.
>>
> I'd really appreciate that, thanks.
No problem. :-)
How's this? I removed all the menu entries that aren't in Krusader,
and the configuration is identical AFAICT.
(BTW, if you want the Krusader folks to see this you'll have to
forward it to the list. I subscribed but it's pending moderator
approval.)
-T.C.
T.C. Hollingsworth
While I was waiting on being approved to join the list, I copied much
of KWrite's menu and configuration documentation to
viewer-editor.docbook. Let me know if you have any suggestions.
Thanks,
T.C.
Burkhard Lück
> On Wed, Dec 7, 2011 at 2:04 PM, Burkhard Lück <lu...@hube-lueck.de> wrote:
> >> That shouldn't be a big deal: it looks like krusader just needs
> >> kwrite's menu.docbook and configuring-part.docbook with the <sectN>
> >> tags dropped one level. I'll come up with a patch.
> >
> > I'd really appreciate that, thanks.
>
> No problem. :-)
>
> How's this? I removed all the menu entries that aren't in Krusader,
> and the configuration is identical AFAICT.
>
What's missing is the Power user mode, in the configuration section and also in
the menu section.
This para explaining the difference for Power user mode should be in as well:
<para>There are different menus and menu items in simple and advanced mode.
The advanced mode is enabled by checking the option <link
linkend="appearance">
Enable power user mode (&kde; 3 mode)</link>
on the <guilabel>Appearance</guilabel> page in &kappname;s settings.</para>
If a user enables/disables the Power user mode in the settings via Configure
Editor in Krusader a lot of menu items change. That should be mentioned,
otherwise it would be confusing.
Thanks.
--
Burkhard Lück
T.C. Hollingsworth
> Looks already good, but apparently you stripped of too much.
>
> What's missing is the Power user mode, in the configuration section and also in
> the menu section.
>
> This para explaining the difference for Power user mode should be in as well:
> <para>There are different menus and menu items in simple and advanced mode.
> The advanced mode is enabled by checking the option <link
> linkend="appearance">
> Enable power user mode (&kde; 3 mode)</link>
> on the <guilabel>Appearance</guilabel> page in &kappname;s settings.</para>
>
> If a user enables/disables the Power user mode in the settings via Configure
> Editor in Krusader a lot of menu items change. That should be mentioned,
> otherwise it would be confusing.
Hmm, they must have added power mode back in git or something. I
don't see anything about it in the version on my system (2.4.0-beta1).
I'll restore the power mode references from kwrite and build master
and check against that.
-T.C.
T.C. Hollingsworth
> Looks already good, but apparently you stripped of too much.
>
> What's missing is the Power user mode, in the configuration section and also in
> the menu section.
>
> This para explaining the difference for Power user mode should be in as well:
> <para>There are different menus and menu items in simple and advanced mode.
> The advanced mode is enabled by checking the option <link
> linkend="appearance">
> Enable power user mode (&kde; 3 mode)</link>
> on the <guilabel>Appearance</guilabel> page in &kappname;s settings.</para>
>
> If a user enables/disables the Power user mode in the settings via Configure
> Editor in Krusader a lot of menu items change. That should be mentioned,
> otherwise it would be confusing.
I'm attaching an updated patch with power mode stuff restored.
-T.C.
Burkhard Lück
1) Open a text file with F3, then Settings->Configure Editor.
Appearance->General does have "Enable power user mode (KDE 3 mode)"
2) Open a text file with F4, then Settings->Configure Editor.
Appearance->General does *not* have "Enable power user mode (KDE 3 mode)"
The Help button of the Configure Editor dialog alway opens the first page of the
Application Handbook (Kate/KWrite/Krusader), e.g using this button in Krusader
opens the Krusader Handbook.
That is of course wrong, the Help button should open the settings section in
KWrite (and later this section from the editor documentation in kdelibs).
Seems a setHelp() call is missing?
--
Burkhard Lück
Burkhard Lück
Any comments from krusader devels or Yuri?
Thanks.
--
Burkhard Lück
Yuri Chornoivan
> Am Freitag, 9. Dezember 2011, 05:02:08 schrieb T.C. Hollingsworth:
> Any comments from krusader devels or Yuri?
Not from me. You've done perfect job. Thank you. :)
Best regards,
Yuri
T.C. Hollingsworth
> Thanks, works perfectly and I would appreciate to get that in.
No problem. :-)
Merged in http://commits.kde.org/krusader/723e361c7099e74b35f1040281b117d9c26b7c42
-T.C.