Template:Software header/doc

This is a template intended for use in software books where the version of software referenced is important. This version is intended for use at the top of pages or sections; for a sidebox version, see {{software sidebox}}.

Usage

{{software header|scope=page|name=Inkscape|version=0.47|type===}}

• |scope= should be book, page, or section. This allows the template to be used for whole books, individual pages of books, or individual sections of pages. Defaults to book.
• |name= is the name of the software, in this case, Inkscape. Defaults to a linked version of the book's name.
• |version= is the version of the software in question, in this case 0.47.
• |type= is one of:
  • >>, meaning the text references a future version of the software. version should be the number of this future version.
  • >, meaning the text references version and all newer versions. version should contain and newer in the text, for example 0.46 and newer.
  • ~=, meaning the text references a family of versions; for example 0.4x.
  • ==, meaning the text references a specific version.
  • <, meaning the text references an out-of-date, older version but shouldn't necessarily be removed (in cases where older versions of software might still be in common use), or
  • <<, meaning the text references an obsolete version likely not in-use by anyone in the book's audience.
• |multi=true is an optional parameter to show the line "Multiple versions of name are covered in this scope." Use this if |version= covers more than one version.
• |uses=true is an optional parameter to replace "applies to" with "uses", if a book is not specifically about the software but instead requires the use of certain software.

Examples

{{software header|scope=page|name=Inkscape|version=0.47|type===}}

This page applies only to version 0.47 of Inkscape.

{{software header|name=Inkscape|version=0.46 and newer|type=>}}

This book applies to version 0.46 and newer of Inkscape.

{{software header|scope=page|name=[[Inkscape]]|version=0.4x|type=~=|multi=true}}

This page applies to version 0.4x of Inkscape. Multiple versions of Inkscape are covered in this page.

{{software header|scope=section|name=Inkscape|version=0.45|type=<|uses=true}}

This section uses version 0.45 of Inkscape. This version is considered deprecated. If you are using a current version, this information may not apply to you.

{{software header|name=Inkscape|version=0.42|type=<<}}

This book applies to version 0.42 of Inkscape. This version is considered obsolete and some or all of this information does not apply to any current version of this software. Please help out and update this information by editing this page.

{{software header|name=Inkscape|version=0.48|type=>>}}

This book applies to version 0.48 of Inkscape. This book applies to a newer release of Inkscape.

{{software header|scope=page|name=Inkscape|version=0.47}}

This page applies to version 0.47 of Inkscape. The usage of this template includes no type parameter. Please correct this by editing this page.

See also

• {{software sidebox}}