Template:Uses from: Difference between revisions
(Move '/small' outside the includonly.) |
(→Discussion: Indicate needed numeral component of template arg name.) |
||
Line 35: | Line 35: | ||
* Avoid using MW categories. Use semantic properties instead. (MW categories have particular behavior when used in semantic queries.) |
* Avoid using MW categories. Use semantic properties instead. (MW categories have particular behavior when used in semantic queries.) |
||
* Apply the semantic property <tt>'''uses::{{{1}}}'''</tt> |
* Apply the semantic property <tt>'''uses::{{{1}}}'''</tt> |
||
* Accept an undefined number of additional ''named'' arguments as components of that library. (var name might be ''' |
* Accept an undefined number of additional ''named'' arguments as components of that library. (var name might be '''componentN''') Add a semantic property to the page indicating that it uses {{{1}}}. |
||
** <tt>uses '''{{{1}}}''' component::'''{{{ |
** <tt>uses '''{{{1}}}''' component::'''{{{component1}}}''', '''{{{component2}}}''', etc...</tt> |
||
* Accept library version as a single named argument. (var name might be '''version''') Tag the transcluding page as using that version of library {{{1}}}. |
* Accept library version as a single named argument. (var name might be '''version''') Tag the transcluding page as using that version of library {{{1}}}. |
||
** <tt>uses '''{{{1}}}''' version:'''{{{version}}}'''</tt>. |
** <tt>uses '''{{{1}}}''' version:'''{{{version}}}'''</tt>. |
||
* For each {{{ |
* For each {{{componentN}}} supplied, if any, apply |
||
** <tt>uses '''{{{1}}}''' version '''{{{version}}}''' component::'''{{{ |
** <tt>uses '''{{{1}}}''' version '''{{{version}}}''' component::'''{{{componentN}}}'''</tt>. |
||
** <tt>uses '''{{{1}}}''' component '''{{{ |
** <tt>uses '''{{{1}}}''' component '''{{{componentN}}}''' version::'''{{{version}}}'''</tt>. |
||
The richer the relationships we can define, the more powerful the search options we'll have available. |
The richer the relationships we can define, the more powerful the search options we'll have available. |
Revision as of 03:51, 17 November 2010
This template is intended to handle the case where a library has many components within it (examples of this include CPAN, RubyGems and Tcllib). It has two required parameters: {{uses from|library|component}}. The library is the name of the overall library of components (which should also be the name of a category here on RC) and the component is the name of the component within it (which can be almost any string).
Discussion
This template is derived from {{tcllib}}, and seeks to have a similar aim, except more generically, and as a potential eventual replacement for {{libheader}} and {{works with}}. (And {{tcllib}}, if it achieves sufficient functionality.)
Design goals in common with {{tcllib}}, {{libheader}} and {{works with}}:
- Use {{{1}}} as the library name.
Other ultimate goals that make its behavior variously different from current {{tcllib}}, {{libheader}} and {{works with}}:
- Avoid using MW categories. Use semantic properties instead. (MW categories have particular behavior when used in semantic queries.)
- Apply the semantic property uses::{{{1}}}
- Accept an undefined number of additional named arguments as components of that library. (var name might be componentN) Add a semantic property to the page indicating that it uses {{{1}}}.
- uses {{{1}}} component::{{{component1}}}, {{{component2}}}, etc...
- Accept library version as a single named argument. (var name might be version) Tag the transcluding page as using that version of library {{{1}}}.
- uses {{{1}}} version:{{{version}}}.
- For each {{{componentN}}} supplied, if any, apply
- uses {{{1}}} version {{{version}}} component::{{{componentN}}}.
- uses {{{1}}} component {{{componentN}}} version::{{{version}}}.
The richer the relationships we can define, the more powerful the search options we'll have available.
(Unless someone can figure out a better way to apply pagename/libname/component/version with the semantic properties.)