Jump to content

Template talk:Documentation/Archive 1

Page contents not supported in other languages.
From Wikipedia, the free encyclopedia
Archive 1Archive 2Archive 3→Archive 5

Use

Using :

<noinclude>{{documentation}}<noinclude>

will cause the documentation to show in the template when used. This should be:

<noinclude>
{{documentation}}</noinclude>

Ed

Fixed, thanks. --PEJL 18:01, 22 October 2007 (UTC)
Thanks. I thought I was doing something crazy for a few minutes.  :-) --Gadget850 ( Ed) 18:08, 22 October 2007 (UTC)

Edits made 2007-11-02 and 2007-11-02 break subsection edit links. I shall revert those edits immediately.
To illustrate the issue the last version before reversion was copied to {{Documentation/sandbox}} and a test cases page was created at User:ConradPino/template/documentation.
Conrad T. Pino 20:50, 3 November 2007 (UTC)

Failing code analysis

{{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{{{1|{{SUBJECTPAGENAME}}/doc}}}}}}}

{{ #ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{ {{{1|{{SUBJECTPAGENAME}}/doc}}} }} }}

{{ #ifexist:page|{{ page }} }}

The problem is a template expansion 

{{ page }}

occuring within a parser function 

{{ #ifexist:page| {{ template expansion of page }} }}

Conrad T. Pino 22:03, 3 November 2007 (UTC)

Recommendation

Invert the structure to parser function within template expansion 

{{             template expansion            }}

{{ {{           parser function           }} }}

{{ {{#ifexist:page|page|Documentation/none}} }}

{{ {{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{1|{{SUBJECTPAGENAME}}/doc}}}|Documentation/none}} }}

Conrad T. Pino 22:17, 3 November 2007 (UTC)

Revision 1

When first implemented {{Documentation/none}} contained 

<!-- Template:Documentation/none -->

This revision blanked {{Documentation/none}} at 23:33, November 3, 2007 – Conrad T. Pino 08:28, 6 November 2007 (UTC)

Revision 2

Borrow from {{Template doc}} and eliminate the {{Documentation/none}} page. 

{{      template expansion     }}

{{ {{    parser function    }} }}

{{ {{#ifexist:page|page|ns:0}} }}

{{ {{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{1|{{SUBJECTPAGENAME}}/doc}}}|ns:0}} }}

Conrad T. Pino 08:39, 6 November 2007 (UTC)

Implementation complete

In the spirit of be bold and only after careful testing the Recommendation (above) was implemented taking care to lead with a new line. The differences are here.

Note: Page {{Documentation/none}} must NOT be deleted!

Conrad T. Pino 22:40, 3 November 2007 (UTC)

Implementation reverted

See Reverted 23:36, November 3, 2007 to 17:20, October 20, 2007 version below. – Conrad T. Pino 00:09, 4 November 2007 (UTC)

Failure analysis

When first implemented {{Documentation/none}} contained 

<!-- Template:Documentation/none -->

which is definately NOT the similar to the empty or space strings. This is no longer the case as I blanked {{Documentation/none}} at 23:33, November 3, 2007 which made it possible for another user to restore the implementation with no reported incidents. – Conrad T. Pino 06:12, 6 November 2007 (UTC)

However failure to find an incident report on this talk page doesn't mean one didn't happen. The restore was reverted again by a third user. – Conrad T. Pino 06:26, 6 November 2007 (UTC)

Reverted 23:36, November 3, 2007 to 17:20, October 20, 2007 version

Problem report

Re: Template:Documentation reverted 20:51, November 3, 2007

Hi there. I don't understand what problem you were trying to solve at Template:Documentation, but you've broken the template so that it includes too much whitespace at the beginning. See WP:SONG#Infobox Single. As I don't understand the code well enough to fix it, would you mind trying to restore the previous behavior, where such excessive whitespace was not generated. Thanks in advance. --PEJL 23:30, 3 November 2007 (UTC)

Revert request completed

But that doesn't seem to help the reported problem. I'll assist in anyway possible. – Conrad T. Pino 23:45, 3 November 2007 (UTC)

That did fix it. (Sometimes you need to purge the page to see these kinds of changes.) --PEJL 23:47, 3 November 2007 (UTC)
Thank you for letting me know. – Conrad T. Pino 00:01, 4 November 2007 (UTC)

Merge from Template:Template doc

The merge proposal discussion occured here. – Conrad T. Pino 08:14, 6 November 2007 (UTC)

Merge goals proposal by priority

0. Remove "...transcluded from..." display inconsistency.
1. No functional differences.
2. No visual differences.
3. Improve /sandbox and /testcases support. (Wikipedia:Template test cases)

Conrad T. Pino 08:56, 6 November 2007 (UTC)
Conrad T. Pino 22:58, 11 November 2007 (UTC)

Functional issues

SUBJECT... versus FULL...

This section is archived: Template talk:Documentation/merge/archive/2.1

(2.2) Documentation /doc use cases

(2.2.1) /doc best practice

The best practice provides designed behavior with least maintenance.

(2.2.2) /doc acceptable practice

The acceptable practice provides designed behavior with more maintenance.

(2.2.3) /doc questionable practices

The questionable practices visibly deviate from designed behavior.

The above list is not comprehensive but I stop here since visible behaviors become noticable and therefore hopefully corrected soon after discovery. – Conrad T. Pino 22:37, 11 November 2007 (UTC)

Template behavior differences

{{Documentation, template}} transcludes {{Documentation}} and unless explictly stated otherwise any {{Documentation}} behavior described here applies to both.
Conrad T. Pino 00:21, 16 November 2007 (UTC)

Display heading and content
(template icon) Template documentation
(no icon) Documentation
(template icon) Template documentation

Conrad T. Pino 01:22, 16 November 2007 (UTC)

Display /doc content

Conrad T. Pino 01:04, 16 November 2007 (UTC)

Display in-line content

Conrad T. Pino 01:12, 16 November 2007 (UTC)

Display "...transcluded from .../doc. (...)"
  • {{.../doc}} transcluded (but not always)

Conrad T. Pino 00:21, 16 November 2007 (UTC)

Template parameter differences

{{Documentation, template}} transcludes {{Documentation}} and unless explictly stated otherwise any behavior described here applies to both.
Conrad T. Pino 00:57, 16 November 2007 (UTC)

Parameter for in-line content

Conrad T. Pino 00:57, 16 November 2007 (UTC)

Parameter for /doc path
and then transcluded
1={{ {{SUBJECTSPACE}}:{{{1}}} }}
2={{SUBJECTSPACE}}:{{{1}}}

Conrad T. Pino 00:57, 16 November 2007 (UTC)

Merge process progress

This section shall track the progress of the merge process as it proceeds. – Conrad T. Pino 07:22, 7 November 2007 (UTC)

Merge objects

The following templates participate in this merge. – Conrad T. Pino 07:31, 7 November 2007 (UTC)

Merge from templates

Conrad T. Pino 07:31, 7 November 2007 (UTC)
Conrad T. Pino 12:51, 9 November 2007 (UTC)
Conrad T. Pino 22:00, 9 November 2007 (UTC)
Conrad T. Pino 22:12, 9 November 2007 (UTC)
Conrad T. Pino 22:12, 11 November 2007 (UTC)
Conrad T. Pino 08:49, 13 November 2007 (UTC)
Conrad T. Pino 05:05, 16 November 2007 (UTC)
Conrad T. Pino (talk) 09:30, 17 November 2007 (UTC)

Merge into templates

Conrad T. Pino 07:31, 7 November 2007 (UTC)
Conrad T. Pino 12:51, 9 November 2007 (UTC)
Conrad T. Pino 21:20, 9 November 2007 (UTC)
Conrad T. Pino 02:08, 10 November 2007 (UTC)
Conrad T. Pino 15:43, 11 November 2007 (UTC)

Merge objects tagged

The following merge objects now include a merge process template:

Merge Object Merge Process Template
{{Documentation}} {{Mergingfrom}}
{{Documentation subpage}} {{Mergingfrom}} (3 2 1 times)
{{Documentation, template}} (new) {{Mergingfrom}} (new, 2 times)
{{Template doc}} {{Merging}} (not redirectable)
{{Template doc inline}} (later) {{Merging}} (not redirectable)
{{Template doc page}} {{Merging}} (redirect)
{{Template doc page transcluded}} {{Merging}} (not redirectable)
{{Template doc page viewed directly}} {{Merging}} (redirect)

Conrad T. Pino 07:43, 7 November 2007 (UTC)
Conrad T. Pino 13:57, 9 November 2007 (UTC)
Conrad T. Pino 22:08, 9 November 2007 (UTC)
Conrad T. Pino 02:09, 10 November 2007 (UTC)
Conrad T. Pino 15:47, 11 November 2007 (UTC)
Conrad T. Pino 21:36, 11 November 2007 (UTC)

Merge template subpage directory

The following merge templates have subpages as follows:

Conrad T. Pino 11:26, 7 November 2007 (UTC)
Conrad T. Pino 12:48, 9 November 2007 (UTC)
Conrad T. Pino 22:03, 9 November 2007 (UTC)
Conrad T. Pino 22:19, 9 November 2007 (UTC)
Conrad T. Pino 00:45, 11 November 2007 (UTC)
Conrad T. Pino 21:39, 11 November 2007 (UTC)
Conrad T. Pino 21:50, 11 November 2007 (UTC)
Conrad T. Pino 08:52, 13 November 2007 (UTC)

Merge into template protection

The merge into templates are protected as follows:

Merge Object Template In Code Current Level Merging Level Permenant Level
{{Documentation}} {{pp-semi-template}} Semi-protection Semi-protection Full-protection
{{Documentation subpage}} {{pp-semi-template}} Semi-protection Semi-protection Semi-protection
Move-protection
{{Documentation, template}} {{pp-semi-template}} Unprotected
Semi-protection 		Semi-protection Full-protection

Conrad T. Pino 02:17, 10 November 2007 (UTC)
Conrad T. Pino 23:17, 11 November 2007 (UTC)
Conrad T. Pino 06:18, 12 November 2007 (UTC) Thank you Pathoschild for this protection edit.

DO NOT implement the permenant protection level until after merge is deemed complete per consensus here. – Conrad T. Pino 23:17, 11 November 2007 (UTC)

Merge from template protection

The merge into templates are protected as follows:

Merge Object Redirect Target Template In Code Current Level Merging Level Permenant Level
{{Template doc}} (not redirectable) {{pp-semi-template}} Semi-protection Semi-protection Full-protection
{{Template doc inline}} (not redirectable) {{pp-semi-template}} Semi-protection Semi-protection Full-protection
{{Template doc page transcluded}} (not redirectable) {{pp-semi-template}} Unprotected
Semi-protection 		Semi-protection Full-protection
{{Template documentation}} {{Template doc}} {{pp-semi-template}} Unprotected
Semi-protection 		Semi-protection Full-protection
{{Template doc page}} {{Documentation subpage}} Semi-protection Semi-protection Full-protection
{{Template doc page viewed directly}} {{Documentation subpage}} Unprotected
Semi-protection 		Semi-protection Full-protection

Conrad T. Pino 00:22, 12 November 2007 (UTC)
Conrad T. Pino 06:34, 12 November 2007 (UTC) Thank you Pathoschild for this protection edit.
Conrad T. Pino 06:34, 12 November 2007 (UTC) Thank you Pathoschild for this protection edit.
Conrad T. Pino 09:23, 12 November 2007 (UTC) Thank you Patrick for this protection edit.

DO NOT implement the permenant protection level until after merge is deemed complete per consensus here. – Conrad T. Pino 00:22, 12 November 2007 (UTC)

Merge Phase 1: service templates

The "service templates" are all those templates identified in Merge objects above and are distinguished as documentation service providers for client templates. – Conrad T. Pino 05:17, 16 November 2007 (UTC)

Service behaviors moved

All Merge from templates behavior occurs soley in the Merge into templates. – Conrad T. Pino 05:17, 16 November 2007 (UTC)

Full redirection impossible

Three (3) Merge from templates are noted (not redirectable) due to Template behavior differences or Template parameter differences making redirection impossible without breaking client template documentation or creating /doc double {{Documentation subpage}} displays. Once Merge Phases 2 and 3 are complete redirection is moot. – Conrad T. Pino 05:17, 16 November 2007 (UTC)

Merge Phase 2: client templates

{{Template doc inline}} clients - completed

After the {{Template doc}} transcludes {{Template doc inline}} link was broken the {{Template doc inline}} links page shrank considerably making manual client editing feasable. Few clients still transclude {{Template doc inline}} and most are in User space or are /testcases created for this merge.

Completing this work requires just one admin edit: Template talk:Tls#Edit requested 16-Nov-2007. – Conrad T. Pino 07:22, 16 November 2007 (UTC)

checkY Done - Nihiltres{t.l} 16:36, 16 November 2007 (UTC)
Thank you. – -- Conrad T. Pino (talk) 19:31, 16 November 2007 (UTC)

All {{Template doc inline}} clients are updated and the remaining trancludes are all /testcases in Template space or test cases with other names in User space. – Conrad T. Pino (talk) 08:37, 17 November 2007 (UTC)

{{Template doc}} clients

The {{Template doc}} links pages have between 1,500 and 2,000 entries. – Conrad T. Pino 07:41, 16 November 2007 (UTC)

Bot or script wanted!

Any volunteers? If you make the time I'll provide the specification. – Conrad T. Pino 07:41, 16 November 2007 (UTC)

Formal bot request opened

A formal bot request with specification was opened for review. – Conrad T. Pino (talk) 03:45, 18 November 2007 (UTC)

Merge Phase 3: /doc pages

Who is using whom:

Conrad T. Pino (talk) 10:05, 17 November 2007 (UTC)

Pretty icon eye candy

Check out this icon eye candy I found User:ConradPino/project/Documentation/eye candy and this is how it might look:

Example removed 2012-04-06, as it was breaking the archive due to changes in {{Documentation}} since 2007. Anomie⚔ 12:00, 6 April 2012 (UTC)

Any objections to making the above sample the {{Documentation}} default? – Conrad T. Pino 04:45, 12 November 2007 (UTC)

Yes; the icons are unnecessary, and using icons simply for aesthetic appeal gives pages an amateurish look. Whenever possible, icons should be avoided on serious pages unless something needs to be strongly emphasized, which isn't the case here. "Documentation" is just a heading, like any other; it just happens to be in a template and faked for technical reasons. —{admin} Pathoschild 08:40:06, 12 November 2007 (UTC)
Everything you've said is true. I'm just easily lead astray by pretty faces! :) Conrad T. Pino 09:30, 12 November 2007 (UTC)
Too bad! :) —{admin} Pathoschild 12:19:45, 12 November 2007 (UTC)
Ohh, another pretty face, I swoon before such persuasion. :) Conrad T. Pino 08:40, 13 November 2007 (UTC)
I agree with Pathoschild, an icon is not needed.—Patrick 11:05, 12 November 2007 (UTC)
Thank you. – Conrad T. Pino 08:40, 13 November 2007 (UTC)

OBJECTION! Examiner is leading the witness by implying the evidence as mere "eye candy". The defense suggests an impartial line of questioning. —Down10 TACO 06:47, 23 November 2007 (UTC)

Why do you feel the need...

...to inform me, for no apparent reason, that there are no testcases and no sandbox (your formatting) for 99% of Wikipedia's templates that will never need such pages (indeed, I disagree with the idea of such pages in the first place; if you want a sandbox, we already have a sandbox)? It looks stupid – Gurch 10:52, 13 November 2007 (UTC)

I agree there is no universal need. However many templates are {{esoteric}}/{{intricate}} with parser functions or {{editprotected}} or both. I view {{editprotected}} templates as contribution stifling necessities. My biased software engineer's perspective favors wide Wikipedia:Template test cases adoption and Wikipedia:Template documentation as well.
In this case having the extra baggage simplified continued non-admin contribution.
The "...has no sandbox and no testcases for..." contains sandbox testcases edit links supporting rapid creation. Preloading /testcases already occurs, preloading /sandbox is coming. The creating edit links save time and reduce errors. In cases where a /sandbox and /testcases (both) harm then code
{{Documentation|sandbox-testcases=hide}}
I'm open to adding "sandbox=hide" and "testcases=hide" if found useful.
This template's past behavior was display the messge only when both /sandbox and /testcases were present. Today's behvior displays 1 of 4 message variations in the Template or User namespaces. Revisions to this behavior change are best discussed here.
Wikipedia:Template test cases is a how-to guide far from guideline or official policy and worthy continued "I disagree with the idea of such pages in the first place;" discussion preferably on that talk page.
Conrad T. Pino 20:06, 13 November 2007 (UTC)

First line below heading displays in part "...is transcluded from /doc. (view | edit | history)" where "/doc", "view", "edit" and "history" are all hyperlinks. Malyctenar proposed removing "view" link as redundant to "/doc" link. I reverted the edit for other reasons but committed to stating reasons. This change is minor and of little consequence. I shall edit it back shortly. – Conrad T. Pino 11:37, 14 November 2007 (UTC)

Edit done in {{Documentation}} and {{Documentation/sandbox}}. Conrad T. Pino 11:51, 14 November 2007 (UTC)

10:26, November 14, 2007 edit reverted

I reverted edit by Malyctenar with summary, "I'm pretty sure people know that clicking on the blue pagename link thingy makes them see it; also no need to test SUBPAGENAME within noinclude of a single template". My revert edit summary was, "have reasons for all; will put on talk or doc within 48 hours; thank you" and I keep that commitment now.

The reverted edits included:

1. Change "...transcluded from .../doc. (view | edit | history)" to remove "view" link.
2. Remove "<noinclude>...{{ #ifeq: {{SUBPAGENAME}} | sandbox | {{Template sandbox notice}} | {{pp-semi-template|small=yes}} }} ... {{ #ifeq: {{FULLPAGENAME}} | Template:Documentation | ... }}</noinclude>".
3. Change #switch: test value layout, from the same line to multiple lines.
4. Remove 1 comment marking begin #if: true location and wording change others.

My comment on each of the above:

1. Change reapplied to reverted version, see Transcluded from /doc message link changes above.
2. The "/sandbox copy / paste solution" to the "{{editprotected}} problem", an evolving solution scheduled for change once consensus for latest {{Template sandbox notice}} becomes clear in time.
3. I honor any general or template specific #switch: layout consenus. I'm ignorant of #switch: layout consenses as I've been corrected for both styles.
4. Comments are idiosyncratic. I'm ignorant here also and seek knowledge of consensus, if any.

A clear statement and discussion of the "{{editprotected}} problem" and "/sandbox copy / paste solution" I leave for later and another place. Thank you all. – Conrad T. Pino 21:01, 15 November 2007 (UTC)

Retrieved from "https://en.wikipedia.org/w/index.php?title=Template_talk:Documentation/Archive_1&oldid=1096489338"