TDE Wiki Style Guideline - Revision history

Blu256: /* Code */ add mention of TDE class template

2023-12-18T10:26:09Z

Code: add mention of TDE class template

Blu256: /* Code */ Make specific class cases child to generic class instruction

2022-03-04T17:06:59Z

Code: Make specific class cases child to generic class instruction

Blu256: Comment out "non-Trinity" while we have no better alternative for Trinity classes

2022-03-04T17:06:13Z

Comment out "non-Trinity" while we have no better alternative for Trinity classes

Blu256: /* Code */ added note about TQt classes template

2022-03-03T20:08:18Z

Code: added note about TQt classes template

Blu256: Get rid of "Be..." strings, per suggestion of User:Msi

2022-02-28T22:01:08Z

Get rid of "Be..." strings, per suggestion of User:Msi

Blu256: Added section about tables

2022-02-15T14:02:37Z

Added section about tables

Blu256: Initial version

2022-02-15T13:59:24Z

Initial version

New page

{{TipBox|title=Work in progress!|text=This document is a work-in-progress, you can help by discussing it on the [http://mail.trinitydesktop.org/mailman3/postorius/lists/users.trinitydesktop.org/ tde-users mailing list], the [[Talk:TDE Wiki Style Guideline|discussion page]], via Jabber/XMPP or [http://trinitydesktop.org/support.php IRC].}}

<div style="float: right">
__TOC__
</div>

This page is meant to provide a single guideline for styling pages on this Wiki.

The goal is to achieve consistency between pages as much as possible.

= Generic guidelines =

''' Be <span style="color: red">semantic</span>. '''
Use visual styles to make it easier tell apart different kinds of information.

''' Be <span style="color: green">consistent</span>. '''
Try to be consistent with how other pages look and the way they use styles and templates to achieve things.

''' Be <span style="color: blue">smart</span>. '''
Create templates for things that can be reused on the wiki. Re-use [[Special:UncategorizedTemplates|existing templates]] as much as possible.

= Style Recommendations =

== Code ==


* To denote a non-Trinity class use the <code><nowiki><tt>...</tt></nowiki></code> tag.
* To denote a function signature or a function call use the <code><nowiki><code>...</code></nowiki></code> tag.
* To denote a source code block use <code><nowiki><syntaxhighlighting lang="...">...</syntaxhighlighting></nowiki></code> tag with the appropriate <code>lang</code> attribute.
** To denote commands to be run in a shell use the <code>shell-session</code>. Prepend the commands with the <tt>$</tt> sign for commands to be run with normal user privileges or <tt>#</tt> for commands to be run with root privileges.

== Files ==

* To denote a file, a directory or a path, use the <code><nowiki><tt>...</tt></nowiki></code> tag.
* To denote the (whole or partial) contents of a file use a space before each line '''unless''' it contains [[#Code|code]].

== Messages and boxes ==

=== Warnings ===

* If a page or section is unfinished, place [[:Template:TODO]] in the beginning of the page or section.
* If a page or section is being actively worked on, and only for that time span, you may use [[:Template:WIP]] to prevent other users from accidentally causing a save conflict.
* If a page or section contains outdated information, place [[:Template:Outdated]] inserting the appropriate date and justifying it.
** If a page or section contains information relevant to KDE3, use [[:Template:KDE3]] instead. When such a page is updated to be applicable to the Trinity Desktop, replace it with [[:Template:Applicable to TDE]].
* Denote spam pages with [[:Template:Spam]].
* For generic warnings use [[:Template:WarningBox]] with the appropriate arguments.
** The opposite template to <tt>WarningBox</tt> is [[:Template:SafeBox]].

=== Other boxes ===
* For generic type messages (notes, tips, etc.) use [[:Template:TipBox]].
* Avoid using [[:Template:Box]] directly if you can help it. If you really need to use it, consider proposing a new template.

@@ Line 21: / Line 21: @@
 == Code ==
-* To denote a <!-- non-Trinity --> class use the <code><nowiki><tt>...</tt></nowiki></code> tag.
+* To denote a non-Trinity class use the <code><nowiki><tt>...</tt></nowiki></code> tag.
 ** To denote a TQt class use [[:Template:TQt class]].
+** To denote a TDE class use [[:Template:TDE class]].
 <!-- TODO: ** To denote a Trinity class use the special template. -->
 * To denote a function signature or a function call use the <code><nowiki><code>...</code></nowiki></code> tag.

@@ Line 21: / Line 21: @@
 == Code ==
-* To denote a TQt class use [[:Template:TQt class]].
-<!-- TODO: * To denote a Trinity class use the special template. -->
 * To denote a <!-- non-Trinity --> class use the <code><nowiki><tt>...</tt></nowiki></code> tag.
+** To denote a TQt class use [[:Template:TQt class]].
+<!-- TODO: ** To denote a Trinity class use the special template. -->
 * To denote a function signature or a function call use the <code><nowiki><code>...</code></nowiki></code> tag.
 * To denote a source code block use <code><nowiki><syntaxhighlighting lang="...">...</syntaxhighlighting></nowiki></code> tag with the appropriate <code>lang</code> attribute.

@@ Line 36: / Line 36: @@
 * To denote a file, a directory or a path, use the <code><nowiki><tt>...</tt></nowiki></code> tag.
 * To denote the (whole or partial) contents of a file use a space before each line '''unless''' it contains [[#Code|code]].
+== Tables ==
+* To make tables look better and be more readable, add <code>class="wikitable"</code> to your tables.
+* Make sure tables don't stretch too much vertically or horizontally.
 == Messages and boxes ==

@@ Line 12: / Line 12: @@
 = Generic guidelines =
+* Use visual styles to make it easier tell apart different kinds of information.
-''' Be <span style="color: red">semantic</span>. '''
+* Try to be consistent with how other pages look and the way they use styles and templates to achieve things.
-Use visual styles to make it easier tell apart different kinds of information.
+* Create templates for things that can be reused on the wiki. Re-use [[Special:UncategorizedTemplates|existing templates]] as much as possible.
-''' Be <span style="color: green">consistent</span>. '''
-Try to be consistent with how other pages look and the way they use styles and templates to achieve things.
-''' Be <span style="color: blue">smart</span>. '''
-Create templates for things that can be reused on the wiki. Re-use [[Special:UncategorizedTemplates|existing templates]] as much as possible.