Poll: Drop CamelCase in the wiki titles?



  • The "wiki help":http://developer.qt.nokia.com/wiki/WikiHelp urges to use CamelCase for both the titles and the categories of wiki articles.

    In the forum, there are some discussions going on "here":http://developer.qt.nokia.com/forums/viewthread/1949/ and "here":http://developer.qt.nokia.com/forums/viewthread/2244 if that is useful.

    The CamelCase policy is already not respected everywhere, so we want to know your opinion about this topic.



  • I think we should go with CamelCase for both.
    Aditionally, we should use ASCII only for the titles, so the linking gets no problems (see one entry with a russian name and russian letters in the titel)



  • I think that camel case is really bad for titles names. It's very hard to read in longn titles (e.g. BuildStaticQtForWindowsWithGccGerman). Compare this two:

    Using QtMobility sensors and QML from PySide
    UsingQtMobilitysensorsandQMLfromPySide

    I also think that we need a strong, detailed policy on how to name pages. E.g, the spanish translation of "WikiHelp" is "WikiHelpSpanish" or "WikiAyuda" (or "WikiHelpEspañol", which contains a non-ASCII character).

    But probably better to discuss only this here and open another topic and poll on the other.



  • I think the demand for CamelCase should simply be deleted, and good. (I would not forbid it.)



  • To be quite frank, I don't have a strong opinion on either. I picked CamelCase because I personally liked it better when I started setting up the wiki. That's about it. All we need to agree upon is consistency.

    The links on the wiki look nicer with underscores, that was a feature I discovered while getting more familiar with the system. If we agree on this, it will mean less work for all who link to pages from other pages since it doesn't need an alternative title. Same goes for the category pages: the list of pages is just more readable.

    Early next year the wiki will need some serious cleaning anyway - expect a cry for help. So I am fine with whatever comes out of this poll. :)



  • Just for the records, I voted Yes/No. I believe titles are far more readable with spaces in it. If it's technically possible, spaces in categories would not harm. If we could save a separate title this way, that would be a good improvement.



  • (?) Off-topic: I added a "poll help section":http://developer.qt.nokia.com/wiki/ForumHelp#00d17d48fa0bf224e926928f23c884f3 to the [[ForumHelp]].
    Can anybody please review it?

    The trigger was the somewhat confusing relation between the Title:
    Poll: Drop CamelCase in the wiki titles?
    and the subtitle:
    Should CamelCase be used further in the wiki?

    The options were clear to me, except of the prefixes No: and Yes: -
    Yes/No: in this special case was clear ;)



  • quote author="Wolf P." date="1291821796" Off-topic: I added a "poll help section":http://developer.qt.nokia.com/wiki/ForumHelp#00d17d48fa0bf224e926928f23c884f3 to the [[ForumHelp]].
    Can anybody please review it?[/quote]

    Done. Thanks, good start! :)

    I turned your paragraph into bullet points, they tend to be easier to skim. The content should be more or less the same. Can you have a look, please?



  • Very good! I think we should add one point: the suggestion to collect options collaboratively (maybe even in the wiki) when an important poll comes in sight.



  • Sorry, but we are not robots and human-readable is non-CamelCase text. Really.
    bq. No: allow spaces in titles and categories



  • We are not robots but most of us are programmers and using CamelCase in several languages got me used to it.

    On the other hand I do not see how we can let people not to use it if they want. I agree with disperso that we have to make exact rules but on the other hand I do not see how we can sanction if somebody makes a mistake (I do not beleive it is a good idea to apply sanctions).



  • I don't think that we need sanctions. The only thing is, do we want some restrictions or not. And if we want, we perhaps have to rename some pages, otherwise everything stays as is :-)



  • The sanction would be a rename of the page, once that's implemented. That punishment should bearable, I think :-)



  • [quote author="VCsala" date="1292607851"]We are not robots but most of us are programmers and using CamelCase in several languages got me used to it.[/quote]I’m about titles and categories, not about coding style, etc.

    [quote author="Volker" date="1292608053"]The sanction would be a rename of the page, once that's implemented.[/quote]+1



  • [quote author="Alexandra Leisse" date="1291813347"]If we agree on this, it will mean less work for all who link to pages from other pages since it doesn't need an alternative title.[/quote]We are probably all programmers/software developers here. We are usually lazy by nature (and are therefore willing to do a crap load of work, just to save a few minutes later on). In that line I would say that it makes sense to go for the Less Work, More Better approach and allow spaces in the titles.



  • Just to update everyone on the matter before I quietly change stuff...

    I am under the impression that the ones who care prefer spaces in titles (or underscores in the URL), so we'll just go for that.

    For everybody else it shouldn't matter anyway. :-P


Log in to reply
 

Looks like your connection to Qt Forum was lost, please wait while we try to reconnect.