vona xihlovo xa Help:Resources by completion status

<noinclude>{{Project boxes/Nav}}</noinclude>This page is a guideline for '''completion status''' [[Help:project boxes|project boxes]]. They can also be thought of as "development cycle" indicators. 

== Purpose of these project boxes ==

The main purpose of these project boxes is to categorise resources into one of '''five''' development status categories ''so that Wikipedia users can more easily sort out what they want to look at''. 
* '''Article developers''' can zoom in on resources which are stuck at the earlier stage of development and help move them along. This can be done even more effectively if a parser function is run against the categories in question to additionally sort them by date of last edit, so that very old and undeveloped resources can be identified (this sorting has already been done using these project boxes).
* '''Learners''' can quickly find well developed resources to learn from, rather than getting lost in the middle of undeveloped ones and running away with the impression that there aren't any learning materials which are sufficiently well developed to be of use.
* '''Metadata extractors''' can work out which resources are sufficiently developed to be worth cataloguing in metadata exports for promoting Wikiversity in other OER projects.

'''Disadvantages''': Wikipedia resources have many different kinds of development cycle, not all of which will fit with the simple system used here. Imposing a 5-level system of development status on any project (let alone Wikipedia) is, to some extent, arbitrary and may simply not fit some cases. However the usefulness of an approximate system of development indicators outweighs this. To compensate for any misleading or other inappropriate effect of completion status project boxes, a number of modification options are available to individual users, including change icon, change text and append text, along with a system of "fun-looking" default boxes which will appeal to some people (but not everyone). All of these methods can be combined so that you can tag a resource with a completion status and, at the same time, convey the impression which you feel is appropriate to a particular resource's development cycle.

== Tagging resource pages by completion status ==
 
=== Serious-looking boxes ===

Write the template code into your resource at any point on the page. As well as an attractive template appearing, the resource will be automatically categorised. If you change the template later, the categories will be automatically updated.

{{usbktop}}
{{usbk|Template:0%done|}}
{{usbk|Template:25%done|}}
{{usbk|Template:50%done|}}
{{usbk|Template:75%done|}}
{{usbk|Template:100%done|}}
{{usbkbottom}}

=== Fun-looking boxes === 

This is an alternative set of templates which is more fun. There are different names for these tags - you may prefer to use the short and friendly names like <nowiki>{{nearlythere}}</nowiki>. The percentages given are highly subjective - what really counts is how the templates categorise the resource. There are '''five''' categories for completion status, ranging from freshly started to complete. Some of these categories have two or more "fun" project boxes - e.g. <nowiki>{{launch}}</nowiki> and <nowiki>{{yawn}}</nowiki> result in the same categorisation ("partly complete"), but look very different on the page.

Please feel welcome to create alternative project boxes. Suggestions can go on the talk page, for example.

{{usbktop}}
{{usbk|Template:0%done-2|shortcut=juststarted|description=Categorisation is complex and includes an automatic date parser to categorise by month of last modification.}}
{{usbk|Template:1%done-2|shortcut=unkstat|description=Categorised as [[:Category: partly developed resources|partly developed]]. This box was made for automatic inclusion by other templates such as [[Template:uncat]].}}
{{usbk|Template:10%done-2|shortcut=launch|description=Categorised as [[:Category: partly developed resources|partly developed]].}}
{{usbk|Template:25%done-2|shortcut=yawn|description=Categorised as [[:Category: partly developed resources|partly developed]].}}
{{usbk|Template:50%done-2|shortcut=halfway|description=Categorised as [[:Category: half-finished resources|half complete.]]}}
{{usbk|Template:51%done-2|shortcut=incomplete|description=Categorised as [[:Category: half-finished resources|half complete.]]}}
{{usbk|Template:75%done-2|shortcut=nearlythere|description=Categorised as [[:Category: resources nearing completion|nearly complete.]]}}
{{usbk|Template:99%done-2|shortcut=testing|description=Categorised as [[:Category: resources nearing completion|nearly complete.]]}}
{{usbk|Template:97%done-2|shortcut=ready|description=Categorised as [[:Category: completed resources|complete.]]}}
{{usbk|Template:100%done-2|shortcut=complete|description=Categorised as [[:Category: completed resources|complete.]]}}
{{usbkbottom}}

