TemplateTests: Difference between revisions
No edit summary |
m (Garryp moved page TutorialTemplateTests to TemplateTests: Removed "Tutorial" from name to stop page showing in searches for that keyword.) |
||
(30 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{UnderConstruction|This page is only for testing the tutorial templates. It's got no use other than that but it's a good place to see all of them at once.}} | |||
{{AnnotationIcons}} | |||
== Annotations == | |||
These can be used to give the reader a little bit more information related to the main text. | |||
{{InlineAnnotation|note|This is a basic in-line annotation on its own line.}} | |||
Or, if you want something different… | |||
This line has an in-line annotation{{InlineAnnotation|info|'''in the middle of it'''}}which can come in useful. | |||
Or, what about this… | |||
{{InlineAnnotation|caution|An in-line annotation can have a border round it.|border}} | |||
Or, how about… | |||
The same goes for one {{InlineAnnotation|idea|that's within a line|border}} like this. | |||
Just make sure you put a line of normal text between lines with in-line annotations on them. (I don't know why there's a problem otherwise.) | |||
{{Annotation|experiment|This is a long <u>filled</u> annotation with a surrounding box. This can be used when you don't want the text to wrap to the start of the next line under the icon and annotation type text.|fill}} | |||
Or... | |||
{{Annotation2|tip|This is an unfilled annotation. It's like the other one but is has no background fill so it blends in with the text a bit more.}} | |||
{{ | == Callouts == | ||
These can be used to give the reader some extra information or to call attention to a specific concept. | |||
[[File:under_construction_small.png|frame|Figure 8]] | |||
{{Callout|idea|Callout|This is a Callout. It can be used to give the reader some extra information about a concept in the main text. Notice that it "gets out of the way" of any floated images on the right.}} | |||
== InfoBoxes == | |||
These can be used to give the reader some options to jump away to. | |||
Use a <nowiki>{{clear}}</nowiki> afterwards for the text to start on the next normal text line, if that's what you want. | |||
Third | {{InfoBox|3|First Subject|tutorial_template_infobox_example1.png|{{InlineAnnotation|info|Find out more about [[Subject]]}}|[[First Link]]<br />[[Second Link]]<br />[[Third Link]]}} | ||
{{InfoBox|3|Second Thing|tutorial_template_infobox_example2.png|See more info on [[Things]]|If you just want to jump straight to it then choose from the list below:<br />[[First Link]]<br />[[Second Link]]<br />[[Third Link]]}} | |||
{{InfoBox|3|Third Whatnot||This InfoBox has no image|[[First Link]]<br />[[Second Link]]<br />[[Third Link]]}} | |||
{{clear}} | |||
== Menus == | |||
You can use these templates when telling the reader which menu choice to make. | |||
For instance, they can choose menu {{Menuitem|File}} → {{Menuitem|Open…}} | |||
{{ | Or, they can right-click and choose {{Menuitem|Get Text…}} from the menu. | ||
== Menu Strings == | |||
You can use these templates when telling the reader which menu choice to make. They're easier to use than multiple Menuitems. | |||
{{ | For instance, they can choose menu {{MenuString|File|Open…}} | ||
== Buttons == | |||
You can use these templates to show when the reader should press a specific button. | |||
{{ | For instance, they can click the {{Button|OK}} button. | ||
Or, they can press {{Button|Finish}} to complete the process. | |||
== Windows == | |||
You can use these templates to show when the user should open, or go to, a particular window. | |||
Go to {{Window|Properties|icons}} ⟩⟩ {{Window|X, Y, Z}} and change the X and Y positions. | |||
{{ | |||
{{ | |||
Latest revision as of 12:33, 30 March 2015
List of Valid Annotation and Callout Icons
Annotations
These can be used to give the reader a little bit more information related to the main text.
Or, if you want something different…
This line has an in-line annotation
which can come in useful.
Or, what about this…
Or, how about…
The same goes for one
like this.
Just make sure you put a line of normal text between lines with in-line annotations on them. (I don't know why there's a problem otherwise.)
Or... Template:Annotation2
Callouts
These can be used to give the reader some extra information or to call attention to a specific concept.
InfoBoxes
These can be used to give the reader some options to jump away to.
Use a {{clear}} afterwards for the text to start on the next normal text line, if that's what you want.
First Link
Second Link
Third Link
Menus
You can use these templates when telling the reader which menu choice to make.
For instance, they can choose menu File → Open…
Or, they can right-click and choose Get Text… from the menu.
Menu Strings
You can use these templates when telling the reader which menu choice to make. They're easier to use than multiple Menuitems.
For instance, they can choose menu File → Open…
Buttons
You can use these templates to show when the reader should press a specific button.
For instance, they can click the OK button. Or, they can press Finish to complete the process.
Windows
You can use these templates to show when the user should open, or go to, a particular window.
Go to Properties ⟩⟩ X, Y, Z and change the X and Y positions.