Template talk:Documentation/Archive 8: Difference between revisions

Revision as of 01:04, 1 February 2014

Revision as of 01:12, 12 February 2014

Line 300:

:::someone has created [[Module:documentation]] and is being tested in [[template:documentation/sandbox]] on en wiki [[Special:Contributions/86.176.186.77|86.176.186.77]] ([[User talk:86.176.186.77|talk]]) 11:49, 25 August 2013 (UTC)

::::hi it I have asked someone to do it because I doint know how to code in lua. he has done some more but all that needs to be added is mirror and diff and some other things to it [[Special:Contributions/94.0.201.140|94.0.201.140]] ([[User talk:94.0.201.140|talk]]) 17:38, 6 December 2013 (UTC)

== Integrating TemplateData ==

I want to standardize the inclusion or placement of TemplateData. As it is now, TemplateData is included on doc pages in several different ways; sometime included in the documentation, other times in template itself, either directly or transcluded from /TemplateData. This is not a desirable situation. I would like to establish a standard on where and how to include TemplateData into the documentation (or elsewhere). So,

* Where should TemplateData be placed?

*# In the template page

*# In the /Documentation (/doc) sub page

*# In the /TemplateData (/[...]data) sub page

* Where should it be placed visually?

*# Inside the documentation area

*# Outside/below the documentation area

* How should it be displayed?

*# Plain/text only

*# With its own background color

Let the discussion commence! Personally, I'd prefer 3/2/2. <span style="font-family:'Trebuchet MS'"> — [[User:Edokter|<span style="color:#008"><i>E</i>dokter</span>]] ([[User talk:Edokter|<span style="color:#080">talk</span>]]) — </span> 12:24, 15 December 2013 (UTC)

:Regarding placement I'd vote for ''"3. In the /TemplateData sub page"''. It's the most flexible possibility and allows us to easily change the appearance you're asking for in the other two bullet point whenever necessary. If we want another placement we can quickly change the position of the transclusion in the template &ndash; something we're not able to when we put TemplateData into the /Doc subpage or even the template page itself. For the other two bullet points I have no real preference. --[[User:Patrick87|Patrick87]] ([[User talk:Patrick87|talk]]) 15:00, 15 December 2013 (UTC)

* 3/2/2 --<span style="color:Turquoise">''''' &nbsp;[[User:Gadget850|Gadget850]]'''''^{[[User talk:Gadget850|&nbsp;''talk'']]}</span> 21:00, 15 December 2013 (UTC)

*I would support /doc/data, /TemplateData, or similar (/data is probably no good because it may contain raw data lookup for the template), and would further suggest that {{tl|documentation}} should be rewritten to automatically include some sort of interpretation of the template data file after the documentation page. This may require splitting the "The above documentation is transcluded from Template:X/doc." and "Editors can experiment in this template's sandbox and testcases pages. Please add categories to the /doc subpage. Subpages of this template." footers. [[User:Vanisaac|Van]][[User talk:Vanisaac|Isaac]]_{<small>[[WP:WikiProject Writing systems|WS]] [[WP:WikiProject Heraldry and vexillology|Vex]]</small>}<sup style="margin-left:-7.0ex">[[Special:Contributions/Vanisaac|contribs]]</sup> 02:00, 16 December 2013 (UTC)

