Template:Doc - Revision history

Komidore64 at 17:29, 6 December 2020

2020-12-06T17:29:34Z

Komidore64: replace instances of `with Code template`


2020-08-29T02:06:21Z
replace instances of <code> with Code template

				
				
				
				
				
				← Older revision
				Revision as of 02:06, 29 August 2020
				
Line 4:
Line 4:
  == Usage ==   == Usage ==
    
− Create a subpage of the template called <code>doc</code>, place a <code><nowiki>{{doc/start}}</nowiki></code> at the start of your documentation, and <code><nowiki>{{doc/end}}</nowiki></code> at the end. + Create a subpage of the template called {{code|doc}}, place a {{code|<nowiki>{{doc/start}}</nowiki>}} at the start of your documentation, and {{code|<nowiki>{{doc/end}}</nowiki>}} at the end.
    
− On the main template page add <code><nowiki>&lt;noinclude&gt;{{clear}}{{doc}}&lt;/noinclude&gt;</nowiki></code> on a newline at the end of the template. + On the main template page add {{code|<nowiki>&lt;noinclude&gt;{{clear}}{{doc}}&lt;/noinclude&gt;</nowiki>}} on a newline at the end of the template.
    
  Documentation subpages will automatically be added to [[:Category:Documentation templates]].   Documentation subpages will automatically be added to [[:Category:Documentation templates]].
Line 14:
Line 14:
  === clear ===   === clear ===
    
− If your main template page has floating content and you would like to stop it from going over the documentation, put <code><nowiki>{{doc/start|clear}}</nowiki></code> instead of <code><nowiki>{{doc/start}}</nowiki></code> on your documentation page. + If your main template page has floating content and you would like to stop it from going over the documentation, put {{code|<nowiki>{{doc/start|clear}}</nowiki>}} instead of {{code|<nowiki>{{doc/start}}</nowiki>}} on your documentation page.
    
− This is also useful for templates not using <code><nowiki>&lt;includeonly&gt;</nowiki></code> tags, as it will put some space between the template and the documentation box. + This is also useful for templates not using {{code|<nowiki>&lt;includeonly&gt;</nowiki>}} tags, as it will put some space between the template and the documentation box.
    
  === nodoc=1 ===   === nodoc=1 ===
    
− If a template has no documentation and you don't know how to use it, put <code><nowiki>{{doc/start|nodoc=1}}</nowiki></code> (or if the template needs clear as well, <code><nowiki>{{doc/start|clear|nodoc=1}}</nowiki></code>) instead of <code><nowiki>{{doc/start}}</nowiki></code> on your documentation page. + If a template has no documentation and you don't know how to use it, put {{code|<nowiki>{{doc/start|nodoc=1}}</nowiki>}} (or if the template needs clear as well, {{code|<nowiki>{{doc/start|clear|nodoc=1}}</nowiki>}}) instead of {{code|<nowiki>{{doc/start}}</nowiki>}} on your documentation page.
    
  The documentation's background will become red to make it more noticeable, and the page will be added to [[:Category:Templates with no documentation]].   The documentation's background will become red to make it more noticeable, and the page will be added to [[:Category:Templates with no documentation]].
Line 26:
Line 26:
  === baddoc=1 ===   === baddoc=1 ===
    
− Similar to <code>nodoc</code>, <code>baddoc</code> is used to mark templates that '''do''' have documentation, but it isn't very good. This can mean it doesn't have enough examples, doesn't explain all the functions properly, or doesn't explain the point of the template well. + Similar to {{code|nodoc}}, {{code|baddoc}} is used to mark templates that '''do''' have documentation, but it isn't very good. This can mean it doesn't have enough examples, doesn't explain all the functions properly, or doesn't explain the point of the template well.
    
  The documentation's background will become yellow to make it more noticeable, and the page will be added to [[:Category:Templates with bad documentation]].   The documentation's background will become yellow to make it more noticeable, and the page will be added to [[:Category:Templates with bad documentation]].
    
− If both <code>nodoc</code> and <code>baddoc</code> are specified, <code>baddoc</code> will be ignored. + If both {{code|nodoc}} and {{code|baddoc}} are specified, {{code|baddoc}} will be ignored.
    
  == Example ==   == Example ==
    
− Let's say we want to add a template named <code>HelloWorld</code>. Its contents are the following: + Let's say we want to add a template named {{code|HelloWorld}}. Its contents are the following:
    
  <pre><nowiki>   <pre><nowiki>
