Template:Featured Article Candidate/doc: Difference between revisions

From Citizendium
Jump to navigation Jump to search
imported>Caesar Schinas
imported>Caesar Schinas
(new, improved (?) documentation)
Line 1: Line 1:
This template helps to display candidate articles at [[CZ:Article of the Week|Article of the Week]] or a [[CZ:New Draft of the Week|New Draft of the Week]].
This template is for displaying candidate articles at [[CZ:Article of the Week]] and [[CZ:New Draft of the Week]].<br />
 
Once a winning article has been chosen it is displayed using {{tl|winner}}.
=== Rationale ===
*Proper formatting of the candidate articles is crucial for the {{tl|Winner}} template to work effectively for transcluding content into the Welcome page
*Using the same kind of formatting already at the candidate stage acts as a buffer, such that formatting problems can be worked out before the article is even near to be included into the Welcome page. This is also the main reason why the two templates are kept separate - technically, it would have been easy to combine them in one.


=== Usage ===
=== Usage ===
*Make sure that the formatting issues listed under "Pitfalls" below have been met (this is the case if {{tl|Candidate}} worked properly}. Sample edits: [http://en.citizendium.org/wiki?title=Ancient_Celtic_music%2FDraft&diff=100507158&oldid=100488668 simple], [http://en.citizendium.org/wiki?title=Milpa_agriculture&diff=100507098&oldid=100506598 intermediate], [http://en.citizendium.org/wiki?title=Ancient_Celtic_music%2FDraft&diff=100507175&oldid=100488668 more fancy].
For both this template and {{tl|winner}}, it is neccesary to make some changes to the candidate article itself.
*Go to the "Current nominees" section of [[CZ:New Draft of the Week|CZ:New Draft of the Week]] or [[CZ:Article of the Week|CZ:Article of the Week]] and add your candidate by placing
# Place <code><nowiki><onlyinclude>...</onlyinclude></nowiki></code> tags around the section of the article which is to be featured - normally the first paragraph or two.
<pre>
# Place <code><nowiki><noinclude>...</noinclude></nowiki></code> tags around anything within this section which should ''not'' be shown in the featured article, such as
{{Candidate|Article name}}
#* Reference tags
</pre>
#* Infoboxes
in the "article" line of the table.
#* Large images
#* etc
# Place <code><nowiki><includeonly>...</includeonly></nowiki></code> tags around anything within the onlyinclude section which should ''only'' be shown in the featured article, and ''not'' on the article page itself. This can be used to
#* Include images in the featured article in place of images
#* Include smaller versions of images and headings
#* etc


=== Pitfalls ===
The candidate article can then be added to the list at [[CZ:Article of the Week]] using the following code:
*{{tl|Candidate}} only works as intended if the relevant portions of the article are enclosed in <code><nowiki>onlyinclude</nowiki></code> tags:
<code><nowiki></nowiki><<nowiki></nowiki>onlyinclude<nowiki></nowiki>>
relevant article text here
<<nowiki></nowiki>/onlyinclude<nowiki></nowiki>><nowiki></nowiki></code>
 
*This may cause problems with larger structures (e.g. infoboxes), and so it is advisable not to include them into the <code><nowiki>onlyinclude</nowiki></code> tags, or to enclose them with <code><nowiki>noinclude</nowiki></code> tags:
<pre>
<pre>
<noinclude>
{{Candidate
your image, video or table here
| article    =
</noinclude>
| supporters  =
| specialists =
| score      =
}}
</pre>
</pre>


*In order to have the first mention of the title in the text clickable, it should be defined as a wikilink (even though this has not been common practice so far):
Or to [[CZ:New Draft of the Week]] using the following code:
<pre>
<pre>
The '''[[precise article title|title or a variant thereof]]''' is ...
{{Candidate
| article     =
| supporters  =
| specialists =
| created    =
| eligible    =
| score      =
}}
</pre>
</pre>
=== See also ===
{{tl|Winner}}


=== Example ===
=== Example ===

Revision as of 04:53, 7 June 2009

This template is for displaying candidate articles at CZ:Article of the Week and CZ:New Draft of the Week.
Once a winning article has been chosen it is displayed using {{winner}}.

Usage

For both this template and {{winner}}, it is neccesary to make some changes to the candidate article itself.

  1. Place <onlyinclude>...</onlyinclude> tags around the section of the article which is to be featured - normally the first paragraph or two.
  2. Place <noinclude>...</noinclude> tags around anything within this section which should not be shown in the featured article, such as
    • Reference tags
    • Infoboxes
    • Large images
    • etc
  3. Place <includeonly>...</includeonly> tags around anything within the onlyinclude section which should only be shown in the featured article, and not on the article page itself. This can be used to
    • Include images in the featured article in place of images
    • Include smaller versions of images and headings
    • etc

The candidate article can then be added to the list at CZ:Article of the Week using the following code: 

{{Candidate
| article     = 
| supporters  = 
| specialists = 
| score       = 
}}

Or to CZ:New Draft of the Week using the following code: 

{{Candidate
| article     = 
| supporters  = 
| specialists = 
| created     = 
| eligible    = 
| score       = 
}}

Example

When used within the Article of the Week table, the following code: 

{{Candidate
| article     = Scuticaria
| supporters  = 
| specialists = [[User:Daniel Mietchen|Daniel Mietchen]] 17:24, 4 June 2009 (UTC)
| score       = 3
}}

gives the following result:

Nominated article Supporters Specialist supporters Score

Template:Candidate

Retrieved from "https://citizendium.org/wiki/index.php?title=Template:Featured_Article_Candidate/doc&oldid=623736"