mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 23:32:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

how to add links.

Browse Source 
Updated wikipage Help to edit documentation.
	(Signed-off-by:jocelyn).

git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2390 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2023-01-24 15:52:04 +00:00
parent 2a78a964b7
commit 71c0bf1b85
1 changed files with 134 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

257
documentation/22.12/contribute/editing_help.wiki
View File

@@ -1,123 +1,134 @@
[[Property:title|Help to edit documentation]] [[Property:modification_date|Tue, 24 Jan 2023 15:52:04 GMT]]
[[Property:link_title|Editing help]] [[Property:publication_date|Tue, 24 Jan 2023 15:52:04 GMT]]
[[Property:weight|3]] [[Property:uuid|21D430EE-C9E0-46CC-8310-98521B77CA01]]
[[Property:title|Help to edit documentation]]
= Wikitext syntax = [[Property:link_title|Editing help]]
* Have a look at [https://en.wikipedia.org/wiki/Help:Wiki_markup Wikipedia markup] documentation. [[Property:weight|3]]
* The current website does not support the full Wikipedia syntax, but still most of the needed cases.
= Wikitext syntax =
* To embed inline code: * Have a look at [https://en.wikipedia.org/wiki/Help:Wiki_markup Wikipedia markup] documentation.
** `` `foo.bar` `` * The current website does not support the full Wikipedia syntax, but still most of the needed cases.
** `<code>foo.bar</code>`
** `<eiffel>foo.bar</eiffel>` * To add a link to another wiki page
** `[[Wiki Page Title]]` or `[[Wiki Page Title|Custom text]]` (to use a specific text for the link)
* To embed block code: ** for instance, a link to this current page would be `[[Help to edit documentation]]` : [[Help to edit documentation]]
```xml * To add a link to any URL
<code lang="eiffel"> ** `[https://www.eiffel.com Eiffel.com]` (bracket, url, space text, bracket)
class FOOBAR ** Result: [https://www.eiffel.com Eiffel.com]
</code>
``` * To embed inline code:
** `` `foo.bar` ``
```xml ** `<code>foo.bar</code>`
<eiffel> ** `<eiffel>foo.bar</eiffel>`
class FOOBAR
</eiffel> * To embed block code:
```
```xml
<code lang="text"> <code lang="eiffel">
```eiffel class FOOBAR
class FOOBAR </code>
``` ```
</code>
```xml
Note: if you do not specify the lang, it is defaulted to "eiffel" <eiffel>
class FOOBAR
</eiffel>
```
= Templates =
== Top page templates == <code lang="text">
Used to qualify the current page. ```eiffel
class FOOBAR
=== ReviewRequested === ```
:<nowiki>{{ReviewRequested|This is a ReviewRequested message}}</nowiki> </code>
{{ReviewRequested|This is a ReviewRequested message}}
Note: if you do not specify the lang, it is defaulted to "eiffel"
=== UnderConstruction ===
:<nowiki>{{UnderConstruction|This is a UnderConstruction message}}</nowiki>
{{UnderConstruction|This is a UnderConstruction message}}
= Templates =
=== UpdateNeeded === == Top page templates ==
:<nowiki>{{UpdateNeeded|This is a UpdateNeeded message}}</nowiki> Used to qualify the current page.
{{UpdateNeeded|This is a UpdateNeeded message}}
=== ReviewRequested ===
=== Beta === :<nowiki>{{ReviewRequested|This is a ReviewRequested message}}</nowiki>
:<nowiki>{{Beta|This is a beta message}}</nowiki> {{ReviewRequested|This is a ReviewRequested message}}
{{Beta|This is a beta message}}
=== UnderConstruction ===
:<nowiki>{{UnderConstruction|This is a UnderConstruction message}}</nowiki>
== Block templates == {{UnderConstruction|This is a UnderConstruction message}}
=== Caution ===
:<nowiki>{{Caution|This is a caution message}}</nowiki> === UpdateNeeded ===
{{Caution|This is a caution message}} :<nowiki>{{UpdateNeeded|This is a UpdateNeeded message}}</nowiki>
{{UpdateNeeded|This is a UpdateNeeded message}}
=== Definition ===
:<nowiki>{{Definition|abc|This is a Definition message}}</nowiki> === Beta ===
{{Definition|abc|This is a Definition message}} :<nowiki>{{Beta|This is a beta message}}</nowiki>
{{Beta|This is a beta message}}
=== Info ===
:<nowiki>{{Info|This is a Info message}}</nowiki>
{{Info|This is a Info message}} == Block templates ==
=== Caution ===
:<nowiki>{{Caution|This is a caution message}}</nowiki>
=== Note === {{Caution|This is a caution message}}
:<nowiki>{{Note|This is a Note message}}</nowiki>
{{Note|This is a Note message}} === Definition ===
:<nowiki>{{Definition|abc|This is a Definition message}}</nowiki>
=== Recommended === {{Definition|abc|This is a Definition message}}
:<nowiki>{{Recommended|This is a Recommended message}}</nowiki>
{{Recommended|This is a Recommended message}} === Info ===
:<nowiki>{{Info|This is a Info message}}</nowiki>
=== Rule === {{Info|This is a Info message}}
:<nowiki>{{Rule|name=abc|text=This is a Rule message}}</nowiki>
{{Rule|name=abc|text=This is a Rule message}}
=== Note ===
=== Sample === :<nowiki>{{Note|This is a Note message}}</nowiki>
:<nowiki>{{Sample|This is a Sample message}}</nowiki> {{Note|This is a Note message}}
{{Sample|This is a Sample message}}
=== Recommended ===
=== SeeAlso === :<nowiki>{{Recommended|This is a Recommended message}}</nowiki>
:<nowiki>{{SeeAlso|This is a SeeAlso message}}</nowiki> {{Recommended|This is a Recommended message}}
{{SeeAlso|This is a SeeAlso message}}
=== Rule ===
=== Tip === :<nowiki>{{Rule|name=abc|text=This is a Rule message}}</nowiki>
:<nowiki>{{Tip|This is a Tip message}}</nowiki> {{Rule|name=abc|text=This is a Rule message}}
{{Tip|This is a Tip message}}
=== Sample ===
=== Warning === :<nowiki>{{Sample|This is a Sample message}}</nowiki>
:<nowiki>{{Warning|This is a Warning message}}</nowiki> {{Sample|This is a Sample message}}
{{Warning|This is a Warning message}}
=== SeeAlso ===
:<nowiki>{{SeeAlso|This is a SeeAlso message}}</nowiki>
== Inline templates == {{SeeAlso|This is a SeeAlso message}}
=== Key === === Tip ===
:<nowiki>This is a {{Key|key message}} in the text. </nowiki> :<nowiki>{{Tip|This is a Tip message}}</nowiki>
This is a {{Key|key message}} in the text. {{Tip|This is a Tip message}}
=== Error === === Warning ===
:<nowiki>This is a {{Inline-Error|error message}} in the text. </nowiki> :<nowiki>{{Warning|This is a Warning message}}</nowiki>
This is a {{Inline-Error|error message}} in the text. {{Warning|This is a Warning message}}
=== Info ===
:<nowiki>This is a {{Inline-Info|info message}} in the text. </nowiki> == Inline templates ==
This is a {{Inline-Info|info message}} in the text.
=== Key ===
=== Success === :<nowiki>This is a {{Key|key message}} in the text. </nowiki>
:<nowiki>This is a {{Inline-Success|success message}} in the text. </nowiki> This is a {{Key|key message}} in the text.
This is a {{Inline-Success|success message}} in the text.
=== Error ===
=== Warning === :<nowiki>This is a {{Inline-Error|error message}} in the text. </nowiki>
:<nowiki>This is a {{Inline-Warning|warning message}} in the text. </nowiki> This is a {{Inline-Error|error message}} in the text.
This is a {{Inline-Warning|warning 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.