Help:Howto - Revision history

Tierlieb: /* Templates */ better example values

2014-08-28T12:35:00Z

Templates: better example values

← Older revision		Revision as of 12:35, 28 August 2014
Line 77:		Line 77:
	* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki> - can also use several versions, separated by space, dash and space.		* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki> - can also use several versions, separated by space, dash and space.
	* The version, used for pages with information that becomes valid for a specific version: <nowiki>{{VersionFrom\|7.4.0}}</nowiki>		* The version, used for pages with information that becomes valid for a specific version: <nowiki>{{VersionFrom\|7.4.0}}</nowiki>
	* The version, used for pages with information for works only for a range of versions: <nowiki>{{VersionFromTo\|7.4.0}}</nowiki>		* The version, used for pages with information for works only for a range of versions: <nowiki>{{VersionFromTo\|7.4.0 - 7.4.2}}</nowiki>
	* The version, used for pages with information for works until a specific version: <nowiki>{{VersionTo\|7.4.0}}</nowiki>		* The version, used for pages with information for works until a specific version: <nowiki>{{VersionTo\|7.4.2}}</nowiki>

	=== Author information ===		=== Author information ===

Tierlieb: /* Templates */

2014-02-04T15:25:42Z

Templates

← Older revision		Revision as of 15:25, 4 February 2014
Line 77:		Line 77:
	* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki> - can also use several versions, separated by space, dash and space.		* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki> - can also use several versions, separated by space, dash and space.
	* The version, used for pages with information that becomes valid for a specific version: <nowiki>{{VersionFrom\|7.4.0}}</nowiki>		* The version, used for pages with information that becomes valid for a specific version: <nowiki>{{VersionFrom\|7.4.0}}</nowiki>
	* The version, used for pages with information for works only for a range of versions : <nowiki>{{VersionFromTo\|7.4.0}}</nowiki>		* The version, used for pages with information for works only for a range of versions: <nowiki>{{VersionFromTo\|7.4.0}}</nowiki>
			* The version, used for pages with information for works until a specific version: <nowiki>{{VersionTo\|7.4.0}}</nowiki>

	=== Author information ===		=== Author information ===

Tierlieb at 15:23, 4 February 2014

2014-02-04T15:23:51Z

← Older revision		Revision as of 15:23, 4 February 2014
Line 13:		Line 13:

	=== Writing ===		=== Writing ===
			{{a\|writing}}
	There are tons of articles on writing technical documentation (see below for links). Here is a condensed version:		There are tons of articles on writing technical documentation (see below for links). Here is a condensed version:

Line 21:		Line 21:

	=== Namespace ===		=== Namespace ===
			{{a\|namespace}}
	AppSuite-specific articles go into the AppSuite:* namespace. That means you simply prefix the page title with AppSuite:, that's all. The tricky part is knowing whether the article is AppSuite-specific. This is obvious for UI articles. But for server articles, it is not that clear-cut, as the backend is usually backwards-compatible with OX6. When in doubt, put it in the main namespace (that is the one without any prefix).		AppSuite-specific articles go into the AppSuite:* namespace. That means you simply prefix the page title with AppSuite:, that's all. The tricky part is knowing whether the article is AppSuite-specific. This is obvious for UI articles. But for server articles, it is not that clear-cut, as the backend is usually backwards-compatible with OX6. When in doubt, put it in the main namespace (that is the one without any prefix).

	=== Layout ===		=== Layout ===
			{{a\|layout}}
	Due to some php magic, our skin does not show the article title. The benefit is that you are not bound by the restrictions of article titles on MediaWiki. To put up a <nowiki><div class="title">Title of the article</div></nowiki> element on top.		Due to some php magic, our skin does not show the article title. The benefit is that you are not bound by the restrictions of article titles on MediaWiki. To put up a <nowiki><div class="title">Title of the article</div></nowiki> element on top.

Line 31:		Line 31:

	Write an intro sentence that gives the user a rough overview of what the article covers.		Write an intro sentence that gives the user a rough overview of what the article covers.



	=== Categories ===		=== Categories ===
			{{a\|categories}}
	You are free to invent new categories. The following ones are just a fraction of all categories this wiki contains, but they are those we would like to see used more widely. We propagate these by linking them from the main page so they get a lot of visibility. If you want your hard work to be found, use them:		You are free to invent new categories. The following ones are just a fraction of all categories this wiki contains, but they are those we would like to see used more widely. We propagate these by linking them from the main page so they get a lot of visibility. If you want your hard work to be found, use them:

Line 59:		Line 57:

	=== Numbering and versioning ===		=== Numbering and versioning ===
			{{a\|versioning}}
	As opposed to normal wikis, it is not just the current version of an article that interests a user: Documentation for an older version of the product might be needed, too. The way we handle this might seem familiar to linux users:		As opposed to normal wikis, it is not just the current version of an article that interests a user: Documentation for an older version of the product might be needed, too. The way we handle this might seem familiar to linux users:

Line 73:		Line 71:

	=== Templates ===		=== Templates ===
			{{a\|template}}
	Templates make recurring tasks easier. The following templates are used regularly within the OXpedia:		Templates make recurring tasks easier. The following templates are used regularly within the OXpedia:

Line 94:		Line 92:

	== Hints for Mediawiki ==		== Hints for Mediawiki ==
			{{a\|hints}}
	This is a media wiki... even if our great design is trying to fool you into thinking otherwise. So all Mediawiki[http://meta.wikimedia.org] tricks apply here, too.		This is a media wiki... even if our great design is trying to fool you into thinking otherwise. So all Mediawiki[http://meta.wikimedia.org] tricks apply here, too.

Line 103:		Line 102:

	=== Exceptions ===		=== Exceptions ===
			{{a\|exceptions}}
	Because we do a lot of code descriptions, we tuned that part of MediaWiki. Probably beyond all recognition. So here are some details:		Because we do a lot of code descriptions, we tuned that part of MediaWiki. Probably beyond all recognition. So here are some details:
	* <nowiki><code></nowiki> does nothing unless you feed it with language information, then it does code-highlighting		* <nowiki><code></nowiki> does nothing unless you feed it with language information, then it does code-highlighting
Line 110:		Line 110:

	== Who we are ==		== Who we are ==
			{{a\|contact}}
	We are the OXpedia team. You can reach us via oxpedia@open-xchange.com		We are the OXpedia team. You can reach us via oxpedia@open-xchange.com

	[[Category: Meta]]		[[Category: Meta]]

Tierlieb: /* Author information */

2014-02-04T15:22:32Z

Author information

← Older revision		Revision as of 15:22, 4 February 2014
Line 82:		Line 82:

	=== Author information ===		=== Author information ===
			{{a\|author}}
	* Every user should feel free to improve any wiki article		* Every user should feel free to improve any wiki article
	* The person primarily responsible for the article is its author		* The person primarily responsible for the article is its author
Line 88:		Line 88:
	* Mark yourself as the author of a page by putting in a commented section (invisible when not editing) at the top of a page like this:		* Mark yourself as the author of a page by putting in a commented section (invisible when not editing) at the top of a page like this:
	<pre><!-- Author: Karsten Will <karsten.will@open-xchange.com> --></pre>		<pre><!-- Author: Karsten Will <karsten.will@open-xchange.com> --></pre>

			=== Linking to headers and page sections ===
			{{a\|linking}}
			You may have noticed that Mediawiki automatically creates IDs for every page heading. The table of contents uses that so you can jump to the relevant section. The problem is that the ID is based on the title of that section. Which tends to get changed. We recommend not to use those IDs as anchors, as this is prone to breaking when the title is changed (remember the "cool URIs don't change" message from the W3C a decade ago? This is similar). Instead, go the extra mile and create your own anchor. How do you do this? With a [[#template]] of course! Simple put <nowiki>{{a\|my_anchor}}</nowiki> in your article.

	== Hints for Mediawiki ==		== Hints for Mediawiki ==

Tierlieb: /* Templates */

2013-12-11T13:08:59Z

Templates

← Older revision		Revision as of 13:08, 11 December 2013
Line 77:		Line 77:

	* The [[API status\|level of stability]] a described feature has: <nowiki>{{Stability-unstable}}, {{Stability-stable}}, {{Stability-frozen}} and {{Stability-deprecated}}</nowiki>		* The [[API status\|level of stability]] a described feature has: <nowiki>{{Stability-unstable}}, {{Stability-stable}}, {{Stability-frozen}} and {{Stability-deprecated}}</nowiki>
	* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki>		* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki> - can also use several versions, separated by space, dash and space.
			* The version, used for pages with information that becomes valid for a specific version: <nowiki>{{VersionFrom\|7.4.0}}</nowiki>
			* The version, used for pages with information for works only for a range of versions : <nowiki>{{VersionFromTo\|7.4.0}}</nowiki>

	=== Author information ===		=== Author information ===

Tierlieb: /* Exceptions */

2013-12-11T12:55:25Z

Exceptions

← Older revision		Revision as of 12:55, 11 December 2013
Line 98:		Line 98:
	=== Exceptions ===		=== Exceptions ===
	Because we do a lot of code descriptions, we tuned that part of MediaWiki. Probably beyond all recognition. So here are some details:		Because we do a lot of code descriptions, we tuned that part of MediaWiki. Probably beyond all recognition. So here are some details:
	* <nowiki><code></nowiki> does nothing unless you feed it with language information		* <nowiki><code></nowiki> does nothing unless you feed it with language information, then it does code-highlighting
	* <nowiki><nowiki></nowiki> stops other markup from being recognised		* <nowiki><nowiki></nowiki> stops other markup from being recognised
	* <nowiki><tt></nowiki> does fixed width characters		* <nowiki><tt></nowiki> does fixed width characters

Tierlieb: /* Hints for Mediawiki */

2013-12-11T12:54:57Z

Hints for Mediawiki

← Older revision		Revision as of 12:54, 11 December 2013
Line 95:		Line 95:
	* [http://en.wikipedia.org/wiki/Wikipedia:Guide_to_layout Wikipedia's guide to layout]		* [http://en.wikipedia.org/wiki/Wikipedia:Guide_to_layout Wikipedia's guide to layout]
	* [http://w-i-k-i.appspot.com/ Converter for HTML to MediaWiki]		* [http://w-i-k-i.appspot.com/ Converter for HTML to MediaWiki]

			=== Exceptions ===
			Because we do a lot of code descriptions, we tuned that part of MediaWiki. Probably beyond all recognition. So here are some details:
			* <nowiki><code></nowiki> does nothing unless you feed it with language information
			* <nowiki><nowiki></nowiki> stops other markup from being recognised
			* <nowiki><tt></nowiki> does fixed width characters
			* <nowiki><pre></nowiki> does fixed width characters and honours whitespaces

	== Who we are ==		== Who we are ==

Karsten.will: /* Author information */

2013-11-21T09:28:02Z

Author information

← Older revision		Revision as of 09:28, 21 November 2013
Line 83:		Line 83:
	* Every user should feel free to improve any wiki article		* Every user should feel free to improve any wiki article
	* The person primarily responsible for the article is its author		* The person primarily responsible for the article is its author
	* The author of an ~~articke~~ should be identifiable by editing a page and looking at the top		* The author of an article should be identifiable by editing a page and looking at the top
	* Mark yourself as the author of a page by putting in a commented section (invisible when not editing) at the top of a page like this:		* Mark yourself as the author of a page by putting in a commented section (invisible when not editing) at the top of a page like this:
	<pre><!-- Author: Karsten Will <karsten.will@open-xchange.com> --></pre>		<pre><!-- Author: Karsten Will <karsten.will@open-xchange.com> --></pre>

Karsten.will: /* Author information */

2013-11-21T09:27:53Z

Author information

← Older revision		Revision as of 09:27, 21 November 2013
Line 83:		Line 83:
	* Every user should feel free to improve any wiki article		* Every user should feel free to improve any wiki article
	* The person primarily responsible for the article is its author		* The person primarily responsible for the article is its author
	* The author should be identifiable by editing a page and looking at the top		* The author of an articke should be identifiable by editing a page and looking at the top
	* Mark yourself as the author of a page by putting in a commented section (invisible when not editing) at the top of a page like this:		* Mark yourself as the author of a page by putting in a commented section (invisible when not editing) at the top of a page like this:
	<pre><!-- Author: Karsten Will <karsten.will@open-xchange.com> --></pre>		<pre><!-- Author: Karsten Will <karsten.will@open-xchange.com> --></pre>

Karsten.will: /* Author information */

2013-11-21T09:27:13Z

Author information

← Older revision		Revision as of 09:27, 21 November 2013
Line 86:		Line 86:
	* Mark yourself as the author of a page by putting in a commented section (invisible when not editing) at the top of a page like this:		* Mark yourself as the author of a page by putting in a commented section (invisible when not editing) at the top of a page like this:
	<pre><!-- Author: Karsten Will <karsten.will@open-xchange.com> --></pre>		<pre><!-- Author: Karsten Will <karsten.will@open-xchange.com> --></pre>
	~~{{Version\|7.x.x}}~~

	== Hints for Mediawiki ==		== Hints for Mediawiki ==

← Older revision		Revision as of 12:35, 28 August 2014
Line 77:		Line 77:
	* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki> - can also use several versions, separated by space, dash and space.		* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki> - can also use several versions, separated by space, dash and space.
	* The version, used for pages with information that becomes valid for a specific version: <nowiki>{{VersionFrom\|7.4.0}}</nowiki>		* The version, used for pages with information that becomes valid for a specific version: <nowiki>{{VersionFrom\|7.4.0}}</nowiki>
	* The version, used for pages with information for works only for a range of versions: <nowiki>{{VersionFromTo\|7.4.0}}</nowiki>		* The version, used for pages with information for works only for a range of versions: <nowiki>{{VersionFromTo\|7.4.0 - 7.4.2}}</nowiki>
	* The version, used for pages with information for works until a specific version: <nowiki>{{VersionTo\|7.4.0}}</nowiki>		* The version, used for pages with information for works until a specific version: <nowiki>{{VersionTo\|7.4.2}}</nowiki>

	=== Author information ===		=== Author information ===

← Older revision		Revision as of 15:25, 4 February 2014
Line 77:		Line 77:
	* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki> - can also use several versions, separated by space, dash and space.		* The version, used for pages with information for a specific version: <nowiki>{{Version\|7.4.0}}</nowiki> - can also use several versions, separated by space, dash and space.
	* The version, used for pages with information that becomes valid for a specific version: <nowiki>{{VersionFrom\|7.4.0}}</nowiki>		* The version, used for pages with information that becomes valid for a specific version: <nowiki>{{VersionFrom\|7.4.0}}</nowiki>
	* The version, used for pages with information for works only for a range of versions : <nowiki>{{VersionFromTo\|7.4.0}}</nowiki>		* The version, used for pages with information for works only for a range of versions: <nowiki>{{VersionFromTo\|7.4.0}}</nowiki>
			* The version, used for pages with information for works until a specific version: <nowiki>{{VersionTo\|7.4.0}}</nowiki>

	=== Author information ===		=== Author information ===