Bug 292560 - private protocol help published to the Web
Summary: private protocol help published to the Web
Status: RESOLVED FIXED
Alias: None
Product: docs.kde.org
Classification: Websites
Component: docs.kde.org (show other bugs)
Version: unspecified
Platform: openSUSE Linux
: NOR normal
Target Milestone: ---
Assignee: T.C. Hollingsworth
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-01-27 08:41 UTC by Christopher Yeleighton
Modified: 2012-05-05 12:40 UTC (History)
3 users (show)

See Also:
Latest Commit:
Version Fixed In:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Christopher Yeleighton 2012-01-27 08:41:41 UTC
Version:           unspecified (using KDE 4.7.2) 
OS:                Linux

The hyperlinks to components of Kontact use the help protocol which is private to KDE.  This should not happen; we want potential customers to be able to access documentation beforehand.

Reproducible: Always

Steps to Reproduce:
  1. Tell Mozilla Firefox to visit the page "Chapter 2. Kontact Components" [1]
  2. Tell Mozilla Firefox to follow the hyperlink "KAddressBook".

Actual Results:  
  1. 
KAddressBook

    The KDE contact manager.

  2. WTF?

Expected Results:  
  2. KAddressBook handbook.

___
[1] <URL: http://docs.kde.org/development/en/kdepim/kontact/components.html >
Comment 1 Burkhard Lück 2012-02-03 10:45:37 UTC
A fix for the bug you reported was committed with http://websvn.kde.org/?view=revision&revision=1276619

Works for the cases you reported (link to otherapp/index.html), but not always properly:

1)kde-baseapps/kwrite/config-dialog.html link Document Variables works

2)kde-baseapps/kwrite/view-menu.html link The Editor Component Command Line does nothing

3)kde-baseapps/kwrite/view-menu.html link Extending Kate with Scripts opens kate/index.html, but should open kate/advanced-editing-tools-scripting.html
Comment 2 T.C. Hollingsworth 2012-02-03 11:58:30 UTC
#2 is easy, the ulink in the docbook is wrong.  I'll fix it when I get home.  (I'll also file a bug about 404.php not being displayed here like it should.)

#3 is more complicated. Khelpcenter will redirect e.g. help:/kawesomeapp/#menus-file to help:/kawesomeapp/menus.html#menus-file.  I could fix the sed expression so that help:/kawesomeapp/#menus would go to help:/kawesomeapp/#menus go to /menus.html, but something like #menus-help would go to menus-help.html and 404. 

If there aren't a lot of these kind of links IMHO we should just change the docbooks to use the help:/kawesomeapp/chapter.html#section form. If there are too many to change we'd have to fix the sed expression and check that the path argument really exists in PHP and redirect to index.html if not.
Comment 3 T.C. Hollingsworth 2012-02-03 12:20:52 UTC
Git commit a02a9aad5a2227ee5f587b80c9002835e1ceb2a7 by T.C. Hollingsworth.
Committed on 03/02/2012 at 13:18.
Pushed by hollingsworth into branch 'KDE/4.8'.

kwrite doc: fix ulinks so they work on docs.kde.org

M  +2    -2    doc/kwrite/menus.docbook

http://commits.kde.org/kate/a02a9aad5a2227ee5f587b80c9002835e1ceb2a7
Comment 4 T.C. Hollingsworth 2012-02-03 12:20:52 UTC
Git commit c4bdba477f4461c92819b709ed0a19c8409c6e64 by T.C. Hollingsworth.
Committed on 03/02/2012 at 13:18.
Pushed by hollingsworth into branch 'master'.

kwrite doc: fix ulinks so they work on docs.kde.org

M  +2    -2    doc/kwrite/menus.docbook

