Suggested names for Amarok manual

Fragment of a discussion from Talk:Amarok/Manual
Jump to: navigation, search
Current naming scheme Proposed naming scheme
Name of the page Amarok/Manual/Various/TroubleshootingAndCommonProblems Amarok/Manual/Troubleshooting
Title of the page Troubleshooting and Common Problems Troubleshooting and Common Problems
DocBook label troubleshooting-and-common-problems troubleshooting-and-common-problems
Last part of the address (used to find the label) TroubleshootingAndCommonProblems Troubleshooting
Results Label (id) found (script assumes that camel-casing can be changed to dashed form) Label (id) not found (troubleshooting != troubleshooting-and-common-problems)
Link in the DocBook <link linkend="troubleshooting-and-common-problems">Troubleshooting and Common Problems</link> (internal) <ulink url="http://userbase.kde.org/Amarok/Manual/Troubleshooting">Troubleshooting and Common Problems</ulink> (external)

So this change effectively breaks almost all internal links for no reason. I still cannot understand why cryptic short names are better than full page name, as my Opera shows (just like modern Firefox and Chrome) just a pleasant short part of the long address in address bar.

Yurchor06:57, 1 December 2011

Now I get it. Thank for the explanation. The proposed scheme will naturally have to be abandoned. I still wonder, if it is a good idea to have the deep nesting levels of some of the pages, such as

Amarok/Manual/Various/AmarokOnOtherPlatforms/OSX

Maybe it is still a good idea to shorten that to

Amarok/Manual/OSX

That should be OK for DocBook, right? (Off course, there may be other reasons for not doing this.)

Btw., the section name of the OSX page is "Amarok on OS X". Does that not create problems for DocBook? Should we make guidelines for manuals that ensures consistency between ToC, page names and chapter/section titles?

Claus chr08:47, 1 December 2011

The current implementation uses only the last part of the address (after the final "/" or "#"). Thus it is immune to the changes of the prefixes. Face-smile.png

Yurchor12:09, 1 December 2011
 
 
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal