Files
eiffel-org/documentation/18.07/contribute/editing_help.wiki
eiffel-org 12a94b8720 added 18.07
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2049 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
2018-07-11 09:05:50 +00:00

124 lines
3.2 KiB
Plaintext

[[Property:title|Help to edit documentation]]
[[Property:link_title|Editing help]]
[[Property:weight|3]]
= Wikitext syntax =
* Have a look at [https://en.wikipedia.org/wiki/Help:Wiki_markup Wikipedia markup] documentation.
* The current website does not support the full Wikipedia syntax, but still most of the needed cases.
* To embed inline code:
** `` `foo.bar` ``
** `<code>foo.bar</code>`
** `<eiffel>foo.bar</eiffel>`
* To embed block code:
```xml
<code lang="eiffel">
class FOOBAR
</code>
```
```xml
<eiffel>
class FOOBAR
</eiffel>
```
<code lang="text">
```eiffel
class FOOBAR
```
</code>
Note: if you do not specify the lang, it is defaulted to "eiffel"
= Templates =
== Top page templates ==
Used to qualify the current page.
=== ReviewRequested ===
:<nowiki>{{ReviewRequested|This is a ReviewRequested message}}</nowiki>
{{ReviewRequested|This is a ReviewRequested message}}
=== UnderConstruction ===
:<nowiki>{{UnderConstruction|This is a UnderConstruction message}}</nowiki>
{{UnderConstruction|This is a UnderConstruction message}}
=== UpdateNeeded ===
:<nowiki>{{UpdateNeeded|This is a UpdateNeeded message}}</nowiki>
{{UpdateNeeded|This is a UpdateNeeded message}}
=== Beta ===
:<nowiki>{{Beta|This is a beta message}}</nowiki>
{{Beta|This is a beta message}}
== Block templates ==
=== Caution ===
:<nowiki>{{Caution|This is a caution message}}</nowiki>
{{Caution|This is a caution message}}
=== Definition ===
:<nowiki>{{Definition|abc|This is a Definition message}}</nowiki>
{{Definition|abc|This is a Definition message}}
=== Info ===
:<nowiki>{{Info|This is a Info message}}</nowiki>
{{Info|This is a Info message}}
=== Note ===
:<nowiki>{{Note|This is a Note message}}</nowiki>
{{Note|This is a Note message}}
=== Recommended ===
:<nowiki>{{Recommended|This is a Recommended message}}</nowiki>
{{Recommended|This is a Recommended message}}
=== Rule ===
:<nowiki>{{Rule|name=abc|text=This is a Rule message}}</nowiki>
{{Rule|name=abc|text=This is a Rule message}}
=== Sample ===
:<nowiki>{{Sample|This is a Sample message}}</nowiki>
{{Sample|This is a Sample message}}
=== SeeAlso ===
:<nowiki>{{SeeAlso|This is a SeeAlso message}}</nowiki>
{{SeeAlso|This is a SeeAlso message}}
=== Tip ===
:<nowiki>{{Tip|This is a Tip message}}</nowiki>
{{Tip|This is a Tip message}}
=== Warning ===
:<nowiki>{{Warning|This is a Warning message}}</nowiki>
{{Warning|This is a Warning message}}
== Inline templates ==
=== Key ===
:<nowiki>This is a {{Key|key message}} in the text. </nowiki>
This is a {{Key|key message}} in the text.
=== Error ===
:<nowiki>This is a {{Inline-Error|error message}} in the text. </nowiki>
This is a {{Inline-Error|error message}} in the text.
=== Info ===
:<nowiki>This is a {{Inline-Info|info message}} in the text. </nowiki>
This is a {{Inline-Info|info message}} in the text.
=== Success ===
:<nowiki>This is a {{Inline-Success|success message}} in the text. </nowiki>
This is a {{Inline-Success|success message}} in the text.
=== Warning ===
:<nowiki>This is a {{Inline-Warning|warning message}} in the text. </nowiki>
This is a {{Inline-Warning|warning message}} in the text.