''Note: the % figures in the titles of the formal template names are largely meaningless and are a hangover from the original system which was more rigorously attached to a %-completion concept. Please do not set too much store in the presence of a % figure.''

=== More boxes ===

{{usbktop}}
{{usbk|Template:experimental|shortcut=experimental|description=Categorised as [[:Category: partly developed resources|partly developed]].}}
{{usbk|Template:abandoned|shortcut=abandoned|description=Categorised as [[:Category: partly developed resources|partly developed]].}}
{{usbk|Template:skeleton|shortcut=skeleton|description=Categorised as [[:Category: partly developed resources|partly developed]].}}
{{usbk|Template:draft|shortcut=draft|description=Categorised as [[:Category: partly developed resources|partly developed]].}}
{{usbkbottom}}

== Modifying the project boxes ==

This section explains how to modify project boxes to suit your own preferences for describing educational resource development cycles. Please note that the important thing about project boxes is their categorisation function (which remains the same in the examples), along with the option to retrospectively apply parser functions via the template. The visible component of the project boxes is of secondary importance, so there's no harm in applying personal preferences when tagging resources which are mainly your own work.

=== Example #1 ===

You can simply ''append'' some text, shown here applied to the "halfway" template.
{{halfway|add=--[[User:Baah and Bahh]]}}<div style="width:50%; ">
''<nowiki>{{halfway|add --[[User:Baah and Bahh]]}}</nowiki>''
</div>

=== Example #2 ===

This uses simple text modification, applied to the "halfway" template. This time we've change the whole text, rather than just adding some to the default.
{{halfway|text=We started this but ran out of ideas. Can someone give us some input, please? --[[User:Baah and Bahh]]}}<div style="width:50%; ">
''<nowiki>{{halfway|text=We started this but ran out of ideas. Can someone give us some input, please? --[[User:Baah and Bahh]]}}</nowiki>''
</div>

=== Example #3 ===

This goes a step further, modifying the icon as well.
{{halfway|icon=Domestic Goat Portrait (aka).jpg|text=We started this but ran out of ideas. Can someone give us some input, please? --[[User:Baah and Bahh]]}}<div style="width:50%; ">
''<nowiki>{{halfway|icon=Domestic Goat Portrait (aka).jpg|text=We started this but ran out of ideas. Can someone give us some input, please? --[[User:Baah and Bahh]]}}</nowiki>''
</div>

== Tagging resource lists by completion status ==

Sometimes you will want to put indicators onto list pages which indicate a resource's completion status. There's no room for a project box here; you need something smaller.

These are the available mini-indicators:
<pre>
{{0Percent}}
{{25Percent}}
{{50Percent}}
{{75Percent}}
{{100Percent}}
</pre>

And this is what they look like:
* Blablabla Course {{0Percent}} ''(This course is not at all complete)''
* Blablabla Course {{25Percent}} ''(This course is a little complete)''
* Blablabla Course {{50Percent}} ''(This course is somewhat complete)''
* Blablabla Course {{75Percent}} ''(This course is fairly complete)''
* Blablabla Course {{100Percent}} ''(This course is complete)''

== Tagging resources with a bare category ==

If you prefer not to use a project box, then you can simply categorise the resource instead under one of the following categories. Please note that if you use a project box, categorisation is automatic. Percentages are only a very rough guide. '''''Please note that if you tag with a bare category rather than a project box, you will prevent maintenance staff from including your resource in parser function sorting.'''''

* [[:Category: completed resources]] (c. 100%)
* [[:Category: resources nearing completion]] (c.75%)
* [[:Category: half-finished resources]] (c. 50%)
* [[:Category: partly developed resources]] (c. 25%)
* [[:Category: freshly started resources]] (c. 0%)

:;Example
::To use this automatic cataloging feature, the simplest ways is to add '''<nowiki>[[Category: completed resources]]</nowiki>''' (or the appropriate category) at the bottom of your page.

== Meta-templates and template quick access (admin use only) ==

* [[Template:projectbox]]

* [[Template:0Percent]]
* [[Template:25Percent]]
* [[Template:50Percent]]
* [[Template:75Percent]]
* [[Template:100Percent]]

== See also ==

* [[Help:project boxes]]

<noinclude>
[[Category:Help]]
[[Category:Resources by completion status]]
[[Category:Project boxes]]
</noinclude>