Template:Preview Only Infobox - Revision history

Spiffly: corrected a mistake in the code

2024-09-13T23:16:54Z

corrected a mistake in the code

← Older revision		Revision as of 23:16, 13 September 2024
Line 43:		Line 43:
	<pre>-->\|#default = }}</pre><br>		<pre>-->\|#default = }}</pre><br>
	'''Step 4:''' Add the following code to the top of the original template page in question. To continue our example, this would be on page [[:Template:Used In]].		'''Step 4:''' Add the following code to the top of the original template page in question. To continue our example, this would be on page [[:Template:Used In]].
	<pre>< includeonly >< onlyinclude > {{~~Item Statistics~~/Help\|{{{1}}}}}< /onlyinclude >< /includeonly ></pre>		<pre>< includeonly >< onlyinclude > {{Template Name/Help\|{{{1}}}}}< /onlyinclude >< /includeonly ></pre>

	If an "<nowiki>< includeonly ></nowiki>" and/or "<nowiki>< onlyinclude ></nowiki>" are already present on the template page, simply slot this code in above everything, on the very first line.<br><br>		If an "<nowiki>< includeonly ></nowiki>" and/or "<nowiki>< onlyinclude ></nowiki>" are already present on the template page, simply slot this code in above everything, on the very first line.<br><br>

Spiffly at 12:36, 13 September 2024

2024-09-13T12:36:36Z

