|
|
| (21 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| todo: integrate (+ validate for kde4) those pages into sane locations ;)
| | == Kate in KDE5 == |
| * Common Programming Mistakes
| |
| : hey, the first one we have not ported yet. should be moved for kde4 into [[Development/Tutorials]] (TODO)
| |
| :: Thinking more about it, it could be an extension of [[Policies/Library_Code_Policy]], i.e. as subpage like [[Policies/Library_Code_Policy/Common Mistakes]] (although it's not only about libraries...)
| |
| * KDE Developer's Checklist
| |
| : look svery old. if migrated, please fix it for kde3 or even kde4 (TODO)
| |
| * What is Scripty?
| |
| : indeed a TODO :)
| |
|
| |
|
| see: http://developer.kde.org/documentation/other/index.html
| | Use Okular / [https://projects.kde.org/projects/extragear/multimedia/amarok/repository/revisions/master/annotate/src/widgets/Osd.h Amarok's] passive popup class to display things like "13 replacements done" or "Document successfully loaded". The needed class is PageViewMessage in the files [https://projects.kde.org/projects/kde/kdegraphics/okular/repository/revisions/master/entry/ui/pageviewutils.cpp pageviewutils.cpp] and [https://projects.kde.org/projects/kde/kdegraphics/okular/repository/revisions/master/entry/ui/pageviewutils.h pageview.h]. Maybe it is a good idea to alter the function slightly from |
| | void display( const QString & message, const QString & details = QString(), Icon icon = Info, int durationMs = 4000 ); |
| | to |
| | void display( const QString & message, const QString & details = QString(), Icon icon = Info, Qt::Corner corner = Qt::TopLeft, durationMs = 4000 ); |
|
| |
|
| ---- | | Maybe [http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKPassivePopup.html KPassivePopup] works, too. It can show arbitrary widgets as content. But it's more ugly. |
| = Contribute to KDE TechBase =
| |
|
| |
|
| You are welcome to contribute to the KDE TechBase wiki. In order to keep a high quality of the articles there are some guidelines you should follow.
| | == Kate Cleanups == |
| | KateDocManager derives from QStandardItemModel. Since the view is a plugin now, this should be converted back to a simple list. |
|
| |
|
| == What Content belongs into KDE TechBase == | | == TODO == |
| | * Excellent Articles |
| | * Featured Articles |
| | * http://de.wikipedia.org/wiki/Wikipedia:Wie_schreibe_ich_gute_Artikel |
| | * http://en.wikipedia.org/wiki/Wikipedia:Writing_better_articles |
| | * http://de.wikipedia.org/wiki/Wikipedia:Exzellente_Artikel |
| | * http://en.wikipedia.org/wiki/Wikipedia:Featured_articles |
| | * http://en.wikibooks.org/wiki/MediaWiki_Administrator%27s_Handbook/Editing_in_the_MediaWiki_Namespace |
|
| |
|
| The KDE TechBase wiki is meant to contain technical information all around KDE, for instance
| | == attic == |
| * Developer Information (e.g. [[Development/Tutorials|tutorials]])
| | [[/Compiling KDE4|Setup a KDE4 development environment]] |
| * documentation for [[SysAdmin|System Administrator]]
| |
| * etc.
| |
| | |
| More details can be found in the article '[[Help:Wiki Structure]]'. [http://docs.kde.org End-user documentation] or [http://api.kde.org API documentation] should ''not'' be added here.
| |
| | |
| == Where to put new Articles ==
| |
| | |
| The KDE TechBase wiki uses subpages. Take a quick look at the article about the [[Help:Wiki Structure]]. In short: Do not randomly add toplevel pages.
| |
| | |
| It is possible to translate KDE TechBase articles into other languages. Read the article about Translation for further details.
| |
| | |
| == The Procedure ==
| |
| | |
| You want to add new content. To keep high quality, please create the article in your userpage first (e.g. User:foo/My Acticle). Once it is ready, discuss the article with other developers and proof-read it. Finally, if a location is found, move the page.
| |
| | |
| ----
| |
| | |
| = Translation into other Languages = | |
| | |
| It is possible to translate articles into other languages. The reference language should be the english version.
| |
| | |
| == Step 1: Language Abbreviations ==
| |
| | |
| As an example let us assume you want to translate the following page to german:
| |
| * [[Development/Tutorials]]
| |
| The language abbreviation for german is '''de''', thus, all articles will have the ending " (de)" (with a leading space).
| |
| | |
| Reference: [http://www.opticentre.net/FAQ/Languages/List-of-language-abbreviations/ list of language abbreviations].
| |
| | |
| == Step 2: Create the Article ==
| |
| | |
| Sometimes a link in the language navigation bar already exists. In that case, simply click on the link you want to translate. If no, create the article manually:
| |
| * [[Development/Tutorials (de)]]
| |
| As initial content simply use the content of the corresponding english page.
| |
| | |
| == Step 3: Language Navigation Bar ==
| |
| | |
| The article must contain the following template line in order to show the language navigation bar:
| |
| * <nowiki>{{Template:I18n/Language Navigation Bar|Development/Tutorials}}</nowiki>
| |
| This magic line expands to the language navigation bar for the article <tt>Development/Tutorials</tt>.
| |
| | |
| == Step 4: Language Missing? ==
| |
| | |
| If the language is missing, please search for the right abbreviation (see Step 1). In the example above this abbreviation is " (de)".
| |
| | |
| Edit [[Template:I18n/Language Navigation Bar]] and add a line for the language you want to translate:
| |
| <nowiki><span lang="de">[[{{{1}}}_(de)|Deutsch]]</span></nowiki>
| |
| Replace 'de' by the language abbreviation and adapt the visible name.
| |
| | |
| == Important Notes ==
| |
| | |
| As the wiki uses [[Help:Wiki Structure|subpages]] it is likely that translators run into the following issue.
| |
| | |
| Assume the following pages exist:
| |
| 1. Development/Tutorials
| |
| 2. Development/Tutorials/Debugging
| |
| Further assume you want to translate (1) to german (postfix ''de'').
| |
| | |
| The final page will be
| |
| 3. Development/Tutorials_(de)
| |
| The english content of (2) uses relative wiki links like <tt>/Debugging</tt>. Translating ''Debugging'' in (3) might result in
| |
| Development/Tutorials_(de)/Debugging # or
| |
| Development/Tutorials_(de)/Debugging_(de)
| |
| '''This is wrong.'''
| |
| | |
| The '''right link''' is supposed to be
| |
| Development/Tutorials/Debugging_(de)
| |
| So be sure you adapt the links in the article to use absolute paths everywhere (i.e. no leading slash '/' in the wiki links).
| |
Kate in KDE5
Use Okular / Amarok's passive popup class to display things like "13 replacements done" or "Document successfully loaded". The needed class is PageViewMessage in the files pageviewutils.cpp and pageview.h. Maybe it is a good idea to alter the function slightly from
void display( const QString & message, const QString & details = QString(), Icon icon = Info, int durationMs = 4000 );
to
void display( const QString & message, const QString & details = QString(), Icon icon = Info, Qt::Corner corner = Qt::TopLeft, durationMs = 4000 );
Maybe KPassivePopup works, too. It can show arbitrary widgets as content. But it's more ugly.
Kate Cleanups
KateDocManager derives from QStandardItemModel. Since the view is a plugin now, this should be converted back to a simple list.
TODO
attic
Setup a KDE4 development environment
