Editing Module talk:Hatnote (section)

==New docstyle== 
:Can we please change our example-habit? There is just "Pagename" and "Topic" to be used. In titlecase of course. Really, after ten years the example text "USE1" still does not say anything to me (I really mentally have to translate it to "Usage1", meaning "Topic1", to understand).

Example from previous topic, now improved:
* <code><nowiki>{{redirect|FromRedirectPage|Topic1|Targetpage1|Topic2}}</nowiki></code> → {{redirect|FromRedirectPage|Topic1|Targetpage1|Topic2}}
* <code><nowiki>{{redirect/sandbox|FromRedirectPage|Topic1|Targetpage1|Topic2}}</nowiki></code> → {{redirect/sandbox|FromRedirectPage|Topic1|Targetpage1|Topic2}}
:{{U|Nihiltres}}, is that final link change intended? (see what good demos do ;-) ). -[[User:DePiep|DePiep]] ([[User talk:DePiep|talk]]) 19:55, 7 April 2016 (UTC)

::I find the all-caps part of the existing style extremely helpful, since it adds visual contrast that helps highlight where input text is passed through (since the rest of the text is sentence-case). I'm not terribly attached to the naming scheme, but as patterns, we should probably:
::# include the string "PAGE" on example inputs that are intended to reflect page names
::# include the string "TEXT" on example inputs that are passed through as plain text
::# have example inputs reflect their intended replacements in actual use.
::So, for example:
::* <code><nowiki>{{redirect2|REDIRECTPAGE1|REDIRECTPAGE2|USAGE1|PAGE1}}</nowiki></code> → {{redirect2|REDIRECTPAGE1|REDIRECTPAGE2|USAGE1|PAGE1}}
::* <code><nowiki>{{about|TOPICTEXT|USAGE1|PAGE1|and|PAGE2}}</nowiki></code> → {{about|TOPICTEXT|USAGE1|PAGE1|and|PAGE2}}
::<span style="white-space:nowrap;">{&#123;[[User:Nihiltres|<span style="color:#233D7A;">Nihiltres</span>]]&#8202;&#124;[[User talk:Nihiltres|talk]]&#8202;&#124;[[Special:Contributions/Nihiltres|edits]]}&#125;</span> 20:11, 7 April 2016 (UTC)
:::'''No'''. Not even in lowercase that doc scheme helps. You keep mixing up topics and pages, (even adding texts by now!) which is not OK at this module level. (btw, did you notice your sandbox alters parameter usage, as I noted & showed?). [I suppress the invitation to write this in all uppercase. For now]. -[[User:DePiep|DePiep]] ([[User talk:DePiep|talk]])
::::{{re|DePiep}} OK, so what are the principles behind your proposed scheme? I don't quite understand what you're criticizing in my example. Also, yes, I'm aware of the discrepancy in my sandboxed code, since I was the one who pointed it out above. However, given this:
::::*<code><nowiki>{{redirect|REDIRECTPAGE1|TOPIC1|PAGE1|other uses}}</nowiki></code> → {{redirect|REDIRECTPAGE1|TOPIC1|PAGE1|other uses}}
::::*<code><nowiki>{{about|ABOUT-TEXT|TOPIC1|PAGE1|other uses}}</nowiki></code> → {{about|ABOUT-TEXT|TOPIC1|PAGE1|other uses}}
::::*<code><nowiki>{{redirect/sandbox|REDIRECTPAGE1|TOPIC1|PAGE1|other uses}}</nowiki></code> → {{redirect/sandbox|REDIRECTPAGE1|TOPIC1|PAGE1|other uses}}
::::…perhaps my sandboxed code's behaviour is actually preferable. <span style="white-space:nowrap;">{&#123;[[User:Nihiltres|<span style="color:#233D7A;">Nihiltres</span>]]&#8202;&#124;[[User talk:Nihiltres|talk]]&#8202;&#124;[[Special:Contributions/Nihiltres|edits]]}&#125;</span> 23:04, 7 April 2016 (UTC)
:::::<small>Writing uppercase is actually [[WP:SHOUTING|shouting]]. Stop it. -[[User:DePiep|DePiep]] ([[User talk:DePiep|talk]]) 00:23, 8 April 2016 (UTC)</small>
:{{od}} Ergh? This thread is about how to document, demo, describe a template. Not about whether the template works well. (sandbox changes are discussed elsewhere). Now can you go back about my proposal? -[[User:DePiep|DePiep]] ([[User talk:DePiep|talk]]) 23:10, 7 April 2016 (UTC)
::You keep using uppercase. That is to troll me, right? To trick me into abusive (uppercase) responses, right? Now, to get back to peace, can you point to any serious documentation that actually ''does'' use uppercase and wins? -[[User:DePiep|DePiep]] ([[User talk:DePiep|talk]]) 23:14, 7 April 2016 (UTC)
:::Boy, your example is even worse. I tried to demo and use "|other uses" (from your demo here), but I ''had'' to discover that it is input text, not template code text. Etcetera, etcetera: always mixing up texts & structures & meanings. What a lousy approach. I can not help you any more. Last (& first) advise: do not use uppercase. -[[User:DePiep|DePiep]] ([[User talk:DePiep|talk]]) 23:57, 7 April 2016 (UTC)
:re ''OK, so what are the principles behind your proposed scheme? '': 1. use Titlecase, not uppercase. Ever. (Or next week you won't even understand your own documentation). 2. Read #1 again. 11. Use "Topic''n''" and "Targetpage''n''" throughout. Whatever the cost. 12. (later more). -[[User:DePiep|DePiep]] ([[User talk:DePiep|talk]]) 00:14, 8 April 2016 (UTC)
::Suffice to say, I support the uppercase status quo and oppose moving to title-case; I've already said that I believe it offers readability benefits, and you're not offering any substantive counterargument (past the claim that it's "shouting", which doesn't make sense given the clear documentary context). I'll leave it at that, until others comment at least. <span style="white-space:nowrap;">{&#123;[[User:Nihiltres|<span style="color:#233D7A;">Nihiltres</span>]]&#8202;&#124;[[User talk:Nihiltres|talk]]&#8202;&#124;[[Special:Contributions/Nihiltres|edits]]}&#125;</span> 19:12, 8 April 2016 (UTC)
:::Well, don't [[WP:SHOUT]] is reason enough to stop it (#1). I also asked for examples where uppercase makes good documentation - none so far (#2). And, I pointed out that ''only'' after using readable input, it shows that one input was used for double semantics (topic & pagename mixup) (#3). After these three, you personal opinion & preference does not matter that much, does it? -[[User:DePiep|DePiep]] ([[User talk:DePiep|talk]]) 21:01, 8 April 2016 (UTC)