Line 40:
Line 40:
  </nowiki></pre>   </nowiki></pre>
    
− To document how this template works for other editors, we create a subpage of it called <code>doc</code>, having the full article name of <code>HelloWorld/doc</code>. + To document how this template works for other editors, we create a subpage of it called {{code|doc}}, having the full article name of {{code|HelloWorld/doc}}.
    
  Within that subpage we'll put the following wikitext:   Within that subpage we'll put the following wikitext:
Line 65:
Line 65:
  </nowiki></pre>   </nowiki></pre>
    
− Now that we've documented our <code>HelloWorld</code> template, we need to reference our documentation from the template by adding it at the bottom. + Now that we've documented our {{code|HelloWorld}} template, we need to reference our documentation from the template by adding it at the bottom.
    
  <pre><nowiki>   <pre><nowiki>



Komidore64 at 23:26, 8 August 2020
2020-08-08T23:26:50Z


				
				
				
				
				
				← Older revision
				Revision as of 23:26, 8 August 2020
				
Line 69:
Line 69:
  <pre><nowiki>   <pre><nowiki>
  Hello, {{{1}}}!   Hello, {{{1}}}!
− &lt;noinclude&gt;{{doc}}&lt;/noinclude&gt; + &lt;noinclude&gt;{{clear}}{{doc}}&lt;/noinclude&gt;
  </nowiki></pre>   </nowiki></pre>
    



Komidore64 at 23:26, 8 August 2020
2020-08-08T23:26:15Z


				
				
				
				
				
				← Older revision
				Revision as of 23:26, 8 August 2020
				
Line 1:
Line 1:
  <includeonly>{{/doc}}</includeonly><noinclude>{{doc/start}}   <includeonly>{{/doc}}</includeonly><noinclude>{{doc/start}}
−  
  Document how a template works and how to use it.   Document how a template works and how to use it.
    
  == Usage ==   == Usage ==
    
− Create a subpage of the template called <code>doc</code>, put <code><nowiki>{{doc/start}}</nowiki></code> at the start of your documentation, and <code><nowiki>{{doc/end}}</nowiki></code> at the end. + Create a subpage of the template called <code>doc</code>, place a <code><nowiki>{{doc/start}}</nowiki></code> at the start of your documentation, and <code><nowiki>{{doc/end}}</nowiki></code> at the end.
    
− On the main template page add <code><nowiki>&lt;noinclude&gt;{{doc}}&lt;/noinclude&gt;</nowiki></code> on a newline at the end of the template. + On the main template page add <code><nowiki>&lt;noinclude&gt;{{clear}}{{doc}}&lt;/noinclude&gt;</nowiki></code> on a newline at the end of the template.
    
  Documentation subpages will automatically be added to [[:Category:Documentation templates]].   Documentation subpages will automatically be added to [[:Category:Documentation templates]].





Komidore64 at 23:24, 8 August 2020
2020-08-08T23:24:34Z


				
				
				
				
				
				← Older revision
				Revision as of 23:24, 8 August 2020
				
Line 74:
Line 74:
    
  Now the template's documentation will be displayed any time the template is viewed!   Now the template's documentation will be displayed any time the template is viewed!
− {{doc/end}} + </div>
    
  [[Category:Documentation templates]]   [[Category:Documentation templates]]
  </noinclude>   </noinclude>





Komidore64: noinclude tags in codeblocks were being parsed
2020-08-08T23:11:56Z
noinclude tags in codeblocks were being parsed

				
				
				
				
				
				← Older revision
				Revision as of 23:11, 8 August 2020
				
Line 7:
Line 7:
  Create a subpage of the template called <code>doc</code>, put <code><nowiki>{{doc/start}}</nowiki></code> at the start of your documentation, and <code><nowiki>{{doc/end}}</nowiki></code> at the end.   Create a subpage of the template called <code>doc</code>, put <code><nowiki>{{doc/start}}</nowiki></code> at the start of your documentation, and <code><nowiki>{{doc/end}}</nowiki></code> at the end.
    
− On the main template page add <code><nowiki><noinclude>{{doc}}</noinclude></nowiki></code> on a newline at the end of the template. + On the main template page add <code><nowiki>&lt;noinclude&gt;{{doc}}&lt;/noinclude&gt;</nowiki></code> on a newline at the end of the template.
    
  Documentation subpages will automatically be added to [[:Category:Documentation templates]].   Documentation subpages will automatically be added to [[:Category:Documentation templates]].
