Difference between revisions of "User:ES"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Ok?)
(first feature test)
Line 1: Line 1:
−
Just a test
+
== Supported Features ==
 +
The following section describe the formatting and contents features supported by the MediaWiki export filter.
 +
 
 +
(Note: starting from this point, this document can be used as test document in a test case specification)
 +
 
 +
=== Headings ===
 +
While headings can be thoroughly formatted in OpenDocument, their format is defined by the style applied by the wiki engine. During export to MediaWiki format, '''style information of headings is lost and the default heading style is applied by the Wiki engine'''. The headings of this document serve as example for the transformation of headings.
 +
 
 +
=== Hyperlinks ===
 +
Native OpenDocument hyperlinks are transformed into “external” Wiki links during the transformation. Therefore, the built-in linking facility of OpenDocument should only be used, when generating links pointing to other sites outside the Wiki web. For generating Wiki links that point to other subjects of the same Wiki domain (e.g. [http://en.wikipedia.org/wiki/Main_Page Wikipedia]), use wiki links explained below.
 +
 
 +
=== Lists ===
 +
To have lists reliably exported, you must make sure, that the whole list has assigned a consistent list style.
 +
 
 +
==== Bullet Lists ====
 +
An example for an unordered list with bullets:
 +
 
 +
* The first item.
 +
* The second item
 +
* The third item
 +
** A sub-item.
 +
** Another sub-item
 +
*** A sub-sub-item
 +
** Level two continued
 +
* Level one continued
 +
 
 +
==== Pure Indented Lists ====
 +
The list bullets may also be omitted. To have those lists exported reliably, make sure to really use a list style instead of several paragraph styles with increasing indentation.
 +
 
 +
: The first list item
 +
: The second list item
 +
:: A sub-item
 +
:: Another sub-item
 +
::: A sub-sub-item
 +
:: Continued with level two.
 +
: Continued with level one.
 +
 
 +
==== Numbered Lists ====
 +
An example for a numbered list:
 +
 
 +
# The first item.
 +
# The second item
 +
# The third item
 +
## A sub-item.
 +
## Another sub-item
 +
### A sub-sub-item
 +
## Level two continued
 +
# Level one continued
 +
 
 +
==== Mixed lists ====
 +
Numbered and unordered lists can be mixed within separate levels of the same list:
 +
 
 +
* The first item.
 +
* The second item
 +
* The third item
 +
*# A sub-item.
 +
*# Another sub-item
 +
*#: A sub-sub-item without bullet or numbering
 +
*#: Another sub-sub-item
 +
*# Level two continued
 +
* Level one continued
 +
 
 +
=== Paragraphs ===
 +
==== Alignment ====
 +
Explicit text alignment should not be used in regular Wikipedia articles. Nevertheless, text alignment is supported by the MediaWiki export filter. An example follows:
 +
 
 +
Regular text aligned to the left.
 +
 
 +
<center>Centered text.</center>
 +
 
 +
<div align="right">Text aligned to the right.</div>
 +
 
 +
==== Pre-formatted text ====
 +
A paragraph style with a fixed-width font face is interpreted as pre-formatted text by the filter. Opposed to typewriter character style, pre-formatted text is rendered with a border in the wiki engine like in the example below:
 +
 
 +
Some code example.
 +
 +
A paragraph with
 +
explicit line breaks
 +
to get better structuring
 +
 +
<nowiki># Some comment</nowiki>
 +
Some paragraphs
 +
 +
  with
 +
 +
  indentation
 +
 +
    by
 +
 +
    preceeding
 +
 +
      spaces.
 +
 
 +
=== Character styles ===
 +
Character styles modify the appearance of only parts of a paragraph. The character styles supported by the filter are discussed next.
 +
 
 +
==== Bold ====
 +
Some text within a paragraph may be set in '''bold style'''.
 +
 
 +
==== Italics ====
 +
Like '''bold''', ''italics'' is also supported. Especially, the combination of '''''both styles''''' works as well.
 +
 
 +
Being of no special use in real text, the complexity of the filter increases noticeably by supporting text that joins these styles without intermediate space:
 +
 
 +
* '''bold'''''italics'',
 +
* ''italics'''''bold''',
 +
* '''bold'''''italics'''''bold''',
 +
* ''italics'''''bold'''''italics'',
 +
* ''italics'''boldanditalics'''italics'',
 +
* '''bold''boldanditalics''bold''',
 +
* '''''boldanditalics''bold''boldanditalics''''', and
 +
* '''''boldanditalics'''italics'''boldanditalics'''''.
 +
 
 +
==== Named, Linked and Nested Styles ====
 +
OpenDocument styles can be linked together and multiple styled elements may be nested. The resulting formatting is the union of all these styles, where the innermost definition of a property wins.
 +
 
 +
* Style '''A declaring bold'''.
 +
* Style <tt>'''B based on A declaring typewriter'''</tt>.
 +
* Style <tt>'''''C based on B declaring bold and italics'''''</tt>.
 +
* Style D based on C declaring normal font face.
 +
* Style '''E based on D, again declaring bold'''.
 +
 
 +
==== Subscript ====
 +
Subscript text is especially useful for setting indexes in simple formulas. x<sub>1</sub>, x<sub>2</sub>,..., x<sub>n</sub>.
 +
 
 +
==== Superscript ====
 +
Even if a math environment is preferred, the combination of italics style with subscript and superscript is very common for simple formulas in articles: ''f<sub>n</sub>(x) = x<sup>n</sup> – 3x<sup>2</sup> + 2''.
 +
 
 +
==== Typewriter ====
 +
When describing programs or algorithms, a common style is to set references to program elements such as variables or classes in typewriter font. The filter translates all font faces with fixed width into the Wiki typewriter style.
 +
 
 +
=== Footnotes ===
 +
<nowiki>Note: The filter uses the new style of footnotes with <ref> and <references> tags that requires the </nowiki>[http://meta.wikimedia.org/wiki/Cite/Cite.php Cite.php] extension to be installed into MediaWiki. If those tags occur as plain text in the filter result, please install this extension.
 +
 
 +
Articles may be enriched with footnotes.<ref name="ftn1">A footnote is a piece of text that is taken out of the normal text flow. It usually gives some background information that is not absolutely required for understanding the text.</ref> Footnotes are especially useful for citing the origin of some information.<ref name="ftn2">Please also refer to the [http://en.wikipedia.org/wiki/Wikipedia:Footnotes Wikipedia howto on footnotes].</ref> Referencing the same footnote twice<ref name="ftn1"/> is also supported by the filter.
 +
 
 +
=== Images ===
 +
[[Image:Kreuztor_Ingoldstadt.jpg|thumb|Illustration 1: Kreuztor in Ingolstadt, Germany.]]Images in general cannot be exported by a filter producing a single file of Wiki text. However, if the image is already uploaded to the target Wiki domain<ref name="ftn3">The Wiki system, to which the result of the filter is being deployed.</ref> (e.g. [http://commons.wikimedia.org/ WikiMedia Commons]), then the filter produces a valid image tag that includes the image. Image descriptions are also supported.
 +
 
 +
=== Tables ===
 +
Tables are a natural way of presenting multiple pieces of equally structured information.
 +
 
 +
==== Table Headers ====
 +
Simple tables are supported well. Table headers are translated into corresponding Wiki-style table headers. However, custom formattings of table borders, column sizes and background colors are ignored.
 +
 
 +
 
 +
{| class="prettytable"
 +
| '''Header 1'''
 +
| '''Header 2'''
 +
| '''Header 3'''
 +
 
 +
|-
 +
| Information 1.1
 +
| Information 1.2
 +
| Information 1.3
 +
 
 +
|-
 +
| Information 2.1
 +
| Information 2.2
 +
| Information 2.3
 +
 
 +
|}
 +
 
 +
==== Joined Cells ====
 +
OpenDocument and especially OpenOffice.org represent tables that have joined cells that span rows as tables with nested tables. In contrast, the Wiki model of table is to declare column and row spans for such joined cells.
 +
 
 +
If only columns of the same row are joined, the result of the filter resembles the source document very well:
 +
 
 +
 
 +
{| class="prettytable"
 +
| colspan="2" | '''Joined header cell 1 and 3'''
 +
| '''Header 3'''
 +
 
 +
|-
 +
| Cell 1.1
 +
| Cells 1.2
 +
| Cell 1.3
 +
 
 +
|-
 +
| Cell 2.1
 +
| colspan="2" | Joined cells 2.2 and 2.3
 +
 
 +
|}
 +
However, the filter does not support tables with joined cells that span multiple rows. If the source document uses such tables, nested tables are observed in the result document.
 +
 
 +
 
 +
{| class="prettytable"
 +
| '''Joined header cell with cell 1.1'''
 +
|
 +
{| class="prettytable"
 +
| '''Header 2'''
 +
 
 +
|-
 +
| Cell 1.2
 +
 
 +
|}
 +
 
 +
| '''Joined header cell 3 and cell 1.3'''
 +
 
 +
|-
 +
| Cell 2.1
 +
| Cell 2.2
 +
| Cell 2.3
 +
 
 +
|}
 +
 
 +
==== Borders ====
 +
Irrespective of custom table styles for border and background, a table is always exported as “prettytable”, which renders in the Wiki engine with simple borders and bold header.
 +
 
 +
=== Characters set ans special characters ===
 +
The characters set of the filter is fixed to UTF-8. Depending on the user's system, this might not be the default characters set. This might cause “special character” to look broken, when viewed with default settings. However the user can switch his/her editor to UTF-8 encoding to fix this. If the user's editor does not support switching the encoding, he/she can display the result of the filter in the [http://www.mozilla.com/en-US/firefox/ Firefox] browser and switch the encoding to UTF-8 there. It is then possible to cut and paste the filter output to a program of the user's choice.
 +
 
 +
=== Direct Wiki Input ===
 +
==== Umlauts and accents ====
 +
À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï Ñ Ò Ó Ô Õ Ö Ø Ù Ú Û Ü ß à á â ã ä å æ ç è é ê ë ì í î ï ñ ò ó ô œ õ ö ø ù ú û ü ÿ
 +
 
 +
==== Punctuation ====
 +
¿ ¡ « » § ¶ † ‡ • - – —
 +
 
 +
==== Commercial symbols ====
 +
™ © ® ¢ € ¥ £ ¤
 +
 
 +
==== Greek characters ====
 +
α β γ δ ε ζ η θ ι κ λ μ ν ξ ο π ρ σ ς τ υ φ χ ψ ω Γ Δ Θ Λ Ξ Π Σ Φ Ψ Ω
 +
 
 +
==== Math characters ====
 +
∫ ∑ ∏ √ − ± ∞ ≈ ∝ ≡ ≠ ≤ ≥ × · ÷ ∂ ′ ″ ∇ ‰ ° ∴ ø ∈ ∩ ∪ ⊂ ⊃ ⊆ ⊇ ¬ ∧ ∨ ∃ ∀ ⇒ ⇔ → ↔ ↑
 +
 
 +
Problem symbols:
 +
 
 +
ℵ ∉
 +
 
 +
=== WikiMath ===
 +
(not defined)
 +
 
 +
=== WikiLink ===
 +
(not defined)
 +
 
 +
== Unsupported Features ==
 +
=== Hyperlinks ===
 +
==== Document-internal Links ====
 +
For an example, se [#1.3.2.Character Styles|outline 1.3.2Character Styles]
 +
 
 +
=== Character Styles ===
 +
==== Small capitals ====
 +
This text is formatted with small capitals.
 +
 
 +
==== Underline ====
 +
This text is underlined.
 +
 
 +
==== Strikethrough ====
 +
This text is formatted with strikethrough.
 +
 
 +
=== Horizontal Rules ===
 +
This is an horizontal line:
 +
 
 +
 
 +
 
 +
 
 +
----
 +
<references/>

Revision as of 20:07, 1 November 2007

Supported Features

The following section describe the formatting and contents features supported by the MediaWiki export filter.

(Note: starting from this point, this document can be used as test document in a test case specification)

Headings

While headings can be thoroughly formatted in OpenDocument, their format is defined by the style applied by the wiki engine. During export to MediaWiki format, style information of headings is lost and the default heading style is applied by the Wiki engine. The headings of this document serve as example for the transformation of headings.

Hyperlinks

Native OpenDocument hyperlinks are transformed into “external” Wiki links during the transformation. Therefore, the built-in linking facility of OpenDocument should only be used, when generating links pointing to other sites outside the Wiki web. For generating Wiki links that point to other subjects of the same Wiki domain (e.g. Wikipedia), use wiki links explained below.

Lists

To have lists reliably exported, you must make sure, that the whole list has assigned a consistent list style.

Bullet Lists

An example for an unordered list with bullets:

  • The first item.
  • The second item
  • The third item
    • A sub-item.
    • Another sub-item
      • A sub-sub-item
    • Level two continued
  • Level one continued

Pure Indented Lists

The list bullets may also be omitted. To have those lists exported reliably, make sure to really use a list style instead of several paragraph styles with increasing indentation.

The first list item
The second list item
A sub-item
Another sub-item
A sub-sub-item
Continued with level two.
Continued with level one.

Numbered Lists

An example for a numbered list:

  1. The first item.
  2. The second item
  3. The third item
    1. A sub-item.
    2. Another sub-item
      1. A sub-sub-item
    3. Level two continued
  4. Level one continued

Mixed lists

Numbered and unordered lists can be mixed within separate levels of the same list:

  • The first item.
  • The second item
  • The third item
    1. A sub-item.
    2. Another sub-item
      A sub-sub-item without bullet or numbering
      Another sub-sub-item
    3. Level two continued
  • Level one continued

Paragraphs

Alignment

Explicit text alignment should not be used in regular Wikipedia articles. Nevertheless, text alignment is supported by the MediaWiki export filter. An example follows:

Regular text aligned to the left.

Centered text.
Text aligned to the right.

Pre-formatted text

A paragraph style with a fixed-width font face is interpreted as pre-formatted text by the filter. Opposed to typewriter character style, pre-formatted text is rendered with a border in the wiki engine like in the example below: 

Some code example.

A paragraph with
explicit line breaks
to get better structuring

# Some comment
Some paragraphs

 with

  indentation

   by

    preceeding

     spaces.

Character styles

Character styles modify the appearance of only parts of a paragraph. The character styles supported by the filter are discussed next.

Bold

Some text within a paragraph may be set in bold style.

Italics

Like bold, italics is also supported. Especially, the combination of both styles works as well.

Being of no special use in real text, the complexity of the filter increases noticeably by supporting text that joins these styles without intermediate space:

  • bolditalics,
  • italicsbold,
  • bolditalicsbold,
  • italicsbolditalics,
  • italicsboldanditalicsitalics,
  • boldboldanditalicsbold,
  • boldanditalicsboldboldanditalics, and
  • boldanditalicsitalicsboldanditalics.

Named, Linked and Nested Styles

OpenDocument styles can be linked together and multiple styled elements may be nested. The resulting formatting is the union of all these styles, where the innermost definition of a property wins.

  • Style A declaring bold.
  • Style B based on A declaring typewriter.
  • Style C based on B declaring bold and italics.
  • Style D based on C declaring normal font face.
  • Style E based on D, again declaring bold.

Subscript

Subscript text is especially useful for setting indexes in simple formulas. x1, x2,..., xn.

Superscript

Even if a math environment is preferred, the combination of italics style with subscript and superscript is very common for simple formulas in articles: fn(x) = xn – 3x2 + 2.

Typewriter

When describing programs or algorithms, a common style is to set references to program elements such as variables or classes in typewriter font. The filter translates all font faces with fixed width into the Wiki typewriter style.

Footnotes

Note: The filter uses the new style of footnotes with <ref> and <references> tags that requires the Cite.php extension to be installed into MediaWiki. If those tags occur as plain text in the filter result, please install this extension.

Articles may be enriched with footnotes.[1] Footnotes are especially useful for citing the origin of some information.[2] Referencing the same footnote twice[1] is also supported by the filter.

Images

Illustration 1: Kreuztor in Ingolstadt, Germany.
Images in general cannot be exported by a filter producing a single file of Wiki text. However, if the image is already uploaded to the target Wiki domain[3] (e.g. WikiMedia Commons), then the filter produces a valid image tag that includes the image. Image descriptions are also supported.

Tables

Tables are a natural way of presenting multiple pieces of equally structured information.

Table Headers

Simple tables are supported well. Table headers are translated into corresponding Wiki-style table headers. However, custom formattings of table borders, column sizes and background colors are ignored.


Header 1 Header 2 Header 3
Information 1.1 Information 1.2 Information 1.3
Information 2.1 Information 2.2 Information 2.3

Joined Cells

OpenDocument and especially OpenOffice.org represent tables that have joined cells that span rows as tables with nested tables. In contrast, the Wiki model of table is to declare column and row spans for such joined cells.

If only columns of the same row are joined, the result of the filter resembles the source document very well:


Joined header cell 1 and 3 Header 3
Cell 1.1 Cells 1.2 Cell 1.3
Cell 2.1 Joined cells 2.2 and 2.3

However, the filter does not support tables with joined cells that span multiple rows. If the source document uses such tables, nested tables are observed in the result document.


Joined header cell with cell 1.1
Header 2
Cell 1.2
Joined header cell 3 and cell 1.3
Cell 2.1 Cell 2.2 Cell 2.3

Borders

Irrespective of custom table styles for border and background, a table is always exported as “prettytable”, which renders in the Wiki engine with simple borders and bold header.

Characters set ans special characters

The characters set of the filter is fixed to UTF-8. Depending on the user's system, this might not be the default characters set. This might cause “special character” to look broken, when viewed with default settings. However the user can switch his/her editor to UTF-8 encoding to fix this. If the user's editor does not support switching the encoding, he/she can display the result of the filter in the Firefox browser and switch the encoding to UTF-8 there. It is then possible to cut and paste the filter output to a program of the user's choice.

Direct Wiki Input

Umlauts and accents

À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï Ñ Ò Ó Ô Õ Ö Ø Ù Ú Û Ü ß à á â ã ä å æ ç è é ê ë ì í î ï ñ ò ó ô œ õ ö ø ù ú û ü ÿ

Punctuation

¿ ¡ « » § ¶ † ‡ • - – —

Commercial symbols

™ © ® ¢ € ¥ £ ¤

Greek characters

α β γ δ ε ζ η θ ι κ λ μ ν ξ ο π ρ σ ς τ υ φ χ ψ ω Γ Δ Θ Λ Ξ Π Σ Φ Ψ Ω

Math characters

∫ ∑ ∏ √ − ± ∞ ≈ ∝ ≡ ≠ ≤ ≥ × · ÷ ∂ ′ ″ ∇ ‰ ° ∴ ø ∈ ∩ ∪ ⊂ ⊃ ⊆ ⊇ ¬ ∧ ∨ ∃ ∀ ⇒ ⇔ → ↔ ↑

Problem symbols:

ℵ ∉

WikiMath

(not defined)

WikiLink

(not defined)

Unsupported Features

Hyperlinks

Document-internal Links

For an example, se [#1.3.2.Character Styles|outline 1.3.2Character Styles]

Character Styles

Small capitals

This text is formatted with small capitals.

Underline

This text is underlined.

Strikethrough

This text is formatted with strikethrough.

Horizontal Rules

This is an horizontal line:



  1. ↑ 1.0 1.1 A footnote is a piece of text that is taken out of the normal text flow. It usually gives some background information that is not absolutely required for understanding the text.
  2. ↑ Please also refer to the Wikipedia howto on footnotes.
  3. ↑ The Wiki system, to which the result of the filter is being deployed.
Retrieved from "https://wiki.openoffice.org/w/index.php?title=User:ES&oldid=51882"
Personal tools