Template:Annotation: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
(Added new |fill parameter to examples.)
(Replaced entirely by new version.)
Line 1: Line 1:
<includeonly>{{#if: {{{2|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent; margin-top:0.5em;border:2px {{#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;{{#if: {{{3|}}}|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>
<includeonly><div style="border: solid 1px {{#switch: {{{1}}} | note = #D3A12A | idea = #D3A12A | info = #64A2E7 | help = #696CC3 | tip = #CEEF76 | experiment = #9FD361 | development = #F28D48 | caution = #DD3745 | technical = #99A6AD | recovery = #DD656B | warning = #F2C327 | danger = #000000 | stop = #4DA9D1 | idea = #F5C569 | #D3A12A}}; border-left: solid 10px {{#switch: {{{1}}} | note = #D3A12A | info = #64A2E7 | help = #696CC3 | tip = #CEEF76 | experiment = #9FD361 | development = #F28D48 | caution = #DD3745 | technical = #99A6AD | recovery = #DD656B | warning = #F2C327 | urgent = #000000 | danger = #000000 | stop = #4DA9D1 | idea = #F5C569 | #D3A12A}}; border-radius: 4px; padding: 0px; margin: 0px; overflow: auto;{{#if: {{{3|}}}|background-color: {{#switch: {{{1}}} | note = #F2DEA9 | idea = #F2DEA9 | info = #B3D1EF | help = #B8BCED | tip = #E1F4AB | experiment = #D7EDAA | development = #F4CDA8 | caution = #ED939A | technical = #C7C8C9 | recovery = #EA9DA1 | warning = #F7E694 | danger = #A0A0A0 | stop = #90D2ED | idea = #F5E589 | #F2DEA9}}}}"><div style="border-radius: inherit;"><div style="float: left; width: 48px; border-top-left-radius: 4px; border-bottom-left-radius: 4px; padding: 8px 8px 8px 8px;">[[File:tutorial_template_icon_{{{1|note}}}.png|Warning|link=]]</div><div style="padding: 8px; margin-left: 60px;">{{{2}}}</div></div></div></includeonly><!--
<noinclude>
--><noinclude>== Annotation Template ==
== Annotation Template ==
This template is currently being tested only on the Tutorials.
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.
You can use it if you want to but you might notice some changes you didn't expect.
For annotations without a box you need to put a blank line before it unless you want it to be part of the line before it.
{{AnnotationIcons}}
=== Basic Annotation ===
== Examples ==
Basic annotation can be used for a quick note.
=== Note ===
A note can be used to give the reader a little more information about what's going on.
 
{{Annotation2|note|This is a short note but notice that the box always fills the space available.}}
Or you can have the same thing but filled&hellip;
{{Annotation2|note|This is a long <u>filled</u> 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.|fill}}


{{Annotation}}Basic annotation.
=== Idea ===
An idea can be given to give the read a bit more info.


=== Note ===
{{Annotation2|idea|This is a long idea. 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.}}
A note can be used to give the reader a little more information about what's going on.
Or you can have the same thing but filled&hellip;
{{Annotation2|idea|This is a long <u>filled</u> idea. 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.|fill}}


{{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.|fill}}
=== Info ===
=== Info ===
An info can 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.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|info|This is a long <u>filled</u> 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.|fill}}
=== Help ===
A help can be given to link the reader to further help if they should need it.


{{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.|fill}}
=== Tip ===
=== Tip ===
A tip can 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.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|tip|This is a long <u>filled</u> 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.|fill}}
 
=== Experiment ===
=== Experiment ===
An experiment can 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.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|experiment|This is a long <u>filled</u> 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.|fill}}
 
=== Development ===
=== Development ===
A development can 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.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|development|This is a long <u>filled</u> 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.|fill}}
 
=== Caution ===
=== Caution ===
A caution can 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.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|caution|This is a long <u>filled</u> 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.|fill}}
 
=== Technical ===
=== Technical ===
A technical can be given to tell the reader that what comes next might be beyond the "average" reader.
A technical can be given to tell the reader that what comes next might be beyond the "average" reader.


{{Annotation|technical}}Basic technical.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|technical|This is a long <u>filled</u> 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.|fill}}
 
=== Recovery ===
=== Recovery ===
A recovery can 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.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|recovery|This is a long <u>filled</u> 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.|fill}}
 
=== Warning ===
=== Warning ===
A warning can 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.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|warning|This is a long <u>filled</u> 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.|fill}}
=== Urgent ===
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|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.|fill}}
=== Danger ===
=== Danger ===
A danger can 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.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|danger|This is a long <u>filled</u> 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.|fill}}
 
=== Stop ===
=== 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.
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.
{{Annotation2|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.}}
Or you can have the same thing but filled&hellip;
{{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.|fill}}
{{Annotation2|stop|This is a long <u>filled</u> 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.|fill}}
</noinclude>
</noinclude>

Revision as of 12:53, 13 February 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.

List of Valid Annotation and Callout Icons

Warning
is for a note
Warning
is for an idea
Warning
is for an info
Warning
is for a tip
Warning
is for an experiment
Warning
is for development
Warning
is for a caution
Warning
is for technical
Warning
is for recovery
Warning
is for a warning
Warning
is for danger
Warning
is for stop

Examples

Note

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Idea

An idea can be given to give the read a bit more info.

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Info

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Tip

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Experiment

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Development

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Caution

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Technical

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Recovery

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Warning

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

Danger

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

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2

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.

Template:Annotation2 Or you can have the same thing but filled… Template:Annotation2