Line 17:
Line 17:
  If your main template page has floating content and you would like to stop it from going over the documentation, put <code><nowiki>{{doc/start|clear}}</nowiki></code> instead of <code><nowiki>{{doc/start}}</nowiki></code> on your documentation page.   If your main template page has floating content and you would like to stop it from going over the documentation, put <code><nowiki>{{doc/start|clear}}</nowiki></code> instead of <code><nowiki>{{doc/start}}</nowiki></code> on your documentation page.
    
− This is also useful for templates not using <code><nowiki><includeonly></nowiki></code> tags, as it will put some space between the template and the documentation box. + This is also useful for templates not using <code><nowiki>&lt;includeonly&gt;</nowiki></code> tags, as it will put some space between the template and the documentation box.
    
  === nodoc=1 ===   === nodoc=1 ===
Line 70:
Line 70:
  <pre><nowiki>   <pre><nowiki>
  Hello, {{{1}}}!   Hello, {{{1}}}!
− <noinclude>{{doc}}</noinclude> + &lt;noinclude&gt;{{doc}}&lt;/noinclude&gt;
  </nowiki></pre>   </nowiki></pre>
    





Komidore64: add tools for documenting templates
2020-08-08T22:28:16Z
add tools for documenting templates
New page
<includeonly>{{/doc}}</includeonly><noinclude>{{doc/start}}



Document how a template works and how to use it.



== Usage ==



Create a subpage of the template called <code>doc</code>, put <code><nowiki>{{doc/start}}</nowiki></code> at the start of your documentation, and <code><nowiki>{{doc/end}}</nowiki></code> at the end.



On the main template page add <code><nowiki><noinclude>{{doc}}</noinclude></nowiki></code> on a newline at the end of the template.



Documentation subpages will automatically be added to [[:Category:Documentation templates]].



== Optional parameters ==



=== clear ===



If your main template page has floating content and you would like to stop it from going over the documentation, put <code><nowiki>{{doc/start|clear}}</nowiki></code> instead of <code><nowiki>{{doc/start}}</nowiki></code> on your documentation page.



This is also useful for templates not using <code><nowiki><includeonly></nowiki></code> tags, as it will put some space between the template and the documentation box.



=== nodoc=1 ===



If a template has no documentation and you don't know how to use it, put <code><nowiki>{{doc/start|nodoc=1}}</nowiki></code> (or if the template needs clear as well, <code><nowiki>{{doc/start|clear|nodoc=1}}</nowiki></code>) instead of <code><nowiki>{{doc/start}}</nowiki></code> on your documentation page.



The documentation's background will become red to make it more noticeable, and the page will be added to [[:Category:Templates with no documentation]].



=== baddoc=1 ===



Similar to <code>nodoc</code>, <code>baddoc</code> is used to mark templates that '''do''' have documentation, but it isn't very good. This can mean it doesn't have enough examples, doesn't explain all the functions properly, or doesn't explain the point of the template well.



The documentation's background will become yellow to make it more noticeable, and the page will be added to [[:Category:Templates with bad documentation]].



If both <code>nodoc</code> and <code>baddoc</code> are specified, <code>baddoc</code> will be ignored.



== Example ==



Let's say we want to add a template named <code>HelloWorld</code>. Its contents are the following:



<pre><nowiki>

Hello, {{{1}}}!

</nowiki></pre>



To document how this template works for other editors, we create a subpage of it called <code>doc</code>, having the full article name of <code>HelloWorld/doc</code>.



Within that subpage we'll put the following wikitext:



<pre><nowiki>

{{doc/start}}



Say hello!



== Usage ==



Say hello to a name.



{{helloworld|NAME}}



== Example ==



{{helloworld|James}}



gives:



Hello, James!

{{doc/end}}

</nowiki></pre>



Now that we've documented our <code>HelloWorld</code> template, we need to reference our documentation from the template by adding it at the bottom.



<pre><nowiki>

Hello, {{{1}}}!

<noinclude>{{doc}}</noinclude>

</nowiki></pre>



Now the template's documentation will be displayed any time the template is viewed!

{{doc/end}}



[[Category:Documentation templates]]

</noinclude>

Template:Doc - Revision history

Komidore64 at 17:29, 6 December 2020

Komidore64: replace instances of with Code template

Komidore64 at 23:26, 8 August 2020

Komidore64 at 23:26, 8 August 2020

Komidore64 at 23:24, 8 August 2020

Komidore64: noinclude tags in codeblocks were being parsed

Komidore64: add tools for documenting templates

Komidore64: replace instances of `with Code template`