Template:MissingInfo/doc: Difference between revisions

Revision as of 06:54, 8 July 2023

Description

Places a box that warns of missing/wanted information on the page.

Syntax

Type {{MissingInfo}} at the start or end of an article.
To specify details, type {{MissingInfo|<details>}}, where <details> is to be replaced with the details of what information must be added.

Usage

Use this template on pages that aren't short or unfinished enough to be stubs, but are missing some needed or wanted information. This automatically places the article in Category:Needs Information, allowing these unfinished pages to be found easily.
It is recommended to add some details on what information is needed using the first parameter.
If you substitute this template AND add your username as a second parameter, it will automatically place Template:Claim using your username (and with the default time of 1 hour). This is rather unideal since it leaves all the template code on the page, but it can be useful when you want to add the missing information yourself within the hour. You can place this template and save the page before beginning your actual edit, then delete all text related to this template after finishing your edit. You could just use the claim template alone...

Parameters

Template parameters
Parameter		Description	Type	Status
Details	`1`	Additional details on what info the page is missing. Can be instructions on what to do in the future. Example Add images to this article.	Content	suggested
Username	`2`	If you wish to place a claim of 1 hour, specify your username here. Only works if you substitute the template. Example Masada	Line	optional

Sample

The following input:

{{MissingInfo|abc}}

Produces:

This page is missing information and is in need of editing or expansion. You can help YumeWiki by inserting the needed information via editing.
To do: abc

Though in actuality the template is being substituted to avoid placing the category.

@@ Line 1: / Line 1: @@
-<big>Currently this is a copy paste of [[Template:Stub/doc]], must be rewritten</big><br>
+==Description==
-;Syntax
+<!--Short summary of what the main function of the template is-->
-:Type <code>{{t|MissingInfo}}</code> at the start or end of an article.
+Places a box that warns of missing/wanted information on the page.
-:To specify details, type <code>{{t|MissingInfo|details}}</code>, where <code><details></code> is to be replaced with the details of why the page is a stub.
+==Syntax==
+Type <code>{{t|MissingInfo}}</code> at the start or end of an article.<br>
-<noinclude>[[Category:Template documentation]]</noinclude>
+To specify details, type <code>{{t|MissingInfo|details}}</code>, where <code><details></code> is to be replaced with the details of what information must be added.
-<templatedata>
+==Usage==
-{
+<!--How to use. Attempt to answer:
-	"params": {
+-	What does it present to the reader?
+-	Why would an editor choose to use it?
+-	What is the recommended use?
+-	What does the template require in order to function?
+-	What can the template NOT do? (limitations)
+-	What are some potential issues that should be kept in mind? (troubleshooting)
+It may be helpful to give examples in this section instead of waiting until "Sample".-->
+Use this template on pages that aren't short or unfinished enough to be [[Template:Stub|stubs]], but are missing some needed or wanted information. This automatically places the article in [[:Category:Needs Information]], allowing these unfinished pages to be found easily.<br>
+It is recommended to add some details on what information is needed using the first parameter.<br>
+If you substitute this template ''AND'' add your username as a second parameter, it will automatically place [[Template:Claim]] using your username (and with the default time of 1 hour). This is rather unideal since it leaves all the template code on the page, but it can be useful when you want to add the missing information yourself within the hour. You can place this template and save the page before beginning your actual edit, then delete all text related to this template after finishing your edit. <span class="spoiler">You could just use the claim template alone...</span>
+==Parameters==
+	<templatedata>{	"description": "","params": {
 		"1": {
 			"label": "Details",
@@ Line 14: / Line 25: @@
 			"type": "content",
 			"suggested": true
-		}
+		},
-	},
+		"2": {
-	"description": "This template will categorize articles that include it into Category:Needs Information, and mark it with a template."
+			"label": "Username",
-}
+			"description": "If you wish to place a claim of 1 hour, specify your username here. Only works if you substitute the template.",
-</templatedata>
+			"example": "Masada",
+			"type": "line"
+			}}}</templatedata>
+==Sample==
+<!--You can use this structure:
+	The following input:
+	<pre>{{Example|param=value|pa..}}<∕pre>
+	Produces:
+	{{Example|param=value|pa..}}
+Here, copy the exact template call from the preformatted section and use that. If the template is heavy when loading you may want to copy the expected output instead, however this has risk of becoming outdated and should be avoided.
+DO NOT COPY THAT <∕pre> YOU SEE IN THIS EXAMPLE, IT WILL NOT WORK
+You may want to format the example across multiple lines like in Template:Locationbox/doc-->
+The following input:
+<pre>{{MissingInfo|abc}}</pre>
+Produces:
+<div style="border: 1px #A2C5AC solid; padding: 0.5em; -webkit-border-radius:10px;">[[File:SHOVEL FLOWER.png|50px]]&nbsp;&nbsp;This page is missing information and is in need of editing or expansion. You can help {{SITENAME}} by inserting the needed information via [{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=edit}} editing].{{#if:abc|<br><span style="padding-left: 5%; font-weight: bold;">''To do: abc''</span>|}}</div>
+{{#if:|{{#if:
+||
+<!--This is where a "claim" template is. If it's gone or not needed, delete it. If you want to update or replace it, do {{subst:claim|YourUsername}}.-->
+{{#ifeq:{{#expr:1>24}}|1|ERROR: Cannot claim for more than 1 day|{{#if:
+|ERROR: must [https://www.mediawiki.org/wiki/Help:Substitution substitute] the template|{{#if:{{{2}}}|{{#ifeq:{{#expr: {{CURRENTTIMESTAMP}} <
+20230708075455}}|1|<div style="border: 1px #967255 solid; padding: 0.5em; -webkit-border-radius:10px;">[[File:MoaiStatue(badgeYN).png|50px]]&nbsp;&nbsp;Planned to be edited by [[User:{{{2}}}]] until
+:54 UTC. Editing now could cause an [[wikipedia:Help:Edit_conflict|edit conflict]]. If you still wish to edit, it's best to [[User talk:{{{2}}}|speak with them]] first. ''[{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=purge}} Refresh]''</div>|}}|ERROR: Did not specify a user}}}}}}
+<!--Code from the "claim" template ends here. Remember to delete these comments if the template is deleted or re-used!-->
+}}|}}
+[[Category:Needs Information]]
+<br>''Though in actuality the template is being substituted to avoid placing the category.''
+<noinclude>__NOTOC__ [[Category:Template Documentation]]</noinclude>
+<includeonly>__NOEDITSECTION__</includeonly>