From e028cd7c83173952d62542aff07db4687c65da64 Mon Sep 17 00:00:00 2001 From: eiffel-org Date: Fri, 3 Jun 2016 12:17:58 +0000 Subject: [PATCH] Update template content and style. Added inline-(info,warning,error,success) templates. Added contribute/editing_help. git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1584 abb3cda0-5349-4a8f-a601-0c33ac3a8c38 --- documentation/trunk/_templates/Beta.tpl | 2 +- documentation/trunk/_templates/Info.tpl | 2 +- .../trunk/_templates/Inline-Error.tpl | 1 + .../trunk/_templates/Inline-Info.tpl | 1 + .../trunk/_templates/Inline-Success.tpl | 1 + .../trunk/_templates/Inline-Warning.tpl | 1 + documentation/trunk/_templates/Key.tpl | 3 +- documentation/trunk/_templates/Note.tpl | 3 +- .../trunk/_templates/Recommended.tpl | 2 +- .../trunk/_templates/ReviewRequested.tpl | 2 +- documentation/trunk/_templates/Rule.tpl | 2 +- documentation/trunk/_templates/Sample.tpl | 2 +- documentation/trunk/_templates/SeeAlso.tpl | 9 +- documentation/trunk/_templates/Tip.tpl | 2 +- .../trunk/_templates/UnderConstruction.tpl | 2 +- .../trunk/_templates/UpdateNeeded.tpl | 2 +- documentation/trunk/_templates/Warning.tpl | 3 +- documentation/trunk/_templates/definition.tpl | 2 +- .../trunk/contribute/documentation.wiki | 2 +- .../trunk/contribute/editing_help.wiki | 94 +++++++++++++++++++ 20 files changed, 113 insertions(+), 25 deletions(-) create mode 100644 documentation/trunk/_templates/Inline-Error.tpl create mode 100644 documentation/trunk/_templates/Inline-Info.tpl create mode 100644 documentation/trunk/_templates/Inline-Success.tpl create mode 100644 documentation/trunk/_templates/Inline-Warning.tpl create mode 100644 documentation/trunk/contribute/editing_help.wiki diff --git a/documentation/trunk/_templates/Beta.tpl b/documentation/trunk/_templates/Beta.tpl index 81776909..e32b4e94 100644 --- a/documentation/trunk/_templates/Beta.tpl +++ b/documentation/trunk/_templates/Beta.tpl @@ -1 +1 @@ -