← Older revision		Revision as of 12:36, 13 September 2024
Line 67:		Line 67:
	'''Step 3:''' Replace "preview message" with your own. This can include custom boilerplates, additional documentation, transclusions etc.<br>		'''Step 3:''' Replace "preview message" with your own. This can include custom boilerplates, additional documentation, transclusions etc.<br>

	'''Step 4:''' Find "\| #default = ". If it is set as blank, skip to step 5. If it is set to display the <nowiki>{{Preview Only Infobox/Default</nowiki> list of commands, update it to reflect the following. ~~Still complete step 5 next~~.		'''Step 4:''' Find "\| #default = ". If it is set as blank, skip to step 5. If it is set to display the <nowiki>{{Preview Only Infobox/Default</nowiki> list of commands, update it to reflect the following. The '''extra #''' and '''extra # message''' can be used 1 through to 10.
	<pre>		<pre>
	-->\|#default = {{Preview Only Infobox\|{{Preview Only Infobox/Default		-->\|#default = {{Preview Only Infobox\|{{Preview Only Infobox/Default

Spiffly: further grammar changes. realised a step was missing on optional steps so also added

2024-09-12T23:35:58Z

further grammar changes. realised a step was missing on optional steps so also added

← Older revision		Revision as of 23:35, 12 September 2024
Line 2:		Line 2:
	==Usage==		==Usage==
	This template was originally designed to provide help and support to editors when viewing a page in "preview mode". It's since been expanded upon and now provides several different versions of preview mode assistance that will hopefully help editors even further.		This template was originally designed to provide help and support to editors when viewing a page in "preview mode". It's since been expanded upon and now provides several different versions of preview mode assistance that will hopefully help editors even further.
	* To see a full list of existing ~~template~~ with this feature, please see [[:Template:Preview Only Infobox/List\|this page]].		* To see a full list of existing templates with this feature, please see [[:Template:Preview Only Infobox/List\|this page]].
	* If you would like to test out a good example then I recommend you ~~try~~ out the [[Template:Item Statistics\|Item Statistics]] template.		* If you would like to test out a good preview only infobox example then I recommend you check out the [[Template:Item Statistics\|Item Statistics]] template.
	* You can also visit the [[:Template:Item Statistics/Help\|Item Statistics/Help]] page and checkout the code.		* You can also visit the [[:Template:Item Statistics/Help\|Item Statistics/Help]] page and checkout the code.

Line 11:		Line 11:
	'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>		'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>
	'''Step 2:''' Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.<br><br>		'''Step 2:''' Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.<br><br>
	Unfortunately the wiki markups '''<nowiki>< pre ></nowiki>''' & '''<nowiki>< includeonly ></nowiki>''' cannot be displayed correctly, due to ~~their~~ function. When copy and pasting this section, please '''remove the spaces''' from these markups. There's two <nowiki>< includeonly ></nowiki>'s that can be found both at the very beginning and very end of the code. There is also two <nowiki>< pre >'s</nowiki> that can be found within the "boilerplate" and "help" sections.		Unfortunately the wiki markups '''<nowiki>< pre ></nowiki>''' & '''<nowiki>< includeonly ></nowiki>''' cannot be displayed correctly, due to how they function. When copy and pasting this section, please '''remove the spaces''' from these markups. There's two <nowiki>< includeonly ></nowiki>'s that can be found both at the very beginning and very end of the code. There is also two <nowiki>< pre >'s</nowiki> that can be found within the "boilerplate" and "help" sections.

	<pre>< includeonly >{{#switch:{{lc:{{{1\|}}}}}<!--		<pre>< includeonly >{{#switch:{{lc:{{{1\|}}}}}<!--
Line 67:		Line 67:
	'''Step 3:''' Replace "preview message" with your own. This can include custom boilerplates, additional documentation, transclusions etc.<br>		'''Step 3:''' Replace "preview message" with your own. This can include custom boilerplates, additional documentation, transclusions etc.<br>

	'''Step 4:''' Find ~~the~~ " #default " ~~command and~~ update it to reflect the following.		'''Step 4:''' Find "\| #default = ". If it is set as blank, skip to step 5. If it is set to display the <nowiki>{{Preview Only Infobox/Default</nowiki> list of commands, update it to reflect the following. Still complete step 5 next.
	<pre>		<pre>
	-->\|#default = {{Preview Only Infobox\|{{Preview Only Infobox/Default		-->\|#default = {{Preview Only Infobox\|{{Preview Only Infobox/Default
Line 73:		Line 73:
	\| extra 1 message = description of the ??? command.		\| extra 1 message = description of the ??? command.
	}}}}}}</pre>		}}}}}}</pre>
	'''Step 5:''' ~~As in step 2, replace the ???~~ with the command ~~name~~ of ~~choice~~.<br>		'''Step 5:''' Now find "\| command = ". Update this with the same code as step 4 above but using "\| command = " in place of " \|#default = ".<br>

	'''Step 6:''' Replace the description to briefly inform the editor of its purpose. The new command will now automatically appear in the preview window.		'''Step 6:''' As in step 2, replace the ??? with the command name of choice.<br>

			'''Step 7:''' Replace the description to briefly inform the editor of its purpose. The new command will now automatically appear in the preview window.

	<!--preserving the orignially documentation and some hopefully unneeded code.		<!--preserving the orignially documentation and some hopefully unneeded code.

Spiffly: typo and re-orderd initial paragraph

2024-09-12T23:18:22Z

typo and re-orderd initial paragraph

← Older revision		Revision as of 23:18, 12 September 2024
Line 1:		Line 1:
	<onlyinclude><includeonly>{{#switch:{{{disable\|}}}\|no documentation\|no doc\|ncnd\|ndnc\|nd=\|#default={{#if:{{REVISIONID}}\|\|<div style="border: 4px #AA0000 solid;"><div style="margin: 4px; padding: 4px; text-align: center; font-weight: bold; color: #AA0000; font-size: 1.6em;">This Documentation is only visible in preview mode!</div>{{{1\|}}}</div>}}}}</includeonly></onlyinclude>		<onlyinclude><includeonly>{{#switch:{{{disable\|}}}\|no documentation\|no doc\|ncnd\|ndnc\|nd=\|#default={{#if:{{REVISIONID}}\|\|<div style="border: 4px #AA0000 solid;"><div style="margin: 4px; padding: 4px; text-align: center; font-weight: bold; color: #AA0000; font-size: 1.6em;">This Documentation is only visible in preview mode!</div>{{{1\|}}}</div>}}}}</includeonly></onlyinclude>
	==Usage==		==Usage==
	This template was originally designed to provide help and support to editors when viewing a page in "preview mode". It's since been expanded upon and now provides several different versions of preview mode assistance that will hopefully help editors even further. To see a full list of existing template with this feature, please see [[:Template:Preview Only Infobox/List\|this page]]. If you would like to add this feature to a template, follow the ~~stepw~~ below.		This template was originally designed to provide help and support to editors when viewing a page in "preview mode". It's since been expanded upon and now provides several different versions of preview mode assistance that will hopefully help editors even further.
	<br>		* To see a full list of existing template with this feature, please see [[:Template:Preview Only Infobox/List\|this page]].
			* If you would like to test out a good example then I recommend you try out the [[Template:Item Statistics\|Item Statistics]] template.
			* You can also visit the [[:Template:Item Statistics/Help\|Item Statistics/Help]] page and checkout the code.

			If you would like to add this feature to a template, follow the steps below.
			<br><br>

	'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>		'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>

Spiffly: added additional steps for optional extra commands

2024-09-12T22:55:11Z

added additional steps for optional extra commands

@@ Line 48: / Line 48: @@
 '''Step 7:''' Test that it works! The following commands will appear when you type the code <nowiki>{{Template Name|}}</nowiki> on any page.
-{{#section:Template:Preview Only Infobox/Default|commands}}<!--
+{{#section:Template:Preview Only Infobox/Default|commands}}
-preserving the orignially documentation and some hopefully unneeded code.
+== Optional Steps ==
 *'''First unnamed Parameter''' (optional): You can set the first unnamed parameter to:

Spiffly: clarified the need to remove spaces from "pre's" and "includeonly's"

2024-09-12T13:24:22Z

clarified the need to remove spaces from "pre's" and "includeonly's"

← Older revision		Revision as of 13:24, 12 September 2024
Line 6:		Line 6:
	'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>		'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>
	'''Step 2:''' Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.<br><br>		'''Step 2:''' Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.<br><br>
	Unfortunately the <nowiki><pre></~~pre~~></nowiki> ~~tags~~ cannot be displayed correctly due to ~~the nature of how they work~~. When copy and pasting this section, ~~manually close out~~ the ~~second~~ <nowiki></pre></nowiki> ~~tag for both~~ the "boilerplate" and "help" sections.		Unfortunately the wiki markups '''<nowiki>< pre ></nowiki>''' & '''<nowiki>< includeonly ></nowiki>''' cannot be displayed correctly, due to their function. When copy and pasting this section, please '''remove the spaces''' from these markups. There's two <nowiki>< includeonly ></nowiki>'s that can be found both at the very beginning and very end of the code. There is also two <nowiki>< pre >'s</nowiki> that can be found within the "boilerplate" and "help" sections.

	<pre>< includeonly >{{#switch:{{lc:{{{1\|}}}}}<!--		<pre>< includeonly >{{#switch:{{lc:{{{1\|}}}}}<!--

Line 13:		Line 14:
	<pre>{{Template Name		<pre>{{Template Name
	\| = add as many parameters as required		\| = add as many parameters as required
	}}<pre>\|disable={{{1\|}}}}}<!--		}}< /pre>\|disable={{{1\|}}}}}<!--

	-->\|help =		-->\|help =
Line 19:		Line 20:
	<pre>{{Template Name		<pre>{{Template Name
	\| parameter = {short explanation on how each one should be filled out}		\| parameter = {short explanation on how each one should be filled out}
	}}<pre>\|disable={{{1\|}}}}}<!--		}}< /pre>\|disable={{{1\|}}}}}<!--

	-->\|fd = {{Preview Only Infobox\|{{Template:Name/Documentation}}		-->\|fd = {{Preview Only Infobox\|{{Template:Name/Documentation}}
Line 37:		Line 38:
	<pre>-->\|#default = }}</pre><br>		<pre>-->\|#default = }}</pre><br>
	'''Step 4:''' Add the following code to the top of the original template page in question. To continue our example, this would be on page [[:Template:Used In]].		'''Step 4:''' Add the following code to the top of the original template page in question. To continue our example, this would be on page [[:Template:Used In]].
	<pre>< includeonly >< onlyinclude >{{Item Statistics/Help\|{{{1}}}}}< /onlyinclude >< /includeonly ></pre>		<pre>< includeonly >< onlyinclude > {{Item Statistics/Help\|{{{1}}}}}< /onlyinclude >< /includeonly ></pre>

	If an "<nowiki>< includeonly ></nowiki>" and/or "<nowiki>< onlyinclude ></nowiki>" are already present on the template page, simply slot this code in above everything, on the very first line.<br><br>		If an "<nowiki>< includeonly ></nowiki>" and/or "<nowiki>< onlyinclude ></nowiki>" are already present on the template page, simply slot this code in above everything, on the very first line.<br><br>

Aramachus: put spaces into pre and nowiki versions of includeonly and onlyinclude so they arent rendered accidentially as tags. resolved the error.

2024-09-11T12:52:33Z

put spaces into pre and nowiki versions of includeonly and onlyinclude so they arent rendered accidentially as tags. resolved the error.

← Older revision		Revision as of 12:52, 11 September 2024
Line 6:		Line 6:
	'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>		'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>
	'''Step 2:''' Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.<br><br>		'''Step 2:''' Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.<br><br>
	Unfortunately the <nowiki>< pre >< /pre ></nowiki> tags cannot be displayed correctly due to the nature of how they work. When copy and pasting this section, manually close out the second <nowiki>< /pre ></nowiki> tag for both the "boilerplate" and "help" sections.		Unfortunately the <nowiki><pre></pre></nowiki> tags cannot be displayed correctly due to the nature of how they work. When copy and pasting this section, manually close out the second <nowiki></pre></nowiki> tag for both the "boilerplate" and "help" sections.
	<pre><includeonly>{{#switch:{{lc:{{{1\|}}}}}<!--		<pre>< includeonly >{{#switch:{{lc:{{{1\|}}}}}<!--

	-->\|bp\|boilerplate =		-->\|bp\|boilerplate =
Line 32:		Line 32:

	-->\|#default = {{Preview Only Infobox\|{{Preview Only Infobox/Default}}}}}}		-->\|#default = {{Preview Only Infobox\|{{Preview Only Infobox/Default}}}}}}
	</includeonly></pre><br>		</ includeonly ></pre><br>

	'''Step 3:''' Decide whether you would prefer the preview only infobox to display as default or when the editor "turns it on". The copied text from step 2 is set to display as default. To change this, change the <nowiki>#default</nowiki> line to the following:		'''Step 3:''' Decide whether you would prefer the preview only infobox to display as default or when the editor "turns it on". The copied text from step 2 is set to display as default. To change this, change the <nowiki>#default</nowiki> line to the following:
	<pre>-->\|#default = }}</pre><br>		<pre>-->\|#default = }}</pre><br>
	'''Step 4:''' Add the following code to the top of the original template page in question. To continue our example, this would be on page [[:Template:Used In]].		'''Step 4:''' Add the following code to the top of the original template page in question. To continue our example, this would be on page [[:Template:Used In]].
	<pre><includeonly><onlyinclude>{{Item Statistics/Help\|{{{1}}}}}</onlyinclude></includeonly></pre>		<pre>< includeonly >< onlyinclude >{{Item Statistics/Help\|{{{1}}}}}< /onlyinclude >< /includeonly ></pre>

	If an "<nowiki>< includeonly ></nowiki>" and/or "<nowiki>< onlyinclude ></nowiki>" are already present on the template page, simply slot this code in above everything, on the very first line.<br><br>		If an "<nowiki>< includeonly ></nowiki>" and/or "<nowiki>< onlyinclude ></nowiki>" are already present on the template page, simply slot this code in above everything, on the very first line.<br><br>
Line 47:		Line 47:

	'''Step 7:''' Test that it works! The following commands will appear when you type the code <nowiki>{{Template Name\|}}</nowiki> on any page.		'''Step 7:''' Test that it works! The following commands will appear when you type the code <nowiki>{{Template Name\|}}</nowiki> on any page.
	~~<!--~~{{#section:Template:Preview Only Infobox/Default\|commands}}~~-->~~<!--		{{#section:Template:Preview Only Infobox/Default\|commands}}<!--

	preserving the orignially documentation and some hopefully unneeded code.		preserving the orignially documentation and some hopefully unneeded code.

Aramachus: trying if removing the section transclusion removes the error

2024-09-11T12:46:01Z

trying if removing the section transclusion removes the error

← Older revision		Revision as of 12:46, 11 September 2024
Line 47:		Line 47:

	'''Step 7:''' Test that it works! The following commands will appear when you type the code <nowiki>{{Template Name\|}}</nowiki> on any page.		'''Step 7:''' Test that it works! The following commands will appear when you type the code <nowiki>{{Template Name\|}}</nowiki> on any page.
	{{#section:Template:Preview Only Infobox/Default\|commands}}<!--		<!--{{#section:Template:Preview Only Infobox/Default\|commands}}--><!--

	preserving the orignially documentation and some hopefully unneeded code.		preserving the orignially documentation and some hopefully unneeded code.

Aramachus: trying if spaces in the nowiki code resolves the error

2024-09-11T12:44:12Z

trying if spaces in the nowiki code resolves the error

← Older revision		Revision as of 12:44, 11 September 2024
Line 1:		Line 1:
	<onlyinclude><includeonly>{{#switch:{{{disable\|}}}\|no documentation\|no doc\|ncnd\|ndnc\|nd=\|#default={{#if:{{REVISIONID}}\|\|<div style="border: 4px #AA0000 solid;"><div style="margin: 4px; padding: 4px; text-align: center; font-weight: bold; color: #AA0000; font-size: 1.6em;">This Documentation is only visible in preview mode!</div>{{{1\|}}}</div>}}}}</includeonly></onlyinclude>		<onlyinclude><includeonly>{{#switch:{{{disable\|}}}\|no documentation\|no doc\|ncnd\|ndnc\|nd=\|#default={{#if:{{REVISIONID}}\|\|<div style="border: 4px #AA0000 solid;"><div style="margin: 4px; padding: 4px; text-align: center; font-weight: bold; color: #AA0000; font-size: 1.6em;">This Documentation is only visible in preview mode!</div>{{{1\|}}}</div>}}}}</includeonly></onlyinclude>
			==Usage==
			This template was originally designed to provide help and support to editors when viewing a page in "preview mode". It's since been expanded upon and now provides several different versions of preview mode assistance that will hopefully help editors even further. To see a full list of existing template with this feature, please see [[:Template:Preview Only Infobox/List\|this page]]. If you would like to add this feature to a template, follow the stepw below.
			<br>

			'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>
			'''Step 2:''' Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.<br><br>
			Unfortunately the <nowiki>< pre >< /pre ></nowiki> tags cannot be displayed correctly due to the nature of how they work. When copy and pasting this section, manually close out the second <nowiki>< /pre ></nowiki> tag for both the "boilerplate" and "help" sections.
			<pre><includeonly>{{#switch:{{lc:{{{1\|}}}}}<!--

			-->\|bp\|boilerplate =
			{{Preview Only Infobox\|These parameters are the ones most commmonly used for the Horizon server.
			<pre>{{Template Name
			\| = add as many parameters as required
			}}<pre>\|disable={{{1\|}}}}}<!--

			-->\|help =
			{{Preview Only Infobox\|
			<pre>{{Template Name
			\| parameter = {short explanation on how each one should be filled out}
			}}<pre>\|disable={{{1\|}}}}}<!--

			-->\|fd = {{Preview Only Infobox\|{{Template:Name/Documentation}}
			\|disable={{{1\|}}}}}<!--

			-->\|nd\|no documentation = <!--

			-->\|list = {{Preview Only Infobox\|{{Preview Only Infobox/List}}
			\|disable={{{1\|}}}}}<!--

			-->\|command\|commands = {{Preview Only Infobox\|{{Preview Only Infobox/Default}}}}<!--

			-->\|#default = {{Preview Only Infobox\|{{Preview Only Infobox/Default}}}}}}
			</includeonly></pre><br>

			'''Step 3:''' Decide whether you would prefer the preview only infobox to display as default or when the editor "turns it on". The copied text from step 2 is set to display as default. To change this, change the <nowiki>#default</nowiki> line to the following:
			<pre>-->\|#default = }}</pre><br>
			'''Step 4:''' Add the following code to the top of the original template page in question. To continue our example, this would be on page [[:Template:Used In]].
			<pre><includeonly><onlyinclude>{{Item Statistics/Help\|{{{1}}}}}</onlyinclude></includeonly></pre>

			If an "<nowiki>< includeonly ></nowiki>" and/or "<nowiki>< onlyinclude ></nowiki>" are already present on the template page, simply slot this code in above everything, on the very first line.<br><br>

			'''Step 5:''' If your template page has documentation, it needs moving to its own sub-page. In our example, this would be moved to [[:Template:Used In/Documentation]]. This documentation then needs transcluding back onto the template page. To do this use this following code and if this step isn't completed, the command "fd" sadly won't work.
			<pre>{{Template Name/Documentation}}</pre><br>

			'''Step 6:''' Add the template to the list of templates that have preview window infoboxes on [[:Template:Preview Only Infobox/List\|this page]].<br>

			'''Step 7:''' Test that it works! The following commands will appear when you type the code <nowiki>{{Template Name\|}}</nowiki> on any page.
			{{#section:Template:Preview Only Infobox/Default\|commands}}<!--

			preserving the orignially documentation and some hopefully unneeded code.

			*'''First unnamed Parameter''' (optional): You can set the first unnamed parameter to:
			** ''nc'' (no category) to prevent automatic categorization (e.g. for example pages)
			** ''nd'' (no documentation) to suppress the preview documentation (helpful in the editing process)
			** ''ncnd'' or ''ndnc'' prevents both, categorization of the page as well as showing a documentation in preview mode. Again, most useful for example pages.
			** ''bp'' (boilerplate) to have the preview documentation without comments so you can just copy it to the page (helpful for creating new pages to just start with {{fontaccent\|<nowiki>{{</nowiki>{{PAGENAME}}<nowiki>\|bp}}</nowiki>}} and copy the boilerplate from the preview only)
			-->


			<!--This Template will provide an infobox that is only visible in preview mode. Main usage is template documentation for very common templates with many options.

			''Note: The preview infobox can be disabled with the parameter "disable" e.g. when giving examples on other template pages. Disable can be set to anything, the infobox will only show if disable is empty.''

			Example:

			<pre>{{Preview Only Infobox\|<pre>
			{{Mission Header
			\| Mission Name = {Name of the Mission}
			\| Expansion = {Series of the Missions}
			\| Start = {NPC name that starts the quest}
			\| Start Location = {Location template}
			\| Description = {Ingame Mission Description}
			\| Level = {Required Level to complete the Mission}
			\| Requirements = {Requirements to ACCEPT the Mission}
			\| Items Needed = {Items Needed to COMPLETE the Mission}
			\| Repeatable = {yes/no}
			\| Title = {Title(s) obtained thoughout the mission
			\| Rewards = {Rewards obtained for COMPLETING the Mission}
			\| Previous = {previous mission: link{{!}}name}
			\| Next = {next mission: link{{!}}name}
			}}</ pre>
			</pre>

			{{Preview Only Infobox\|
			<pre>
			{{Mission Header
			\| Mission Name = {Name of the Mission}
			\| Expansion = {Series of the Missions}
			\| Start = {NPC name that starts the quest}
			\| Start Location = {Location template}
			\| Description = {Ingame Mission Description}
			\| Level = {Required Level to complete the Mission}
			\| Requirements = {Requirements to ACCEPT the Mission}
			\| Items Needed = {Items Needed to COMPLETE the Mission}
			\| Repeatable = {yes/no}
			\| Title = {Title(s) obtained thoughout the mission
			\| Rewards = {Rewards obtained for COMPLETING the Mission}
			\| Previous = {previous mission: link{{!}}name}
			\| Next = {next mission: link{{!}}name}
			}}</pre>
			}}-->

Aramachus: removing documentation to test if it caused an error

2024-09-11T12:39:14Z

removing documentation to test if it caused an error

← Older revision		Revision as of 12:39, 11 September 2024
Line 1:		Line 1:
	<onlyinclude><includeonly>{{#switch:{{{disable\|}}}\|no documentation\|no doc\|ncnd\|ndnc\|nd=\|#default={{#if:{{REVISIONID}}\|\|<div style="border: 4px #AA0000 solid;"><div style="margin: 4px; padding: 4px; text-align: center; font-weight: bold; color: #AA0000; font-size: 1.6em;">This Documentation is only visible in preview mode!</div>{{{1\|}}}</div>}}}}</includeonly></onlyinclude>		<onlyinclude><includeonly>{{#switch:{{{disable\|}}}\|no documentation\|no doc\|ncnd\|ndnc\|nd=\|#default={{#if:{{REVISIONID}}\|\|<div style="border: 4px #AA0000 solid;"><div style="margin: 4px; padding: 4px; text-align: center; font-weight: bold; color: #AA0000; font-size: 1.6em;">This Documentation is only visible in preview mode!</div>{{{1\|}}}</div>}}}}</includeonly></onlyinclude>
	~~==Usage==~~
	This template was originally designed to provide help and support to editors when viewing a page in "preview mode". It's since been expanded upon and now provides several different versions of preview mode assistance that will hopefully help editors even further. To see a full list of existing template with this feature, please see [[:Template:Preview Only Infobox/List\|this page]]. If you would like to add this feature to a template, follow the stepw below.
	~~<br>~~

	~~'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>~~
	'''Step 2:''' Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.<br><br>
	Unfortunately the <nowiki><pre></pre></nowiki> tags cannot be displayed correctly due to the nature of how they work. When copy and pasting this section, manually close out the second <nowiki></pre></nowiki> tag for both the "boilerplate" and "help" sections.
	~~<pre><includeonly>{{#switch:{{lc:{{{1\|}}}}}<!--~~

	~~-->\|bp\|boilerplate =~~
	~~{{Preview Only Infobox\|These parameters are the ones most commmonly used for the Horizon server.~~
	~~<pre>{{Template Name~~
	~~\| = add as many parameters as required~~
	~~}}<pre>\|disable={{{1\|}}}}}<!--~~

	~~-->\|help =~~
	~~{{Preview Only Infobox\|~~
	~~<pre>{{Template Name~~
	~~\| parameter = {short explanation on how each one should be filled out}~~
	~~}}<pre>\|disable={{{1\|}}}}}<!--~~

	~~-->\|fd = {{Preview Only Infobox\|{{Template:Name/Documentation}}~~
	~~\|disable={{{1\|}}}}}<!--~~

	~~-->\|nd\|no documentation = <!--~~

	~~-->\|list = {{Preview Only Infobox\|{{Preview Only Infobox/List}}~~
	~~\|disable={{{1\|}}}}}<!--~~

	~~-->\|command\|commands = {{Preview Only Infobox\|{{Preview Only Infobox/Default}}}}<!--~~

	~~-->\|#default = {{Preview Only Infobox\|{{Preview Only Infobox/Default}}}}}}~~
	~~</includeonly></pre><br>~~

	'''Step 3:''' Decide whether you would prefer the preview only infobox to display as default or when the editor "turns it on". The copied text from step 2 is set to display as default. To change this, change the <nowiki>#default</nowiki> line to the following:
	~~<pre>-->\|#default = }}</pre><br>~~
	~~'''Step 4:''' Add the following code to the top of the original template page in question. To continue our example, this would be on page [[:Template:Used In]].~~
	~~<pre><includeonly><onlyinclude>{{Item Statistics/Help\|{{{1}}}}}</onlyinclude></includeonly></pre>~~

	~~If an "<nowiki><includeonly></nowiki>" and/or "<nowiki><onlyinclude></nowiki>" are already present on the template page, simply slot this code in above everything, on the very first line.<br><br>~~

	'''Step 5:''' If your template page has documentation, it needs moving to its own sub-page. In our example, this would be moved to [[:Template:Used In/Documentation]]. This documentation then needs transcluding back onto the template page. To do this use this following code and if this step isn't completed, the command "fd" sadly won't work.
	~~<pre>{{Template Name/Documentation}}</pre><br>~~

	~~'''Step 6:''' Add the template to the list of templates that have preview window infoboxes on [[Template:Preview Only Infobox/List\|this page]].<br>~~

	~~'''Step 7:''' Test that it works! The following commands will appear when you type the code <nowiki>{{Template Name\|}}</nowiki> on any page.~~
	~~{{#section:Template:Preview Only Infobox/Default\|commands}}<!--~~

	~~preserving the orignially documentation and some hopefully unneeded code.~~

	*'''First unnamed Parameter''' (optional): You can set the first unnamed parameter to:
	** ''nc'' (no category) to prevent automatic categorization (e.g. for example pages)
	** ''nd'' (no documentation) to suppress the preview documentation (helpful in the editing process)
	** ''ncnd'' or ''ndnc'' prevents both, categorization of the page as well as showing a documentation in preview mode. Again, most useful for example pages.
	** ''bp'' (boilerplate) to have the preview documentation without comments so you can just copy it to the page (helpful for creating new pages to just start with {{fontaccent\|<nowiki>{{</nowiki>{{PAGENAME}}<nowiki>\|bp}}</nowiki>}} and copy the boilerplate from the preview only)
	~~-->~~


	~~<!--This Template will provide an infobox that is only visible in preview mode. Main usage is template documentation for very common templates with many options.~~

	''Note: The preview infobox can be disabled with the parameter "disable" e.g. when giving examples on other template pages. Disable can be set to anything, the infobox will only show if disable is empty.''

	~~Example:~~

	~~<pre>{{Preview Only Infobox\|<pre>~~
	~~{{Mission Header~~
	~~\| Mission Name = {Name of the Mission}~~
	~~\| Expansion = {Series of the Missions}~~
	~~\| Start = {NPC name that starts the quest}~~
	~~\| Start Location = {Location template}~~
	~~\| Description = {Ingame Mission Description}~~
	~~\| Level = {Required Level to complete the Mission}~~
	~~\| Requirements = {Requirements to ACCEPT the Mission}~~
	~~\| Items Needed = {Items Needed to COMPLETE the Mission}~~
	~~\| Repeatable = {yes/no}~~
	~~\| Title = {Title(s) obtained thoughout the mission~~
	~~\| Rewards = {Rewards obtained for COMPLETING the Mission}~~
	~~\| Previous = {previous mission: link{{!}}name}~~
	~~\| Next = {next mission: link{{!}}name}~~
	~~}}</ pre>~~
	~~</pre>~~

	~~{{Preview Only Infobox\|~~
	~~<pre>~~
	~~{{Mission Header~~
	~~\| Mission Name = {Name of the Mission}~~
	~~\| Expansion = {Series of the Missions}~~
	~~\| Start = {NPC name that starts the quest}~~
	~~\| Start Location = {Location template}~~
	~~\| Description = {Ingame Mission Description}~~
	~~\| Level = {Required Level to complete the Mission}~~
	~~\| Requirements = {Requirements to ACCEPT the Mission}~~
	~~\| Items Needed = {Items Needed to COMPLETE the Mission}~~
	~~\| Repeatable = {yes/no}~~
	~~\| Title = {Title(s) obtained thoughout the mission~~
	~~\| Rewards = {Rewards obtained for COMPLETING the Mission}~~
	~~\| Previous = {previous mission: link{{!}}name}~~
	~~\| Next = {next mission: link{{!}}name}~~
	~~}}</pre>~~
	~~}}-->~~

← Older revision		Revision as of 12:39, 11 September 2024
Line 1:		Line 1:
	<onlyinclude><includeonly>{{#switch:{{{disable\|}}}\|no documentation\|no doc\|ncnd\|ndnc\|nd=\|#default={{#if:{{REVISIONID}}\|\|<div style="border: 4px #AA0000 solid;"><div style="margin: 4px; padding: 4px; text-align: center; font-weight: bold; color: #AA0000; font-size: 1.6em;">This Documentation is only visible in preview mode!</div>{{{1\|}}}</div>}}}}</includeonly></onlyinclude>		<onlyinclude><includeonly>{{#switch:{{{disable\|}}}\|no documentation\|no doc\|ncnd\|ndnc\|nd=\|#default={{#if:{{REVISIONID}}\|\|<div style="border: 4px #AA0000 solid;"><div style="margin: 4px; padding: 4px; text-align: center; font-weight: bold; color: #AA0000; font-size: 1.6em;">This Documentation is only visible in preview mode!</div>{{{1\|}}}</div>}}}}</includeonly></onlyinclude>
	~~==Usage==~~
	This template was originally designed to provide help and support to editors when viewing a page in "preview mode". It's since been expanded upon and now provides several different versions of preview mode assistance that will hopefully help editors even further. To see a full list of existing template with this feature, please see [[:Template:Preview Only Infobox/List\|this page]]. If you would like to add this feature to a template, follow the stepw below.
	~~<br>~~

	~~'''Step 1:''' Create a new sub-page of the template in question. As our example: [[:Template:Used In/Help]]<br><br>~~
	'''Step 2:''' Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.<br><br>
	Unfortunately the <nowiki><pre></pre></nowiki> tags cannot be displayed correctly due to the nature of how they work. When copy and pasting this section, manually close out the second <nowiki></pre></nowiki> tag for both the "boilerplate" and "help" sections.
	~~<pre><includeonly>{{#switch:{{lc:{{{1\|}}}}}<!--~~

	~~-->\|bp\|boilerplate =~~
	~~{{Preview Only Infobox\|These parameters are the ones most commmonly used for the Horizon server.~~
	~~<pre>{{Template Name~~
	~~\| = add as many parameters as required~~
	~~}}<pre>\|disable={{{1\|}}}}}<!--~~

	~~-->\|help =~~
	~~{{Preview Only Infobox\|~~
	~~<pre>{{Template Name~~
	~~\| parameter = {short explanation on how each one should be filled out}~~
	~~}}<pre>\|disable={{{1\|}}}}}<!--~~

	~~-->\|fd = {{Preview Only Infobox\|{{Template:Name/Documentation}}~~
	~~\|disable={{{1\|}}}}}<!--~~

	~~-->\|nd\|no documentation = <!--~~

	~~-->\|list = {{Preview Only Infobox\|{{Preview Only Infobox/List}}~~
	~~\|disable={{{1\|}}}}}<!--~~

	~~-->\|command\|commands = {{Preview Only Infobox\|{{Preview Only Infobox/Default}}}}<!--~~

	~~-->\|#default = {{Preview Only Infobox\|{{Preview Only Infobox/Default}}}}}}~~
	~~</includeonly></pre><br>~~

	'''Step 3:''' Decide whether you would prefer the preview only infobox to display as default or when the editor "turns it on". The copied text from step 2 is set to display as default. To change this, change the <nowiki>#default</nowiki> line to the following:
	~~<pre>-->\|#default = }}</pre><br>~~
	~~'''Step 4:''' Add the following code to the top of the original template page in question. To continue our example, this would be on page [[:Template:Used In]].~~
	~~<pre><includeonly><onlyinclude>{{Item Statistics/Help\|{{{1}}}}}</onlyinclude></includeonly></pre>~~

	~~If an "<nowiki><includeonly></nowiki>" and/or "<nowiki><onlyinclude></nowiki>" are already present on the template page, simply slot this code in above everything, on the very first line.<br><br>~~

	'''Step 5:''' If your template page has documentation, it needs moving to its own sub-page. In our example, this would be moved to [[:Template:Used In/Documentation]]. This documentation then needs transcluding back onto the template page. To do this use this following code and if this step isn't completed, the command "fd" sadly won't work.
	~~<pre>{{Template Name/Documentation}}</pre><br>~~

	~~'''Step 6:''' Add the template to the list of templates that have preview window infoboxes on [[Template:Preview Only Infobox/List\|this page]].<br>~~

	~~'''Step 7:''' Test that it works! The following commands will appear when you type the code <nowiki>{{Template Name\|}}</nowiki> on any page.~~
	~~{{#section:Template:Preview Only Infobox/Default\|commands}}<!--~~

	~~preserving the orignially documentation and some hopefully unneeded code.~~

	*'''First unnamed Parameter''' (optional): You can set the first unnamed parameter to:
	** ''nc'' (no category) to prevent automatic categorization (e.g. for example pages)
	** ''nd'' (no documentation) to suppress the preview documentation (helpful in the editing process)
	** ''ncnd'' or ''ndnc'' prevents both, categorization of the page as well as showing a documentation in preview mode. Again, most useful for example pages.
	** ''bp'' (boilerplate) to have the preview documentation without comments so you can just copy it to the page (helpful for creating new pages to just start with {{fontaccent\|<nowiki>{{</nowiki>{{PAGENAME}}<nowiki>\|bp}}</nowiki>}} and copy the boilerplate from the preview only)
	~~-->~~


	~~<!--This Template will provide an infobox that is only visible in preview mode. Main usage is template documentation for very common templates with many options.~~

	''Note: The preview infobox can be disabled with the parameter "disable" e.g. when giving examples on other template pages. Disable can be set to anything, the infobox will only show if disable is empty.''

	~~Example:~~

	~~<pre>{{Preview Only Infobox\|<pre>~~
	~~{{Mission Header~~
	~~\| Mission Name = {Name of the Mission}~~
	~~\| Expansion = {Series of the Missions}~~
	~~\| Start = {NPC name that starts the quest}~~
	~~\| Start Location = {Location template}~~
	~~\| Description = {Ingame Mission Description}~~
	~~\| Level = {Required Level to complete the Mission}~~
	~~\| Requirements = {Requirements to ACCEPT the Mission}~~
	~~\| Items Needed = {Items Needed to COMPLETE the Mission}~~
	~~\| Repeatable = {yes/no}~~
	~~\| Title = {Title(s) obtained thoughout the mission~~
	~~\| Rewards = {Rewards obtained for COMPLETING the Mission}~~
	~~\| Previous = {previous mission: link{{!}}name}~~
	~~\| Next = {next mission: link{{!}}name}~~
	~~}}</ pre>~~
	~~</pre>~~

	~~{{Preview Only Infobox\|~~
	~~<pre>~~
	~~{{Mission Header~~
	~~\| Mission Name = {Name of the Mission}~~
	~~\| Expansion = {Series of the Missions}~~
	~~\| Start = {NPC name that starts the quest}~~
	~~\| Start Location = {Location template}~~
	~~\| Description = {Ingame Mission Description}~~
	~~\| Level = {Required Level to complete the Mission}~~
	~~\| Requirements = {Requirements to ACCEPT the Mission}~~
	~~\| Items Needed = {Items Needed to COMPLETE the Mission}~~
	~~\| Repeatable = {yes/no}~~
	~~\| Title = {Title(s) obtained thoughout the mission~~
	~~\| Rewards = {Rewards obtained for COMPLETING the Mission}~~
	~~\| Previous = {previous mission: link{{!}}name}~~
	~~\| Next = {next mission: link{{!}}name}~~
	~~}}</pre>~~
	~~}}-->~~