Template:Annotation: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>
<noinclude>
'''Annotation Template'''
== Annotation Template ==
This is a work in progress. Don't use it yet.
This template is currently being tested only on the Tutorials.
You can use it if you want to but you might notice some changes you didn't expect.
</noinclude>
</noinclude>
{{#if: {{{2|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent; margin-top:0.5em;border:1px {{#switch: {{{1}}} | note = #D4D36D | info | help = #6DBCD4 | tip | experiment = #6DD480 | development | caution = #D49C6D | technical | recovery = #a0a0a0 | warning | urgent = #D46D6D | danger = #CF5242 | stop = #6D7DD4 | #D4D36D}} solid;padding:0.5em;background-color: {{#switch: {{{1}}} | note = #F4F38D | info | help = #8DDCF4 | tip | experiment = #8DF4A0 | development | caution = #F4BC8D | technical | recovery = #c0c0c0 | warning | urgent = #F48D8D | danger = #EF7262 | stop = #8D9DF4 | #F4F38D}}"><tr><td nowrap="nowrap" valign="top">}}<span style="position: relative; top: -2px;">[[File:tutorial_template_icon_{{{1|note}}}.png|32px|Warning|link=]]</span> '''{{#switch: {{{1}}} | note = Note: | info = Info: | help = Help: | tip = Tip: | experiment = Experiment: | development = Development: | caution = CAUTION: | technical = TECHNICAL: | recovery = RECOVERY: | warning = WARNING: | urgent = URGENT: | danger = DANGER: | stop = STOP: | Note:}}''' {{#if: {{{2|}}}|</td><td valign="top" style="padding-left:0.5em;">{{{2|}}}</td></tr></table>}}
<includeonly>{{#if: {{{2|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent; margin-top:0.5em;border:1px {{#switch: {{{1}}} | note = #D4D36D | info | help = #6DBCD4 | tip | experiment = #6DD480 | development | caution = #D49C6D | technical | recovery = #a0a0a0 | warning | urgent = #D46D6D | danger = #CF5242 | stop = #6D7DD4 | #D4D36D}} solid;padding:0.5em;background-color: {{#switch: {{{1}}} | note = #F4F38D | info | help = #8DDCF4 | tip | experiment = #8DF4A0 | development | caution = #F4BC8D | technical | recovery = #c0c0c0 | warning | urgent = #F48D8D | danger = #EF7262 | stop = #8D9DF4 | #F4F38D}}"><tr><td nowrap="nowrap" valign="top">}}<span style="position: relative; top: -2px;">[[File:tutorial_template_icon_{{{1|note}}}.png|32px|Warning|link=]]</span> '''{{#switch: {{{1}}} | note = Note: | info = Info: | help = Help: | tip = Tip: | experiment = Experiment: | development = Development: | caution = CAUTION: | technical = TECHNICAL: | recovery = RECOVERY: | warning = WARNING: | urgent = URGENT: | danger = DANGER: | stop = STOP: | Note:}}''' {{#if: {{{2|}}}|</td><td valign="top" style="padding-left:0.5em;">{{{2|}}}</td></tr></table>}}</includeonly>
<noinclude>
<noinclude>
=== Basic Annotation ===
=== Basic Annotation ===
Basic annotation can be used for a quick note.
{{Annotation}}Basic annotation.
{{Annotation}}Basic annotation.


=== Note ===
=== Note ===
A note should be used to give the reader a little more information about what's going on.
A note can be used to give the reader a little more information about what's going on.
{{Annotation|note}}Basic note.
{{Annotation|note}}Basic note.
{{Annotation|note|This is a long note. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|note|This is a long note. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Info ===
=== Info ===
An info should be used to expand a little on what the reader has just read.
An info can be used to expand a little on what the reader has just read.
{{Annotation|info}}Basic info.
{{Annotation|info}}Basic info.
{{Annotation|info|This is a long info. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|info|This is a long info. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Help ===
=== Help ===
A help should be given to link the reader to further help if they should need it.
A help can be given to link the reader to further help if they should need it.
{{Annotation|help}}Basic help.
{{Annotation|help}}Basic help.
{{Annotation|help|This is a long help. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|help|This is a long help. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Tip ===
=== Tip ===
A tip should be given to show the reader that there's a quicker way of doing something.
A tip can be given to show the reader that there's a quicker way of doing something.
{{Annotation|tip}}Basic tip.
{{Annotation|tip}}Basic tip.
{{Annotation|tip|This is a long tip. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|tip|This is a long tip. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Experiment ===
=== Experiment ===
An experiment should be used to coax the reader into trying something slightly different for themselves.
An experiment can be used to coax the reader into trying something slightly different for themselves.
{{Annotation|experiment}}Basic experiment.
{{Annotation|experiment}}Basic experiment.
{{Annotation|experiment|This is a long experiment. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|experiment|This is a long experiment. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Development ===
=== Development ===
A development should be added for readers who want to try the development version.
A development can be added for readers who want to try the development version.
{{Annotation|development}}Basic development.
{{Annotation|development}}Basic development.
{{Annotation|development|This is a long development. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|development|This is a long development. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Caution ===
=== Caution ===
A caution should be given if what the reader is going to do next might cause some concern.
A caution can be given if what the reader is going to do next might cause some concern.
{{Annotation|caution}}Basic caution.
{{Annotation|caution}}Basic caution.
{{Annotation|caution|This is a long caution. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|caution|This is a long caution. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Technical ===
=== Technical ===
A technical should be shown to either tell the reader that what comes next might be beyond the "average" reader.
A technical can be shown to either tell the reader that what comes next might be beyond the "average" reader.
{{Annotation|technical}}Basic technical.
{{Annotation|technical}}Basic technical.
{{Annotation|technical|This is a long technical. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|technical|This is a long technical. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Recovery ===
=== Recovery ===
A recovery should be given telling the reader how to recover from something they might have done by mistake.
A recovery can be given telling the reader how to recover from something they might have done by mistake.
{{Annotation|recovery}}Basic recovery.
{{Annotation|recovery}}Basic recovery.
{{Annotation|recovery|This is a long recovery. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|recovery|This is a long recovery. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Warning ===
=== Warning ===
A warning should be given if what the reader is going to do next might have bad consequences.
A warning can be given if what the reader is going to do next might have bad consequences.
{{Annotation|warning}}Basic warning.
{{Annotation|warning}}Basic warning.
{{Annotation|warning|This is a long warning. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|warning|This is a long warning. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Urgent ===
=== Urgent ===
An urgent should be given if the reader really has to have some extra information before they do anything else.
An urgent can be given if the reader really has to have some extra information before they do anything else.
{{Annotation|urgent}}Basic urgent.
{{Annotation|urgent}}Basic urgent.
{{Annotation|urgent|This is a long urgent. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|urgent|This is a long urgent. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Danger ===
=== Danger ===
A danger should be given if the reader is about to do something that might change something permanently.
A danger can be given if the reader is about to do something that might change something permanently.
{{Annotation|danger}}Basic danger.
{{Annotation|danger}}Basic danger.
{{Annotation|danger|This is a long danger. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|danger|This is a long danger. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}


=== Stop ===
=== Stop ===
A stop should be shown when the reader has got to a point in the article where they don't need to continue, for whatever reason.
A stop can be shown when the reader has got to a point in the article where they don't need to continue, for whatever reason.
{{Annotation|stop}}Basic stop.
{{Annotation|stop}}Basic stop.
{{Annotation|stop|This is a long stop. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
{{Annotation|stop|This is a long stop. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.}}
</noinclude>
</noinclude>

Revision as of 13:59, 30 January 2015

Annotation Template

This template is currently being tested only on the Tutorials. You can use it if you want to but you might notice some changes you didn't expect.


Basic Annotation

Basic annotation can be used for a quick note.

Warning Note: Basic annotation.

Note

A note can be used to give the reader a little more information about what's going on.

Warning Note: Basic note.

Warning Note: This is a long note. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Info

An info can be used to expand a little on what the reader has just read.

Warning Info: Basic info.

Warning Info: This is a long info. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Help

A help can be given to link the reader to further help if they should need it.

Warning Help: Basic help.

Warning Help: This is a long help. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Tip

A tip can be given to show the reader that there's a quicker way of doing something.

Warning Tip: Basic tip.

Warning Tip: This is a long tip. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Experiment

An experiment can be used to coax the reader into trying something slightly different for themselves.

Warning Experiment: Basic experiment.

Warning Experiment: This is a long experiment. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Development

A development can be added for readers who want to try the development version.

Warning Development: Basic development.

Warning Development: This is a long development. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Caution

A caution can be given if what the reader is going to do next might cause some concern.

Warning CAUTION: Basic caution.

Warning CAUTION: This is a long caution. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Technical

A technical can be shown to either tell the reader that what comes next might be beyond the "average" reader.

Warning TECHNICAL: Basic technical.

Warning TECHNICAL: This is a long technical. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Recovery

A recovery can be given telling the reader how to recover from something they might have done by mistake.

Warning RECOVERY: Basic recovery.

Warning RECOVERY: This is a long recovery. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Warning

A warning can be given if what the reader is going to do next might have bad consequences.

Warning WARNING: Basic warning.

Warning WARNING: This is a long warning. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Urgent

An urgent can be given if the reader really has to have some extra information before they do anything else.

Warning URGENT: Basic urgent.

Warning URGENT: This is a long urgent. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Danger

A danger can be given if the reader is about to do something that might change something permanently.

Warning DANGER: Basic danger.

Warning DANGER: This is a long danger. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.


Stop

A stop can be shown when the reader has got to a point in the article where they don't need to continue, for whatever reason.

Warning STOP: Basic stop.

Warning STOP: This is a long stop. It should be in a box so this text is quite long to show that it wraps properly across the page without going under the icon because that would look sloppy.