[[Image:LogoBeta|24px]] '''Beta documentation:''' [[How to contribute to documentation#Beta|see definition]].

+

[[Image:LogoBeta|24px]] '''Beta documentation:''' [[How to contribute to documentation#Beta|see definition]].

diff --git a/documentation/trunk/_templates/Info.tpl b/documentation/trunk/_templates/Info.tpl index 791bfb94..3c38d64f 100644 --- a/documentation/trunk/_templates/Info.tpl +++ b/documentation/trunk/_templates/Info.tpl @@ -1 +1 @@ -

[[Image:LogoInformation|24px]] '''Info: '''{{{1}}}

+

[[Image:LogoInformation|24px]] '''Info: '''{{{1}}}

diff --git a/documentation/trunk/_templates/Inline-Error.tpl b/documentation/trunk/_templates/Inline-Error.tpl new file mode 100644 index 00000000..64076adc --- /dev/null +++ b/documentation/trunk/_templates/Inline-Error.tpl @@ -0,0 +1 @@ +{{{1}}} diff --git a/documentation/trunk/_templates/Inline-Info.tpl b/documentation/trunk/_templates/Inline-Info.tpl new file mode 100644 index 00000000..a32c6bbd --- /dev/null +++ b/documentation/trunk/_templates/Inline-Info.tpl @@ -0,0 +1 @@ +{{{1}}} diff --git a/documentation/trunk/_templates/Inline-Success.tpl b/documentation/trunk/_templates/Inline-Success.tpl new file mode 100644 index 00000000..0351750e --- /dev/null +++ b/documentation/trunk/_templates/Inline-Success.tpl @@ -0,0 +1 @@ +{{{1}}} diff --git a/documentation/trunk/_templates/Inline-Warning.tpl b/documentation/trunk/_templates/Inline-Warning.tpl new file mode 100644 index 00000000..1a097523 --- /dev/null +++ b/documentation/trunk/_templates/Inline-Warning.tpl @@ -0,0 +1 @@ +{{{1}}} diff --git a/documentation/trunk/_templates/Key.tpl b/documentation/trunk/_templates/Key.tpl index ae4be3bf..b0eece42 100644 --- a/documentation/trunk/_templates/Key.tpl +++ b/documentation/trunk/_templates/Key.tpl @@ -1,2 +1 @@ -{{{1|key}}} - +{{{1}}} diff --git a/documentation/trunk/_templates/Note.tpl b/documentation/trunk/_templates/Note.tpl index 94a1f96f..1b00b242 100644 --- a/documentation/trunk/_templates/Note.tpl +++ b/documentation/trunk/_templates/Note.tpl @@ -1,2 +1 @@ -

[[Image:LogoInformation|24px]] '''Note: '''{{{1}}}

- +

[[Image:LogoInformation|24px]] '''Note: '''{{{1}}}

diff --git a/documentation/trunk/_templates/Recommended.tpl b/documentation/trunk/_templates/Recommended.tpl index 6ec2c36c..43521ac7 100644 --- a/documentation/trunk/_templates/Recommended.tpl +++ b/documentation/trunk/_templates/Recommended.tpl @@ -1 +1 @@ -

[[Image:LogoRecommended|24px]] '''Recommended: '''{{{1}}}

+

[[Image:LogoRecommended|24px]] '''Recommended: '''{{{1}}}

diff --git a/documentation/trunk/_templates/ReviewRequested.tpl b/documentation/trunk/_templates/ReviewRequested.tpl index 076aa198..c927b85c 100644 --- a/documentation/trunk/_templates/ReviewRequested.tpl +++ b/documentation/trunk/_templates/ReviewRequested.tpl @@ -1 +1 @@ -

[[Image:LogoReviewRequested|24px]] '''Review requested: ''' [[How to contribute to documentation#ReviewRequested|see definition]].

+

[[Image:LogoReviewRequested|24px]] '''Review requested: ''' [[How to contribute to documentation#ReviewRequested|see definition]].

diff --git a/documentation/trunk/_templates/Rule.tpl b/documentation/trunk/_templates/Rule.tpl index 3e0278e0..5a2ab11a 100644 --- a/documentation/trunk/_templates/Rule.tpl +++ b/documentation/trunk/_templates/Rule.tpl @@ -1 +1 @@ -

[[Image:LogoRule|24px]] '''Rule -- {{{name}}}:''' {{{text}}}

+

[[Image:LogoRule|24px]] '''Rule -- {{{name}}}:''' {{{text}}}

diff --git a/documentation/trunk/_templates/Sample.tpl b/documentation/trunk/_templates/Sample.tpl index 7bd35338..cfb7647c 100644 --- a/documentation/trunk/_templates/Sample.tpl +++ b/documentation/trunk/_templates/Sample.tpl @@ -1 +1 @@ -

[[Image:LogoInformation|24px]] '''Sample: '''{{{1}}}

+

[[Image:LogoInformation|24px]] '''Sample:''' {{{1}}}

diff --git a/documentation/trunk/_templates/SeeAlso.tpl b/documentation/trunk/_templates/SeeAlso.tpl index 10e44d86..5cae363f 100644 --- a/documentation/trunk/_templates/SeeAlso.tpl +++ b/documentation/trunk/_templates/SeeAlso.tpl @@ -1,8 +1 @@ -
- - - - - -
[[Image:LogoInformation|24px]]'''See Also: '''{{{1}}}
-
+

[[Image:LogoInformation|24px]] '''See Also:''' {{{1}}}

diff --git a/documentation/trunk/_templates/Tip.tpl b/documentation/trunk/_templates/Tip.tpl index 03afbdfb..fb97fb41 100644 --- a/documentation/trunk/_templates/Tip.tpl +++ b/documentation/trunk/_templates/Tip.tpl @@ -1 +1 @@ -

[[Image:LogoInformation|24px]] '''Tip: '''{{{1}}}

+

[[Image:LogoInformation|24px]] '''Tip: '''{{{1}}}

diff --git a/documentation/trunk/_templates/UnderConstruction.tpl b/documentation/trunk/_templates/UnderConstruction.tpl index 9b75d45a..8690bef8 100644 --- a/documentation/trunk/_templates/UnderConstruction.tpl +++ b/documentation/trunk/_templates/UnderConstruction.tpl @@ -1 +1 @@ -

[[Image:LogoConstruction|24px]] '''Under construction:''' [[How to contribute to documentation#UnderConstruction|see definition]].

+

[[Image:LogoConstruction|24px]] '''Under construction:''' [[How to contribute to documentation#UnderConstruction|see definition]].

diff --git a/documentation/trunk/_templates/UpdateNeeded.tpl b/documentation/trunk/_templates/UpdateNeeded.tpl index 1da61b9e..67c6d834 100644 --- a/documentation/trunk/_templates/UpdateNeeded.tpl +++ b/documentation/trunk/_templates/UpdateNeeded.tpl @@ -1 +1 @@ -

[[Image:LogoUpdateNeeded|24px]] '''Update Needed: '''[[How to contribute to documentation#UpdateNeeded|see definition]].

+

[[Image:LogoUpdateNeeded|24px]] '''Update Needed:''' [[How to contribute to documentation#UpdateNeeded|see definition]].

diff --git a/documentation/trunk/_templates/Warning.tpl b/documentation/trunk/_templates/Warning.tpl index d0116f8b..78c79dcd 100644 --- a/documentation/trunk/_templates/Warning.tpl +++ b/documentation/trunk/_templates/Warning.tpl @@ -1,2 +1 @@ -

[[Image:LogoWarning|24px]] '''Warning:''' {{{1}}}

- +

[[Image:LogoWarning|24px]] '''Warning:''' {{{1}}}

diff --git a/documentation/trunk/_templates/definition.tpl b/documentation/trunk/_templates/definition.tpl index bb26a1a2..b6ee693f 100644 --- a/documentation/trunk/_templates/definition.tpl +++ b/documentation/trunk/_templates/definition.tpl @@ -1 +1 @@ -

[[Image:LogoDefinition|24px]] '''Definition -- {{{1}}}''': {{{2}}}

+

[[Image:LogoDefinition|24px]] '''Definition -- {{{1}}}''': {{{2}}}

diff --git a/documentation/trunk/contribute/documentation.wiki b/documentation/trunk/contribute/documentation.wiki index 0fa73d2c..014fab90 100644 --- a/documentation/trunk/contribute/documentation.wiki +++ b/documentation/trunk/contribute/documentation.wiki @@ -1,6 +1,6 @@ [[Property:title|How to contribute to documentation]] [[Property:link_title|To documentation]] -[[Property:weight|1]] +[[Property:weight|2]] [[Property:uuid|A2DED192-B50A-4E59-B214-FDC3FEDC7A44]] = Current documentation system = diff --git a/documentation/trunk/contribute/editing_help.wiki b/documentation/trunk/contribute/editing_help.wiki new file mode 100644 index 00000000..b2da8d0a --- /dev/null +++ b/documentation/trunk/contribute/editing_help.wiki @@ -0,0 +1,94 @@ +[[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. + += 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. +