[kde-doc-english] Todo's for 4.9

[T.C. Hollingsworth]

On Thu, May 10, 2012 at 7:14 AM, Burkhard Lück <lueck at hube-lueck.de> wrote:
> Am Donnerstag, 10. Mai 2012, 01:28:29 schrieb T.C. Hollingsworth:
>> On Tue, May 8, 2012 at 2:00 PM, Burkhard Lück <lueck at hube-lueck.de> wrote:
>> > Hi all,
>> >
>> > some todo's/questions/comments for our work from my list:
>> >
>> > * KDE Fundamentals
>> > Not visible in KHelpcenter, only on docs.kde.org and via links in
>> > handbooks or "khelpcenter help:fundamentals" in konsole.
>> > KHelpcenter should have a top level item for fundamentals, which icon to
>> > use for it?
>> > The blue K-Button is already used for "Application Manuals"
>>
>> How about a Home icon like in web browsers
>> (/usr/share/icons/oxygen/*/actions/go-home.png).  Seems fitting since
>> this should be the starting point for people looking at documentation.
>>  ;-)
>>
> Yes a possible candidate, what about system-help?

That's fine too.

> There was a review request to change the icon for online help:
> https://git.reviewboard.kde.org/r/104621/

Thanks for the pointer.  I'll start a dialogue with the involved
developers so we can figure out the best way to change these icons.

>> BTW, for me nothing but Application Manuals, Plasma Manual, and UNIX
>> manual pages have icons in that list [1], even though most of them
>> have Icon= entries in their desktop files in
>> kderuntime.git/khelpcenter/plugins.  Are these broken for everyone or
>> just my distro?  I'd like to get them fixed if possible; all the blue
>> question marks look ugly IMHO.
>>
> I have the same icons as in your screenshot in 4.8/4.9 compiled from sources.
>
> khelpcenter/plugins has
> ./info.desktop:92:Icon=help-contents
> ./kicmodules.desktop:94:Icon=help-contents -> change to hwinfo (KInfocenter)?
> ./Scrollkeeper/.directory:88:Icon=help-contents
> ./onlinehelp.desktop:68:Icon=help-contents
> ./plasma.desktop:3:Icon=plasma
> ./kioslaves.desktop:93:Icon=help-contents
> ./Manpages/.directory:88:Icon=application-x-troff-man
> ./kcontrolmodules.desktop:94:Icon=preferences-system -> but shows help-
> contents (preferences-system = Systemsettings icon)

Okay, so we really just need to assign icons to most of these.

kcontrolmodules might get fixed magically if we end up changing icons
like I think the devs want us to  If not, I'll see if I can figure out
whats wrong with it.

>> > * The items in the visual dictionary have to be sync with the preferred
>> > words on www.englishbreakfastnetwork.org/sanitizer/j
>>
>> I'll fix it to match these.
>>
>> For my and others' future reference, there's a complete list of
>> everything this checks for here:
>> http://websvn.kde.org/trunk/quality/sanitizer/tools/preferred_forms?view=ma
>> rkup
>>
>> (I'll see about expanding that list sometime after 4.9 is all settled
>> too.  It hasn't been touched in over 3 years and definitely could use
>> some love.  :-)
>>
> That would be great, i guess you are a native speaker?

Yup.  Not that it matters that much; the docs team speaks better
English than 90% of Americans IMHO.  ;-)

>> > * Find + Replace is done in some apps (KMail, Konsole, Konqueror, Kate)
>> > in a bar inside the viewer/editor window, do we need to add that info or
>> > a screenshot?
>>
>> Also KHelpCenter itself.  The documentation should definitely cover
>> what the application the user is viewing it in does.  ;-)
>>
>> I'll add this.
>>
>> > * Hotkeys or Shortcuts?
>> > Grepping for [Hh]otkey in l10n-kde4/documentation/ gives 32 hits, but for
>> > [Ss]hortcut 3881 hits. So Shortcuts seems to be the default term, change
>> > that?
>>
>> Yeah, not sure why "hotkey" is used repeatedly in that section despite
>> the window being called Configure *Shortcuts*.  :-(
>>
>> > * Working with Schemes
>> > Retake some screenshot with reduced height, some have a lot of
>> > "whitespace" (files-open.png, files-save.png, shortcuts-search.png)?
>>
>> Will do.
>>
>> > * How to import a Scheme is missing.
>> > There is a BR about this issue
>> > (https://bugs.kde.org/show_bug.cgi?id=205694) I have tried to export the
>> > default Konsole Scheme to /tmp/.
>> > Result is shortcuts/share/apps/konsole/konsoleDefaultshortcuts.rc
>> > If I try to export the default Scheme from an other app to /tmp/, nothing
>> > happens. Works only if I export to an other folder.
>> > How to deal with that issue in the fundamentals docbook?
>>
>> Ugh, no application can import a scheme?  "<warning><para>This feature
>> is completely useless.</para></warning>"?
>>
> If you create a new shortcuts scheme named 'schemename' in application
> 'appname', it is saved in $KDEDIR/apps/appname/appnameschemenameshortcuts.rc.
>
> Exporting the scheme 'schemename' in application 'appname' you have to select
> a folder and the exported scheme is saved in
> shortcuts/share/apps/appname/appnameschemenameshortcuts.rc below the selected
> folder.
>
> Copy/move the file appnameschemenameshortcuts.rc to the folder
> $KDEDIR/apps/appname/ it will be picked up and accessible in the drop down box
> labelled "Current scheme"
>
> From my pov this strange intermediate subfolders should be removed, see
> attached diff. Then we should add the information where to move/copy an
> exported scheme to.

Agreed.  Please file a review request for that.

It wouldn't be that hard to write a UI for importing, which would be
the ideal solution.  Unfortunately with kdelibs 4 frozen like it is I
don't think we can add one to 4.x.  :-(

I guess we'll just have to document where to copy the file to for now,
kludgy as it is.

>> Just noticed that at least Konsole can print shortcuts too.  Probably
>> should mention that.
>>
> Yes please

Already done.  :-)

>> > Let's start to update docbooks for 4.9 now.
>> > Systemsettings, Kate (thanks T.C.) and granatier already got some love.
>> >
>> > I have Dolphin already on my todo list.
>> >
>> > Any suggestions, which docbooks need additional infos or an update?
>>
>> No idea, but I can flip back through Commit Digest soon to see if
>> there's any interesting new stuff we can add.
>>
> That would be great, thanks.

Will do.

-T.C.