Help:Templates

A "template" is a small Shifti page in the template namespace that one can insert into the body of another page via a process called "transclusion". Templates are denoted using curley brackets instead of square brackets.

Story formatting

These templates are useful for adding a title and author byline or section headers in a standardized manner.

Templates for some story markup

Template Code	Displayed template
{{title |name=name of page |author=page author |user=shifti user name}} Full documentation available at Template:Title	User| Example | Example}}[[Title::{{#ifeq: Help |User| Example | Example}}| ]] {{#ifeq: | | {{#ifeq: {{#ifeq: Help |User| Example | Example}} | | {{#ifeq: {{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}} | || Author: [[User:{{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}}|{{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}}]] [[Author::{{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}}| ]] }} | {{#ifeq: {{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}} | | Author: {{#ifeq: Help |User| Example | Example}} | Author: [[User:{{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}}|{{#ifeq: Help |User| Example | Example}}]] [[Author::{{#ifeq: Help |User| Example | Example}}| ]] }} }} | {{#ifeq: {{#ifeq: Help |User| Example | Example}} | | {{#ifeq: {{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}} | | Authors: ' | Authors: [[User:{{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}}|{{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}}]] }} | {{#ifeq: {{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}} | | Authors: {{#ifeq: Help |User| Example | Example}} | Author: [[User:{{#ifeq: Help |User| Templates | {{#ifeq: Help |User| Example | Example}}}}|{{#ifeq: Help |User| Example | Example}}]] }} }} }} {{#if:| — see [[:Category:{{{category}}}|other works by this author]]}}
{{dropcap|O}}nce upon a time...	Once upon a time there was a lovely little template for creating "drop caps" at the beginning of a story - ie, a very large letter descending below the first line that the text in subsequent lines flows around. See Template:dropcap for more extensive description and example text.
{{author's note|This template is for...}}	This template is for formatting a bit of text before the main story begins, to be used as an out-of-story "intro" where the author can say whatever he'd like to say about the story. For example, one could use it to explain where the idea for the story came from, or other background details about why it was written.

Decorative dingbats

Template:Separator allows the use of a variety of separator "dingbats", or decorative images, for dividing up a story in a fancy way. The template takes three parameters; an identifier determining which particular image to use, an optional bit of text to insert in the middle of the separator, and an optional parameter to define the width of the images in pixels.

One may include wiki markup in the text, for example the following uses boldface:

{{Separator|f|'''The End'''}}

One may also combine a separator with a header, like so:

=={{separator|f|Chapter 7: The Bit With The Cheese}}==

Make sure to put the header markup outside the separator template rather than inside with the text.

You can override the default image widths (200 pixels for the text-free image, 100 pixels for the text-bracketing images) by inserting a third parameter indicating how wide in pixels each image should be:

{{Separator|f|Text|200px}}

To override the default width for the text-free image use an empty text parameter:

{{Separator|f||300px}}

Tags to indicate content or status

The following content warning templates may be used at the start of a story page to alert readers to potentially displeasing content they may encounter in the story and to inform them of the story's status:

Tags to be placed at the top of stories

Template code	Displayed template
{{Universe|Universe Name}}	{{#if:Jigsaw green.png|}} Icon Universe Name story universe
{{editing requested}}	{{#if:Icono copyedit2.png|}} Icon Copyediting is welcome {{#ifeq:Help|Help||}}
{{Comment tag}}	{{#if:Speech balloon.png|}} Icon Add new comment {{#ifexist: Help talk:Templates | (read old comments)}}
{{XXX}}	{{#if:Triple X.png|}} Icon This story contains adult content. {{#ifeq:Help|Help||}}
{{WIP}}	{{#if:Work in progress.png|}} Icon This story is a work in progress. {{#ifeq:Help|Help||}}
{{Hiatus}}	{{#if:Clock warning.png|}} Icon Work on this story is on hiatus. {{#ifeq:Help|Help||}}
{{Stopped}}	{{#if:Clock stopped.png|}} Icon No further updates are expected. {{#ifeq:Help|Help||}}

When multiple tags are placed at the top of the same page they automatically group themselves in a column. These tags are all optional, though in some cases we may insist on the use of the adult content tag ("adult content" can sometimes be highly subjective so we'll only require its use in obvious cases. In borderline cases it's merely polite).

These tags are all generated using Template:Float tag (see template page for full documentation). If you want, you can use float tag directly to create your own custom tags. For example:

Template code	Displayed template
{{float tag|text=This story is intended for people who like apples. If you don't like apples, you may not enjoy this much.}}	{{#if:|}} [[Image:{{{icon}}}|30px|center|Icon]] This story is intended for people who like apples. If you don't like apples, you may not enjoy this much.

In addition to these simple tags, there's the "info" template that's useful for combining a large number of different bits of information in the upper right corner. You can use this instead of the above tags or in conjunction with them, in whatever combination you like.

}}{{#if:author name|}}{{#if:author website|}}{{#if:the genre of the story|{{#if:series name|{{#if:link to previous story in series|}}{{#if:link to next story in series|}}}}{{#if:universe|}}}}

Info omnibus tag

Template code	Displayed template
{{info |author= author name |title= story title |website= author website |contact= author email |setting= universe |series= series name |position= position of story in series |previous= link to previous story in series |next= link to next story in series |genre= the genre of the story }}
	story title
Author:	{{#if:author email|email author name|author name}}
Website:	author website
Genre:	the genre of the story
Series:	series name {{#if:position of story in series|(#position of story in series)}}
Previous:	link to previous story in series
Next:	link to next story in series
Setting/Universe:	universe

All of the parameters used in the example above are optional, if you don't want to use one of them just omit it and it won't appear in the info box.

Linking stories in a series

These templates are handy for creating nicely formatted and easy to find links between stories that form a connected series. This is intended primarily for stories that should be read in a specific order, not necessarily stories that are simply set in the same general universe; for those it is normally enough to just put that shared setting's category on the story.

The first template, series box, is intended to be used at the top of the story. It tucks itself away to the right, allowing the text of the story to flow around it. The second template, series bar, is horizontally oriented and centered on the page. It's intended for use down at the bottom of the story, though if you like it works at the top just fine as well.

All three parameters are optional and can be omitted.

Template code	Displayed template
{{series box |series=Series name |previous=[[Previous story]] |next=[[Next story]]}}	{{#if:Previous story| }}{{#if:Next story| }}
{{series bar |series=Series name |previous=[[Previous story]] |next=[[Next story]]}}	Preceded by: Previous story Series name{{#if:| (First: {{{first}}})}} Succeeded by: Next story

Templates for suggesting edits within story text

These templates may be useful for collaborative editing. They allow an editor to add notes to a story making suggestions about things that he or she thinks should be changed, similar to the wiki's built-in function for displaying the differences between revisions of a page but without having to go digging into the article's revision history to find it.

Templates for suggesting edits within story text

Template code	Displayed template
{{add|text to add}}	text to add
{{remove|text to remove}}	text to remove
{{replace|text to remove|text to replace it with}}	text to removetext to replace it with
{{note|note text}}	note text