http://commits.kde.org/kate/c4bdba477f4461c92819b709ed0a19c8409c6e64
Comment 5 Burkhard Lück 2012-02-03 20:16:26 UTC
(In reply to comment #2)
> 
> #3 is more complicated. Khelpcenter will redirect e.g.
> help:/kawesomeapp/#menus-file to help:/kawesomeapp/menus.html#menus-file.  I
> could fix the sed expression so that help:/kawesomeapp/#menus would go to
> help:/kawesomeapp/#menus go to /menus.html, but something like #menus-help
> would go to menus-help.html and 404. 
> 
> If there aren't a lot of these kind of links IMHO we should just change the
> docbooks to use the help:/kawesomeapp/chapter.html#section form. If there are
> too many to change we'd have to fix the sed expression and check that the path
> argument really exists in PHP and redirect to index.html if not.

If I got it right these links have to be changed:
$ wcgrep "index.html#" .
./kde-baseapps/konqueror/config.docbook:125:<listitem><para><ulink url="help:/dolphin/index.html#preferences-dialog-viewmodes">View Modes</ulink>: 
./kde-baseapps/konqueror/config.docbook:127:<listitem><para><ulink url="help:/dolphin/index.html#preferences-dialog-navigation">Navigation</ulink>: 
./kde-baseapps/konqueror/config.docbook:129:<listitem><para><ulink url="help:/dolphin/index.html#preferences-dialog-services">Services</ulink>: 
./kde-baseapps/konqueror/config.docbook:131:<listitem><para><ulink url="help:/dolphin/index.html#preferences-dialog-general">General</ulink>: 
./kde-baseapps/konqueror/filemanager.docbook:318:url="help:/plasma-desktop/index.html#device-notifier">Device Notifier</ulink> 
./extragear-graphics/digikam/sidebar.docbook:60:                 <listitem><para>with the <ulink url="help:/index.html#using-cameraclientrenaming">camera dialog</ulink></para></listitem>
./extragear-graphics/digikam/index.docbook:1817:                <ulink url="http://www.emtac.com/products/bluetooth/index.html#btgps">EMTAC bluetooth GPS </ulink>
./kdepimlibs/kcontrol/kresources/index.docbook:56:<entry><ulink url="help:/kalarm/index.html#resources">&kalarm; resources</ulink></entry>
./kdepimlibs/kcontrol/kresources/index.docbook:62:<entry><ulink url="help:/korganizer/index.html#managing-resources">&korganizer; resources</ulink></entry>
./kdepimlibs/kcontrol/kresources/index.docbook:67:<entry><ulink url="help:/knotes/index.html#configure-resources">&knotes; resources</ulink></entry>
./kde-runtime/kcontrol/kcmlaunch/index.docbook:53:section of the <ulink url="help:/plasma-desktop/index.html#panel">
./extragear-utils/krusader/viewer-editor.docbook:572:<ulink url="help:/kate/index.html#advanced-editing-tools-scripting">Extending &kate; with Scripts</ulink>

to

chapter.html#sectionid ?
Comment 6 T.C. Hollingsworth 2012-02-03 21:16:37 UTC
(In reply to comment #5)
> If I got it right these links have to be changed:
> $ wcgrep "index.html#" .
<snip> 
> to
> 
> chapter.html#sectionid ?

Yup, minus a couple false positives.

I can go in and fix these a little bit later if you would like.  Should I just do it on master or backport to the 4.8 branch too?
Comment 7 Burkhard Lück 2012-02-03 21:37:19 UTC
(In reply to comment #6)
> 
> Yup, minus a couple false positives.
> 
> I can go in and fix these a little bit later if you would like.  Should I just
> do it on master or backport to the 4.8 branch too?

Please only on master and add an info to backport to 4.8.2 on http://techbase.kde.org/Projects/Documentation/KDE4_(health_table).

We have to give the translation teams enough time to finish docs for 4.8.1.

Thanks
Comment 8 T.C. Hollingsworth 2012-02-03 22:28:41 UTC
Git commit 8b350c0dd99ae463f046cc5c860be82ff6d4d92f by T.C. Hollingsworth.
Committed on 03/02/2012 at 23:28.
Pushed by hollingsworth into branch 'master'.

kresources doc: fix ulinks to work on docs.kde.org

M  +4    -3    doc/kcontrol/kresources/index.docbook

http://commits.kde.org/kdepimlibs/8b350c0dd99ae463f046cc5c860be82ff6d4d92f
Comment 9 T.C. Hollingsworth 2012-02-03 22:29:57 UTC
Git commit 79214e3379262f329c53c5f37931751a80798f61 by T.C. Hollingsworth.
Committed on 03/02/2012 at 23:19.
Pushed by hollingsworth into branch 'master'.

konqueror doc: fix ulinks to work on docs.kde.org

M  +4    -4    doc/konqueror/config.docbook

http://commits.kde.org/kde-baseapps/79214e3379262f329c53c5f37931751a80798f61
Comment 10 T.C. Hollingsworth 2012-02-03 22:34:14 UTC
Git commit 8a1ad228cbeb814acbceb6e57615097e9985c6d5 by T.C. Hollingsworth.
Committed on 03/02/2012 at 23:33.
Pushed by hollingsworth into branch 'master'.

fix ulinks to work with docs.kde.org

M  +1    -1    digikam/sidebar.docbook

http://commits.kde.org/digikam-doc/8a1ad228cbeb814acbceb6e57615097e9985c6d5
Comment 11 T.C. Hollingsworth 2012-02-03 22:37:17 UTC
Git commit 073c84280e4fde8eb26dcdd4cebca0ad1d6105c2 by T.C. Hollingsworth.
Committed on 03/02/2012 at 23:36.
Pushed by hollingsworth into branch 'master'.

kcmlaunch doc: fix ulinks to work with docs.kde.org

M  +1    -1    doc/kcontrol/kcmlaunch/index.docbook

http://commits.kde.org/kde-runtime/073c84280e4fde8eb26dcdd4cebca0ad1d6105c2
Comment 12 T.C. Hollingsworth 2012-02-03 22:42:34 UTC
Git commit 32180c5e211aff72e2610c3baacd087aa1155eb7 by T.C. Hollingsworth.
Committed on 03/02/2012 at 23:41.
Pushed by hollingsworth into branch 'master'.

doc: fix ulink to work on docs.kde.org

M  +1    -1    doc/viewer-editor.docbook

http://commits.kde.org/krusader/32180c5e211aff72e2610c3baacd087aa1155eb7
Comment 13 Burkhard Lück 2012-02-10 10:49:51 UTC
Fixed with switching doc.kde.org to 4.8 (stable) / 4.9.x (development)
Comment 14 Burkhard Lück 2012-05-05 07:14:20 UTC
Git commit efc93384216491e60d1076e9a44e4b19922d0e63 by Burkhard Lück, on behalf of T.C. Hollingsworth.
Committed on 03/02/2012 at 23:19.
Pushed by lueck into branch 'KDE/4.8'.

konqueror doc: fix ulinks to work on docs.kde.org
(cherry picked from commit 79214e3379262f329c53c5f37931751a80798f61)

backport to branch 4.8

M  +4    -4    doc/konqueror/config.docbook

http://commits.kde.org/kde-baseapps/efc93384216491e60d1076e9a44e4b19922d0e63
Comment 15 Yuri Chornoivan 2012-05-05 12:40:13 UTC
Git commit 59a9639a18d80b874b7ca710860becd19c1063ab by Yuri Chornoivan, on behalf of T.C. Hollingsworth.
Committed on 03/02/2012 at 23:36.
Pushed by yurchor into branch 'KDE/4.8'.

kcmlaunch doc: fix ulinks to work with docs.kde.org

M  +1    -1    doc/kcontrol/kcmlaunch/index.docbook

http://commits.kde.org/kde-runtime/59a9639a18d80b874b7ca710860becd19c1063ab