Hi, On Thu, Feb 25, 2010 at 2:16 AM, Rajko M. <rmatov101@charter.net> wrote:
On Wednesday 24 February 2010 12:05:27 Petr Uzel wrote:
Hi, I've spent some time working on documenting the templates in wiki.o.o as suggested in [1], so here is small report and some random thoughts:
1. Every template (except a few - more on this below) in wiki.o.o instance now has its /doc subpage with information about how to use the template (code), general description, where to use it/not to use it and in some cases there is also list of related templates. The documentation could definitely not perfect, but IMHO it is a good start to having general policy that every template should be documented.
NavBar is one too many :) The name violates convention not to use CamelCase and keeping exceptions to the accepted rules at minimum is one way to help new editors. One thing lesser to remember when they start for the first time.
1. Not sure what you mean here, as Navbar template is available at http://wiki.opensuse.org/Template:Navbar
[...]
2, 3. Fully agree with Rajko.
4. TOCRight template: do we really need this? In en.o.o, only a few pages use this template and IMHO it doesn't look very nice.
It also doesn't play nice with the rest of the page. We usually use tables to limit size of the Table of content (TOC).
4. TocRight is deprecated. Don't know how it landed in wiki.o.o... I have been fighting against this template for months now :] also, if we intend to assure a consistent look'n'feel, there are no real reasosn to limit the size of the TOC imho.
5. The templates related to portals were taken from wikipedia, where these templates are also perfectly documented. IMO it would be useless to copy their documentation to wiki.o.o, so I've basically just linked the documentation to our wiki.
That is good if we update templates with Wikipedia, but if we will keep them as they are, then copy is probably better option. This is valid for anything that we use from other sources, but so far I know we still don't have this written as policy.
5. We should use up2date templates from wikipedia (for maintenance purpose), so I guess that a link to WP doc is sufficient (... if we manage to stay update :) ).
[...]
6, 7. Good job.
8. ATM, the documentation of a template is displayed below the template content, which is fine for small templates like AI [3], but isn't so fine for bigger templates like Article boilerplate [4]. If the user opens [4], the documentation should be better visible. I see two options, none of them ideal: a) put the documentation above the template content b) make the template content <includeonly>, so only the documentation would be visible, but then it couldn't be used as an example of recommended article layout. Any ideas?
We have to address this more thoroughly. Current article template is: 1) meant for only one type of article, user help; we have other topics that may not need this kind of template, or need different type; 2) it is all in one: template, help and sample layout; we have to break this in pieces to make it easier to use.
To skip explanation, I'll try to come up with some illustration what I mean.
8. Waiting for Rajko proposal.. 9. Allright, good job Petr and Rajko! -- To unsubscribe, e-mail: opensuse-wiki+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-wiki+help@opensuse.org