:Portuguese Wikipedia uses a /Dados subpage and transcludes it to the /doc subpage using [[:pt:Template:Documentação dos parâmetros]], but what I would prefer is the [[bugzilla:54140|new namespace proposed on bugzilla]] (see also [[bugzilla:50512#c0]]). [[User talk:Helder.wiki|Helder]] 11:38, 18 December 2013 (UTC)

Not much input, but 3/2/2 seems to have consensus; a separate sub page, below the documentation, in its own color. I suggest we put the template data in /doc/data and auto-transclude the (raw) data from there to put below the documentation footer. <span style="font-family:'Trebuchet MS'"> — [[User:Edokter|<span style="color:#008"><i>E</i>dokter</span>]] ([[User talk:Edokter|<span style="color:#080">talk</span>]]) — </span> 13:59, 14 January 2014 (UTC)

:One additional thing. I've been wondering for a while why the VE team didn't go with a json contentmodel blob on a fixed page, but with a tag. We should ask them, because these JSON in wikitext blobs are just weird to me and if there is nothing blocking a transition to fix that, then I think we should move them into a pure separate JSON page at some point. —[[User:TheDJ|Th<span style="color: green">e</span>DJ]] ([[User talk:TheDJ|talk]] • [[Special:Contributions/TheDJ|contribs]]) 17:08, 14 January 2014 (UTC)

:{{ping|Edokter}} Nah, don't put it into <code>/doc/data</code>. A simple <code>/data</code> subpage (or <code>/templatedata</code> if we want a more descriptive name at the cost of slightly less convenience) as a direct subpage of the template itself is totally suitable. Let's avoid unnecessary nesting. --[[User:Patrick87|Patrick87]] ([[User talk:Patrick87|talk]]) 18:08, 14 January 2014 (UTC)

::I'd agree with /data or /templatedata . Do you want to get something done in the sandbox for any interested to view? Could also be worth updating {{tl|Documentation subpage}} to work on both /doc and whatever the subpage ends up being called and it could include pages into [[:Category:Template data pages]]. -- [[User:WOSlinker|WOSlinker]] ([[User talk:WOSlinker|talk]]) 19:15, 14 January 2014 (UTC)

:::Not set on anything myself, but as Helder pointed out, /data may be used by some templates for their own purposes. /templatedata it is then. Go ahead with the sandbox. I have some CSS [[User:Edokter/common.css|here]] for some basic styling ready. <span style="font-family:'Trebuchet MS'"> — [[User:Edokter|<span style="color:#008"><i>E</i>dokter</span>]] ([[User talk:Edokter|<span style="color:#080">talk</span>]]) — </span> 19:59, 14 January 2014 (UTC)

::::Anybody has an idea on how to search for such potential <code>/data</code> subpages used for other purposes? This way we could evaluate if it is a real or only an academic problem (if we want to use the abbreviated name at all; personally I like <code>/templatedata</code> more anyway). --[[User:Patrick87|Patrick87]] ([[User talk:Patrick87|talk]]) 20:07, 14 January 2014 (UTC)

:::::I've done a start in {{tl|documentation/sandbox2}} and it's on {{tl|Big}} as a demo. Needs more work doing on it. -- [[User:WOSlinker|WOSlinker]] ([[User talk:WOSlinker|talk]]) 22:19, 14 January 2014 (UTC)

::::::Looks good so far, but I would separate the header (not nest them). Then both can be styled using the .mw-templatedata-doc-wrap and .templatedata-header classes. <span style="font-family:'Trebuchet MS'"> — [[User:Edokter|<span style="color:#008"><i>E</i>dokter</span>]] ([[User talk:Edokter|<span style="color:#080">talk</span>]]) — </span> 22:45, 14 January 2014 (UTC)

::::::Two suggestions: (i) reduce the gap at the top so that it's the same as the one above [[Template:Documentation/end box|the end box]]; (ii) use a background colour that is not the same as the documentation background - possibly a light blue? --[[User:Redrose64|<span style="color:#a80000; background:#ffeeee; text-decoration:inherit">Red</span>rose64]] ([[User talk:Redrose64|talk]]) 22:49, 14 January 2014 (UTC)

:::::::The reason I suggested the following CSS. I can put it in Common.css. <span style="font-family:'Trebuchet MS'"> — [[User:Edokter|<span style="color:#008"><i>E</i>dokter</span>]] ([[User talk:Edokter|<span style="color:#080">talk</span>]]) — </span> 22:58, 14 January 2014 (UTC)

<syntaxhighlight lang="CSS">

/* TemplateData box */

.mw-templatedata-doc-wrap,

.templatedata-header {

border: 1px solid #AAA;

background-color: #ECF4FC;

margin: 0.2em 0;

padding: 0 1em;

}

</syntaxhighlight>

:Also, would it be better to put the templatedata in-between the documentation and the bottom box rather than at the end? -- [[User:WOSlinker|WOSlinker]] ([[User talk:WOSlinker|talk]]) 23:11, 14 January 2014 (UTC)

::Technically, it is not part of the documentation. I would say no. <span style="font-family:'Trebuchet MS'"> — [[User:Edokter|<span style="color:#008"><i>E</i>dokter</span>]] ([[User talk:Edokter|<span style="color:#080">talk</span>]]) — </span> 23:17, 14 January 2014 (UTC)