Suggested names for Amarok manual

Fragment of a discussion from Talk:Amarok/Manual
Jump to: navigation, search

Your first two points goes without saying - we did think of that Face-smile.png

The idea of changing page names were made on the assumption, that the DocBook conversion doesn't care about page names - I thought that was the case, so I don't understand why you would need to make a special hack for this. Have I misunderstood your explanation?

The idea of reworking the whole organization of the Amarok Manual including page names is not a new one. It was part of the discussions we had some time ago. For various reasons the process went on hold a bit, but I don't recall anyone expressed misgivings back then - off cause the whole discussion was a bit disorganized, so maybe this was just missed.

Annew and I considered this change because we think that long page names are troublesome (and some of the Amarok page names are really long). Annews main concern is UserBase readers. I actually think they should also be a concern for writers and translators. Shorter links are easier to read (and write) and don't obscure the surrounding text as much as (very) long links.

It is intended to be a "one time only"-affair. In fact I think that not tying page names to the structure of the document is a good thing - that way, if the writers later decides to restructure the manual, they can move pages around by just changing the ToC and PrevNext links - nothing else would need to change.

Off course the advantages of a new naming scheme must be balanced against the work imposed on all of us right now, and if it disrupts the DocBook generation, I doubt it will be worth it to go through with this proposal.

Claus chr19:39, 30 November 2011
  1. There is misunderstanding here: converter does not take into account page names, but since you change links (certainly you should change the links then) there will be no way to guess what is the initial reference point. You can add the anchor, but there will be no gain (the link becomes long) just looses (re-translation).
  2. I cannot understand the point. Is there a plan that include user's link exchange links on Amarok pages? If so, it will be better to use Wiki search system and just point user with words "You should search on UserBase (in embedded manual)." Am I right?
Yurchor20:36, 30 November 2011

1. I still don't understand. I thought the DocBook didn't care about wiki-pages, but instead organized the book in chapters and sections based on their respective titles. And therefore that in order to make proper links it needs the text to match a title exactly. (To fix terminology in the link [[Special:myLanguage/PageName|PageTitle]] I thought it was PageTitle that mattered to DocBook, not PageName).

2. You are referring to Annew's concern for UserBase users, right? The idea is, that users find long names difficult to remember and bothersome to type. But you might get a better answer from Annew.

As for my own points it's about making the raw wiki text easier to work with for writers and translators and about being prepared for future restructuring.

Still, to me the whole point of having manuals on UserBase is the ability to convert them to DocBook, so the problems you mention speak very strongly against the changes. I would still like to understand exactly how the process works, though. The better we all understand the process, the better we can work to get the best results.

Claus chr21:10, 30 November 2011

Let me explain more clearly:

  1. Current manual is not structured (page can be chapter, section, subsection, anything). There is not need to fix it, it is done.
  2. So it is reasonable to use the real structure (chapters and sections) for the referencing. Current script strips off all UB page information as the guessing on page names is almost useless and troublesome.
  3. The script adds labels to each chapter, section, subsection etc. The formatting algorithm for the labels is as follows:
    1. convert section name to lowercase (Wiki is case-ignorant,hence it's necessary step)
    2. replace any forbidden characters (spaces, commas, dots, etc.) with a dash "-".
  4. After that during parsing the script use the labels for resolving UserBase references. It compares the last part of the internal UB link with the list of labels. If there will be equivalent it replaces the link with internal DocBook reference. If not, leaves external UB reference.
  5. Most of the UB links refer to page names, not to page titles (and you will break this if rename pages. Ex.: Troubleshooting and Common Problems would be Troubleshooting.) There is no way to predict such renaming programmatically. I used several hacks to fix current naming scheme. If you break it I'd better give up.

My idea is that no user searches for page names. Users search information (keywords) or just read manual section-by-section. Authors just copy and paste names of pages (users may not even know about them).

Yurchor21:40, 30 November 2011

If I understand you correctly, you are confirming my understanding of the DocBook conversion. But maybe I haven't explained our proposal very well. As an example, we wanted to rename

userbase.kde.org/Amarok/Manual/Various/TroubleshootingAndCommonProblems

(as it is called today) to

userbase.kde.org/Amarok/Manual/Troubleshooting

and change links to that page accordingly, i.e.

[[Special:myLanguage/Amarok/Manual/Various/TroubleshootingAndCommonProblems|Troubleshooting and Common Problems]]

would become

[[Special:myLanguage/Amarok/Manual/Troubleshooting|Troubleshooting and Common Problems]]

(Troubleshooting and Common Problems is the title of the main section of that page). As I see it, DocBook conversion should be unaffected, since the actual title is intact - only the link part would change, or am I missing something?

Off course, this still leaves all the other objections to be carefully considered, even if our plan should turn out not to create problems for the DocBook conversion.

Claus chr22:34, 30 November 2011
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