User:Skierpage: Difference between revisions

From KDE TechBase
(new section about source browsing confusion)
Line 70: Line 70:
* I pulled in [[Template:Tl]] from Wikipedia, so that instead of fiddling with <nowiki>{{</nowiki> you can use e.g. {{tl|bug}} to generate a nicely-formatted <nowiki>{{</nowiki>[[Template:bug|bug]]}} which is also a link to a template.
* I pulled in [[Template:Tl]] from Wikipedia, so that instead of fiddling with <nowiki>{{</nowiki> you can use e.g. {{tl|bug}} to generate a nicely-formatted <nowiki>{{</nowiki>[[Template:bug|bug]]}} which is also a link to a template.
* I revived a "Browsing the code" section in [[Getting_Started#Browsing_the_code|Getting Started]], it's critical!  Someone deleted the old "Getting the source" section.
* I revived a "Browsing the code" section in [[Getting_Started#Browsing_the_code|Getting Started]], it's critical!  Someone deleted the old "Getting the source" section.
== Searching and browsing source ==
I brought back [[Getting Started#Browsing the code]] but the situation is confusing.
There are three systems that let you browse and search source code:
; http://projects.kde.org
: The git repositories, most KDE source code is in Git these days.
; http://api.kde.org
: API docs generated from the source code, but you can also scroll down and click to view the source code
; http://lxr.kde.org
: Cross-reference to files and names in the KDE source code.
But they give different results.  Try searching for the class StrigiIndexWriter in 4.x ("the trunk"?) in each, or equivalently the file nepomukindexwriter.cpp
* [http://api.kde.org/mapsearcher.php?class=StrigiIndexWriter&module=ALL&version=4.x api.kde.org] finds the class in nepomukindexwriter.cpp in three different places!
*: [http://api.kde.org/4.x-api/kde-runtime-apidocs/nepomuk/html/classNepomuk_1_1StrigiIndexWriter.html StrigiIndexWriter] in module kde-runtime-4.x, project nepomuk<br />[http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk_1_1StrigiIndexWriter.html StrigiIndexWriter] in module kdelibs-4.x, project nepomuk-core<br />[http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/libnepomukcore/html/classNepomuk_1_1StrigiIndexWriter.html StrigiIndexWriter] in module kdelibs-4.x, project nepomuk-core(/libnepomukcore)
* [http://lxr.kde.org/search?string=StrigiIndexWriter lxr.kde.org] finds the class in two different places, but with a completely different path:
*: [http://lxr.kde.org/source/kde/kdelibs/nepomuk-core/services/fileindexer/indexer/nepomukindexwriter.cpp in kdelibs/nepomuk-core in the directory services/fileindexer/indexer/]<br />[http://lxr.kde.org/source/kde/kde-runtime/nepomuk/services/fileindexer/indexer/nepomukindexwriter.cpp in kde-runtime/nepomuk in the same directory subtree]<br />
*  Can't search for either in https://projects.kde.org/projects/kde/ or its subdirectories kdelibs and kdelibs/nepomuk-core.  You can eventually browse to [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core/repository/revisions/master/entry/services/fileindexer/indexer/nepomukindexwriter.cpp services / fileindexer / indexer / nepomukindexwriter.cpp] . This path in Git bears no relation to the path in api but matches the path in  lxr. And projects and lxr agree on the file contents.
BUG: Ideally api.kde.org would generate a link to the actual file in Git.

Revision as of 00:57, 15 November 2011

I first used Projects/KDE_on_Windows but now run Kubuntu as my main operating system. I wrote an occasional journal of my adventures in getting Kubuntu working at userbase.kde.org user page

I mostly do documentation and support for Semantic MediaWiki, an extension to MediaWiki.

Techbase problems and what I'm going to do about them

2011-11-14: I'm frustrated as hell trying to figure out a problem with KDE (Strigi not indexing my stuff), and TechBase is not helping.

Some wiki woes also apply to userbase.

Service page problems

The Nepomuk blog's Documentation page has a Strigi Service link that goes to Development/Tutorials/Metadata/Nepomuk/StrigiService unfortunately this suffers from the same problems as the blog's Documentation page

  • BUG: doesn't say where the source is
  • BUG: doesn't say where the API is
  • BUG: doesn't say what the service looks like. Is it a process I can look at? What's the process name?
  • TODO: techbase needs to have {{source}}, {{api}}, {{processname}} templates for creating links to these, and should have a series of form template that presents this sort of information about a project in an infobox:
 {{service| source= | api= | processname= | bugtracker= | kdemodule= | blog= }}

Too many wikis!

TODO: the split between userbase and techbase is dubious. I'm a user, but I want to go beyond the user documentation. You're just going to duplicate information like the processname, the blog, the bug tracker and the kdemodule in two wikis.

And it turns out there's a third wiki, http://community.kde.org. <rant>That is completely f***ing ridiculous.</rant> Three times the infrastructure to maintain (Help pages, templates, interwiki links, common images, vandal patrolling), three copies of all these bugs, and for what? Users are three times more likely to look in the wrong wiki.

Techbase minor bugs

BUG: Template:Info is undocumented! Use <noinclude> </noinclude> to document what templates do!

BUG: Help:Contents says to use

 <span class="bsBugLink bsError bsError-NoConnection">{{bug|123456}}</span>

surely this HTML formatting junk should be part of a template, i.e. Template:Formatted bug

BUG: Template:Template has a silly confusing warning "If this page is not already in the "Template" namespace, it should probably be migrated to that location."

Instead, someone should just periodically look at Special:WhatLinksHere/Template:Template and see if pages outside Category:Template are using it.

techbase interwiki issues

interwiki prefixes] let you link between wikis. But the interwiki prefixes on techbase have some problems:

  • There is a bug prefix, e.g., but why is it language="ᨅᨔ ᨕᨘᨁᨗ" attribute? Maybe that's why on userbase this doesn't do anything?
  • Why is there an empty bugs prefix, e.g.1234 ?
  • techbase and userbase have different interwiki maps, e.g. techbase has no wikipedia prefix, but userbase does e.g. wikipedia:Git; userbase has [[mediawikiwiki:, etc.!

Stylistic issues

  • Don't capitalize each word in titles and section headings. It Makes the Wiki Look Imperious and Official, it conflicts with the default heading style (See the Toolbox links) and it makes linking to pages in the flow text flow unnatural to read. Compare

Layout issues

I think all these bugs are in the Chihuahua skin, and they all apply to userbase.kde.org as well.

BUG: In three-column listings like , the techbase wiki skin makes the listing overlap the right-hand "Share your Knowledge" column.

BUG: In revision history the

Revision as of 21:55, 20 May 2009 by JRT (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

crashes into the light header with [View the content page] [Discussion about the content page] icons.

BUG: justified text looks bad in a narrow window. Allow ragged right column

BUG: when you select, the highlight color makes highlighted text look identical to a link. Try it, select this text and link Schedules and this text. You can't tell!

MAYBE: pre text just goes on and on off the right side. Consider using the wrap attribute of pre so that stuff wraps.

TechBase problems fixed!

  • I fixed Template:Template to explain what it does.
  • I pulled in Template:Tl from Wikipedia, so that instead of fiddling with {{ you can use e.g. {{bug}} to generate a nicely-formatted {{bug}} which is also a link to a template.
  • I revived a "Browsing the code" section in Getting Started, it's critical! Someone deleted the old "Getting the source" section.

Searching and browsing source

I brought back Getting Started#Browsing the code but the situation is confusing. There are three systems that let you browse and search source code:

http://projects.kde.org
The git repositories, most KDE source code is in Git these days.
http://api.kde.org
API docs generated from the source code, but you can also scroll down and click to view the source code
http://lxr.kde.org
Cross-reference to files and names in the KDE source code.

But they give different results. Try searching for the class StrigiIndexWriter in 4.x ("the trunk"?) in each, or equivalently the file nepomukindexwriter.cpp

BUG: Ideally api.kde.org would generate a link to the actual file in Git.