Jump to content

LabVIEW Wiki:Template index: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
VisualWikitext
m Hide from {{stub}} category
Add "Article overview" and "LabVIEW entities"
Line 121: Line 121:
| This template allows you to list multiple internal links in one sentence. Can be placed anywhere within an article.
| This template allows you to list multiple internal links in one sentence. Can be placed anywhere within an article.
| {{see also|labview|lvoop|error handling|state machine}}
| {{see also|labview|lvoop|error handling|state machine}}
|}
==Article overview==
Use these templates to add general information and a common appearance to articles.
{| class="wikitable"
!Wiki Markup
!Purpose
|-
|{{tlx|infobox}}
|This template adds an info box that summarizes information about an article. It supports different types of articles and parameters. See the template documentation for more details.
|-
|{{tlx|presentation}}
|This template provides a common appearance for presentations. See the template documentation for more details.
|-
|{{tlx|LabVIEW_Version}}
|This template is specifically designed for articles of [[LabVIEW Versions]]. See the template documentation for more details.
|}
==LabVIEW entities==
If you have a need to add LabVIEW-specific entities to an article, make use of the following templates:
{| class="wikitable"
!Markup
!Purpose
|-
|{{tlx|ConnectorPane}}
|This template adds a connector pane image to an article. See the template documentation for more details.
|-
|{{tlx|Terminal}}
|This template adds a terminal image to an article and links to the corresponding content page. See the template documentation for more details.
|-
|{{tlx|LabVIEW_Palette}}
|This template adds a palette overview to an article and links individual palette items to their corresponding content pages. See the template documentation for more details.
|}
|}


Revision as of 17:00, 4 January 2025

The MediaWiki software used to run LabVIEW Wiki offers the capability to automatically generate sophisticated HTML using templates. The list below shows most of the templates that are recommended for use on LabVIEW Wiki, alongside brief explanations of how and where to use them. You may prefer a straightforward list of 'all pages in the 'Template' namespace'.

See also: category:templates and Help:templates

Article status

Wiki Markup Purpose Template Display
{{ActiveDiscuss}} Indicates that there is probably a heated debate going on in the discussion thread for the article that this notice is placed on. It also indicates that the article contents might not meet the general consensus of the LabVIEW community.
This article or section is currently being developed or reviewed.
Some statements may be disputed, incorrect, unverified, biased or otherwise objectionable. Please read the discussion thread before making substantial changes.
{{inuse}} The Inuse template message is placed at the top of a page you are actively editing for a short period of time. The tag is intended to inform people that someone is currently working on the article, thereby reducing edit conflicts.
This page is actively undergoing a major edit for a short while.
As a courtesy, please do not edit this page while this message is displayed. The user who added this notice will be listed in the page history. If this page has not been edited for several hours, please remove this template, or replace it with {{underconstruction}}. This message is intended to help reduce edit conflicts; please remove it between editing sessions to allow others to edit the page.
{{Underconstruction}} The Underconstruction template message is placed at the top of a page you are editing over a long period of time. If used on a non-article page which is not yet ready for use, type {{underconstruction|notready=true}}.
This page is under construction.
This page or section is currently in the middle of an expansion or major revamping.

However, you are welcome to assist in its construction by editing it as well. Please view the edit history should you wish to contact the person who placed this template. If this article has not been edited in several days please remove this template. Please don't delete this page unless the page hasn't been edited in several days.

While actively editing, consider adding {{inuse}} to reduce edit conflicts.
{{NIGuideline}} Indicates that the article is considered a guideline that has been approved by National Instruments and is widely accepted by the LabVIEW community.
This page is considered a National Instruments guideline. It is generally accepted among the LabVIEW community and is considered a standard process that all LabVIEW users should follow. However, it is not set in stone and should be treated with common sense and the occasional exception. When editing this page, please ensure that your revision reflects consensus. When in doubt, discuss first on this page's discussion thread.

Articles needing attention

Use these tags to mark articles that need attention. Tags should be placed at the start of a page (use the talk page to describe the issue if it's not clear by context).

Wiki Markup Purpose Template Display
{{Stub}} Indicates that the article is considered a stub.
This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.
{{wikify}} Indicates that the article needs more internal links and wikification.
This article or section needs to be wikified to meet LabVIEW Wiki's quality standards.
Please help improve this article with relevant internal links.
{{cleanup}} Indicates that the page has been flagged for cleanup.
This article may require cleanup to meet LabVIEW Wiki's quality standards.
Please improve this article if you can.
{{update}} Indicates that the page is out of date and should be updated.
This article or section needs to be updated. Some information on it may be out of date, and should not be relied on.
Please improve this article if you can.

General information notices

Wiki Markup Purpose Template Display
{{ambox

|text=Some text can go here which brings attention to a specific article issue.}}

The ambox template is a very powerful template that allows you to create one of many standard pre-formated message boxes. You can change the image and colour. If you can't find an existing message box template, it's better to use the ambox template than create a new one. See Template:Ambox for detailed usage documentation.
Some text can go here which brings attention to a specific article issue.

Content insertion

Wiki Markup Purpose Template Display
{{Labviewconfigurationkey

| keyname = copyDeleteFPDCOFromFPTerm
| example = copyDeleteFPDCOFromFPTerm=TRUE
| datatype = b
| description = Delete front panel terminals from diagram
| permitted_values = TRUE or FALSE
| default = FALSE
| LV1 = 3
| LV2 = 4
| LV3 = 5
| LV4 = 6
| LV5 = 7
| LV6 = 8
| OS1 = w
| OS2 = m
| OS3 = l
| OS4 = u
| notes =
}}

This template is used to document the LabVIEW configuration file settings and is used primarily on the LabVIEW configuration file documentation. See Template:Labviewconfigurationkey for detailed usage documentation. == copyDeleteFPDCOFromFPTerm ==
Example copyDeleteFPDCOFromFPTerm=TRUE
Description Delete front panel terminals from diagram
Datatype Boolean
Permitted Values TRUE or FALSE
Default Value FALSE
LabVIEW Versions

3.x , 4.x , 5.x , 6.x , 7.x , 8.x

OS's Supported

Notes
{{see also

|labview
|lvoop
|error handling
|state machine
}}

This template allows you to list multiple internal links in one sentence. Can be placed anywhere within an article.
See also: labview, lvoop, error handling, and state machine

Article overview

Use these templates to add general information and a common appearance to articles.

Wiki Markup Purpose
{{infobox}} This template adds an info box that summarizes information about an article. It supports different types of articles and parameters. See the template documentation for more details.
{{presentation}} This template provides a common appearance for presentations. See the template documentation for more details.
{{LabVIEW_Version}} This template is specifically designed for articles of LabVIEW Versions. See the template documentation for more details.

LabVIEW entities

If you have a need to add LabVIEW-specific entities to an article, make use of the following templates:

Markup Purpose
{{ConnectorPane}} This template adds a connector pane image to an article. See the template documentation for more details.
{{Terminal}} This template adds a terminal image to an article and links to the corresponding content page. See the template documentation for more details.
{{LabVIEW_Palette}} This template adds a palette overview to an article and links individual palette items to their corresponding content pages. See the template documentation for more details.

See also

Retrieved from "https://labviewwiki.org/w/index.php?title=LabVIEW_Wiki:Template_index&oldid=35413"