From 71c0bf1b85a3b769b5fde23bdae297e43720ec31 Mon Sep 17 00:00:00 2001 From: eiffel-org Date: Tue, 24 Jan 2023 15:52:04 +0000 Subject: [PATCH] how to add links. 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 --- .../22.12/contribute/editing_help.wiki | 257 +++++++++--------- 1 file changed, 134 insertions(+), 123 deletions(-) diff --git a/documentation/22.12/contribute/editing_help.wiki b/documentation/22.12/contribute/editing_help.wiki index dcf54b89..643c3bd0 100644 --- a/documentation/22.12/contribute/editing_help.wiki +++ b/documentation/22.12/contribute/editing_help.wiki @@ -1,123 +1,134 @@ -[[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` `` -** `foo.bar` -** `foo.bar` - -* To embed block code: - -```xml - - class FOOBAR - -``` - -```xml - - class FOOBAR - -``` - - -```eiffel - class FOOBAR -``` - - -Note: if you do not specify the lang, it is defaulted to "eiffel" - - - -= Templates = -== Top page templates == -Used to qualify the current page. - -=== ReviewRequested === -:{{ReviewRequested|This is a ReviewRequested message}} -{{ReviewRequested|This is a ReviewRequested message}} - -=== UnderConstruction === -:{{UnderConstruction|This is a UnderConstruction message}} -{{UnderConstruction|This is a UnderConstruction message}} - -=== UpdateNeeded === -:{{UpdateNeeded|This is a UpdateNeeded message}} -{{UpdateNeeded|This is a UpdateNeeded message}} - -=== Beta === -:{{Beta|This is a beta message}} -{{Beta|This is a beta message}} - - -== Block templates == -=== Caution === -:{{Caution|This is a caution message}} -{{Caution|This is a caution message}} - -=== Definition === -:{{Definition|abc|This is a Definition message}} -{{Definition|abc|This is a Definition message}} - -=== Info === -:{{Info|This is a Info message}} -{{Info|This is a Info message}} - - -=== Note === -:{{Note|This is a Note message}} -{{Note|This is a Note message}} - -=== Recommended === -:{{Recommended|This is a Recommended message}} -{{Recommended|This is a Recommended message}} - -=== Rule === -:{{Rule|name=abc|text=This is a Rule message}} -{{Rule|name=abc|text=This is a Rule message}} - -=== Sample === -:{{Sample|This is a Sample message}} -{{Sample|This is a Sample message}} - -=== SeeAlso === -:{{SeeAlso|This is a SeeAlso message}} -{{SeeAlso|This is a SeeAlso message}} - -=== Tip === -:{{Tip|This is a Tip message}} -{{Tip|This is a Tip message}} - -=== Warning === -:{{Warning|This is a Warning message}} -{{Warning|This is a Warning message}} - - -== Inline templates == - -=== Key === -:This is a {{Key|key message}} in the text. -This is a {{Key|key message}} in the text. - -=== Error === -:This is a {{Inline-Error|error message}} in the text. -This is a {{Inline-Error|error message}} in the text. - -=== Info === -:This is a {{Inline-Info|info message}} in the text. -This is a {{Inline-Info|info message}} in the text. - -=== Success === -:This is a {{Inline-Success|success message}} in the text. -This is a {{Inline-Success|success message}} in the text. - -=== Warning === -:This is a {{Inline-Warning|warning message}} in the text. -This is a {{Inline-Warning|warning message}} in the text. - +[[Property:modification_date|Tue, 24 Jan 2023 15:52:04 GMT]] +[[Property:publication_date|Tue, 24 Jan 2023 15:52:04 GMT]] +[[Property:uuid|21D430EE-C9E0-46CC-8310-98521B77CA01]] +[[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 add a link to another wiki page +** `[[Wiki Page Title]]` or `[[Wiki Page Title|Custom text]]` (to use a specific text for the link) +** for instance, a link to this current page would be `[[Help to edit documentation]]` : [[Help to edit documentation]] + +* To add a link to any URL +** `[https://www.eiffel.com Eiffel.com]` (bracket, url, space text, bracket) +** Result: [https://www.eiffel.com Eiffel.com] + +* To embed inline code: +** `` `foo.bar` `` +** `foo.bar` +** `foo.bar` + +* To embed block code: + +```xml + + class FOOBAR + +``` + +```xml + + class FOOBAR + +``` + + +```eiffel + class FOOBAR +``` + + +Note: if you do not specify the lang, it is defaulted to "eiffel" + + + += Templates = +== Top page templates == +Used to qualify the current page. + +=== ReviewRequested === +:{{ReviewRequested|This is a ReviewRequested message}} +{{ReviewRequested|This is a ReviewRequested message}} + +=== UnderConstruction === +:{{UnderConstruction|This is a UnderConstruction message}} +{{UnderConstruction|This is a UnderConstruction message}} + +=== UpdateNeeded === +:{{UpdateNeeded|This is a UpdateNeeded message}} +{{UpdateNeeded|This is a UpdateNeeded message}} + +=== Beta === +:{{Beta|This is a beta message}} +{{Beta|This is a beta message}} + + +== Block templates == +=== Caution === +:{{Caution|This is a caution message}} +{{Caution|This is a caution message}} + +=== Definition === +:{{Definition|abc|This is a Definition message}} +{{Definition|abc|This is a Definition message}} + +=== Info === +:{{Info|This is a Info message}} +{{Info|This is a Info message}} + + +=== Note === +:{{Note|This is a Note message}} +{{Note|This is a Note message}} + +=== Recommended === +:{{Recommended|This is a Recommended message}} +{{Recommended|This is a Recommended message}} + +=== Rule === +:{{Rule|name=abc|text=This is a Rule message}} +{{Rule|name=abc|text=This is a Rule message}} + +=== Sample === +:{{Sample|This is a Sample message}} +{{Sample|This is a Sample message}} + +=== SeeAlso === +:{{SeeAlso|This is a SeeAlso message}} +{{SeeAlso|This is a SeeAlso message}} + +=== Tip === +:{{Tip|This is a Tip message}} +{{Tip|This is a Tip message}} + +=== Warning === +:{{Warning|This is a Warning message}} +{{Warning|This is a Warning message}} + + +== Inline templates == + +=== Key === +:This is a {{Key|key message}} in the text. +This is a {{Key|key message}} in the text. + +=== Error === +:This is a {{Inline-Error|error message}} in the text. +This is a {{Inline-Error|error message}} in the text. + +=== Info === +:This is a {{Inline-Info|info message}} in the text. +This is a {{Inline-Info|info message}} in the text. + +=== Success === +:This is a {{Inline-Success|success message}} in the text. +This is a {{Inline-Success|success message}} in the text. + +=== Warning === +:This is a {{Inline-Warning|warning message}} in the text. +This is a {{Inline-Warning|warning message}} in the text. +