[Suggestion] enable auto-linking of classes in quoted source to the Qt Documentation
-
When sample code is provided in the wiki or in the forum, Qt classes used should be linked to their documentation.
I think this should be easy with a parser in Java|Script : Iterating over the appropriate class, then scanning for the QUppercase pattern and modify the DOM element (it's alreade highlighted).
BTW: next bug found: "Java|Script" (try to remove the pipe char in a posting, then preview)
-
It would even be handy if there was some tag we could use to link to the documentation. QtCentre has the feature you mention, but also this: [qtclass]QString[/qtclass], which would result in a link much like "QString":http://doc.trolltech.com/latest/qstring.html (no [doc.trolltech.com] behind it would make sense in this case -- it's autolinked).
It would be cool if that was available as well.
-
I'd prefer a full-automated version. Optional markup for code blocks should include only things like:
- qtversion=[spec] - for explicitly definition of the Qt version used, default is last stable
- nolink - to inhibit auto-linking
I had already started to implement it, but I'm a java|script beginner (albeit highly motivated ;))
-
I heard a similar suggestion for bug reports. I wonder though, if all the linking won't confuse people or make the posting itself hard to read. I am all for connecting the forum, the wiki and the documentation as seamlessly as possible.
What do you think about auto-tagging instead of auto-linking? It's an extra step, that's for sure, but one would get related content alongside with the documentation.
-
If the doc links could be made to not have the [domain], I don't think they would make postings hard to read.
I think tagging and linking serve different purposes. Tagging is useful for finding related posts in the forums. Docs linking is useful for quickly accessing references relevant to the discussion.
-
[quote author="Alexandra Leisse" date="1292004911"]I wonder though, if all the linking won't confuse people or make the posting itself hard to read.[/quote]Which is why the auto linking or doc linking should not contain the [domain] thingy. In any case, you can have a look at the QtCentre forum. Linking to Qt docs is very simple and doesn't really interfere with the message. Inside code tags auto-linking is enabled, which really isn't a pain in the butt either.
-
Indeed - the other thing worth mentioning there is that it would be nice to have easy wiki links - perhaps using "wiki://"? :)
-
[quote author="Alexandra Leisse" date="1292004911"] What do you think about auto-tagging instead of auto-linking?[/quote] What is auto-tagging? If it means that some tags are added automatically, I think this is a bad idea in most cases. Maybe some forum-specific tags (such as beta, wiki, devnet) could still be useful.
-
[quote author="Wolf P." date="1292093709"][quote author="Alexandra Leisse" date="1292004911"] What do you think about auto-tagging instead of auto-linking?[/quote] What is auto-tagging? If it means that some tags are added automatically, I think this is a bad idea in most cases. Maybe some forum-specific tags (such as beta, wiki, devnet) could still be useful.
[/quote]
If auto-tagging is like that, it won't provide quick access to the docs.
-
Auto-tagging could be useful, but 1) I agree with Bradley that it's quite a different question from auto-linking, and 2) I would be a little surprised if it could be done very well, until we have a script which can parse English well. Hmm...
Actually, I take that back. If the tagging system were set up to feed the posts through "CRM114":http://crm114.sourceforge.net, I bet it actually could do a decent job of auto-tagging!
-
I totally agree with bradley. Auto-linking of the Qt classes would be very handy. Without the [doc.qt.nokia.com] it's also easily readable.
I also support the other suggestion, that all links within the .nokia.com domain need no further hint.
Auto tagging would be a bit overdone, IMHO. That would add a qapplication and/or qstring tag to almost every post with some example code.