View source for Template:Articles by Importance/doc

{{Documentation subpage}}
{{template shortcut|AbI}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Bharatdata (see [[</nowiki>[[Bharatpedia:Bharatdata]]<nowiki>]]) -->

== Usage ==
This template will display, in a horizontal table, the number of articles of each importance, which belong to a particular [[BP:WikiProject|WikiProject]]. The syntax is as follows:
<syntaxhighlight lang="wikitext">
{{Articles by Importance
 |topic=
 |project=
}}
</syntaxhighlight>

=== Parameters ===
* {{para|topic}} (required) - set to the name used in the project or task force's <code>Category:''topic'' articles by importance</code>
* {{para|project}} (optional) - if defined, a caption is displayed above the table with the following three links: <code><nowiki>[[</nowiki>Bharatpedia:WikiProject ''project''|WikiProject ''project'']]</code>, <code><nowiki>[[</nowiki>:Category:''topic'' articles by importance|Articles by importance]]</code>, and a "(refresh)" button.
* {{para|custom1}} (optional) - allows for addition of a custom importance
* {{para|format}} (optional) - changes the way the template is formatted using one of Bharatpedia's defined styles ([[Cascading Style Sheets|CSS]]), for example {{para|format|toc}}
* {{para|task_force}} (optional) - if {{para|project}} has been set, and {{para|task_force|yes}} then the following two parameters are required:
** {{para|tf_link}} - should be set to the task force's subpage name.
** {{para|parent}} - should be set to the same value as {{para|project}}.  Together, these two parameters generate the first link as: <code><nowiki>[[</nowiki>Bharatpedia:WikiProject ''parent''/''tf_link''|''topic'' Taskforce]]</code>, along with the other two links as above.

== Examples ==
<syntaxhighlight lang="wikitext">
{{Articles by Importance|topic=physics|project=Physics}}
</syntaxhighlight>

will result in:

{{Articles by Importance|topic=physics|project=Physics}}

;Changing class to format template layout

By using the {{para|format}} tag, you can change the way the template is formatted using one of Wikipedia's defined styles ([[Cascading Style Sheets|CSS]]). 

<syntaxhighlight lang="wikitext">
{{Articles by Importance|topic=physics|project=Physics|format=toc}}
</syntaxhighlight>

will result in:

{{Articles by Importance|topic=physics|project=Physics|format=toc}}

You can use any of the Wikipedia defined classes in this parameter. In this example, the switch changes the style from the default ''wikitable'' to the ''toc'' style used in the {{tl|Cat importance}} template. All formatting in the template will be changed to the defined style chosen and cannot be modified.

=== Taskforce example ===
<syntaxhighlight lang="wikitext" style="width:50%;">
{{Articles by Importance
 |project    = Food and drink
 |topic      = Cheeses
 |task_force = yes
  |tf_link   = Cheeses task force
  |parent    = Food and drink
 |format     = toc
}}
</syntaxhighlight>

will generate:

{{Articles by Importance
 |project    = Food and drink
 |topic      = Cheeses
 |task_force = yes
  |tf_link   = Cheeses task force
  |parent    = Food and drink
 |format     = toc
}}

<!---=== Sandbox examples ===
<syntaxhighlight lang="wikitext" style="width:50%;">
{{Articles by importance/sandbox
 |project    = Food and drink
 |topic      = Cheeses
 |task_force = yes
  |tf_link   = Cheeses task force
  |parent    = Food and drink
 |format     = toc
}}
</syntaxhighlight>

will generate:

{{Articles by Importance/sandbox
 |project    = Food and drink
 |topic      = Cheeses
 |task_force = yes
  |tf_link   = Cheeses task force
  |parent    = Food and drink
 |format     = toc
}}--->

==See also==
{{Grading scheme/doc/see also}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Bharatdata -->
[[Category:Classification templates| ]]
}}</includeonly>