Editing User:Pharap/Wiki Improvement Proposals (section)

== Improvement Proposals ==

=== Inline D'ni Dictionary Template ===

{{
User:Pharap/Templates/Improvement Proposal Box
|reference=IP-001
|type=Template
|status=Unimplemented
}}

==== Summary ====

The wiki has [[Dictionary:Full_Word_List|an extensive dictionary]] which at the moment isn't being particularly well leveraged from within templates and articles. I propose to change that by adding some templates that could make use of the dictionary in conjuction with the D'ni rendering capabilities of the wiki to provide rendered D'ni with hover text that provides information from the D'ni dictionary.

Notably, the hover text would be able display the three main ways of writing that word ([[Dnifont]], [[OTS]], and [[NTS]]), as well as the IPA pronunciation of the word.

==== Reasoning ====

This feature would make it easier to provide more linguistic information with less markup and less effort.

The primary way of implementing this template (see [[#Example|Example]] below) would allow using the name of the dictionary entry, which is likely easier for those who are not well-versed in Dnifont. However, a secondary implementation supporting Dnifont may be provided.

Having the IPA pronunciation would be particularly useful considering how many pages currently feature rendered Dnifont and OTS-style words but lack any corresponding IPA. The presence of IPA would be incredibly useful for readers who understand the meaning of the IPA symbols, as it would help them to know how to pronounce the various D'ni words and names that crop up throughout the wiki.

==== Example ====

A usage like <code><nowiki>{{D'ni word OTS|Teledahn}}</nowiki></code> could appear as thus: {{User:Pharap/Templates/D'ni word OTS|Teledahn}}.

Hence one would only need to remember the name of the dictionary entry, and the template will generate all relevant information as part of the hover text.

Alternatively, a variant like <code><nowiki>{{D'ni word Dnifont|teleDan}}</nowiki></code> accepting Dnifont could also be permitted, as well as possibly a form that could accept either argument, such as <code><nowiki>{{D'ni word|ots=Teledahn}}</nowiki></code> and <code><nowiki>{{D'ni dict|dnifont=teleDan}}</nowiki></code>, perhaps even having <code><nowiki>{{D'ni word|Teledahn}}</nowiki></code> be treated as <code><nowiki>{{D'ni word|ots=Teledahn}}</nowiki></code>.

Ideally the hover text would be better formatted, more like the <nowiki>[[Has length::30 cm]]</nowiki> property from the Semantic MediaWiki addons: [[Has length::30 cm]], but I have yet to investigate how that might be achieved.

==== Implementation ====

As a proof of concept, I have implemented all the aforementioned templates:
* A template that accepts a [[Dictionary:Full Word List|Dictionary]] page name:
** <code><nowiki>{{</nowiki>[[User:Pharap/Templates/D'ni word OTS]]<nowiki>|</nowiki>Teledahn<nowiki>}}</nowiki></code> → {{User:Pharap/Templates/D'ni word OTS|Teledahn}}
* A template that accepts [[Dnifont]]:
** <code><nowiki>{{</nowiki>[[User:Pharap/Templates/D'ni word Dnifont]]<nowiki>|</nowiki>teleDan<nowiki>}}</nowiki></code> → {{User:Pharap/Templates/D'ni word Dnifont|teleDan}}
* A template that accepts either:
** <code><nowiki>{{</nowiki>[[User:Pharap/Templates/D'ni word]]<nowiki>|</nowiki>Teledahn<nowiki>}}</nowiki></code> → {{User:Pharap/Templates/D'ni word|Teledahn}}
** <code><nowiki>{{</nowiki>[[User:Pharap/Templates/D'ni word]]<nowiki>|</nowiki>ots=Teledahn<nowiki>}}</nowiki></code> → {{User:Pharap/Templates/D'ni word|ots=Teledahn}}
** <code><nowiki>{{</nowiki>[[User:Pharap/Templates/D'ni word]]<nowiki>|</nowiki>dnifont=teleDan<nowiki>}}</nowiki></code> → {{User:Pharap/Templates/D'ni word|dnifont=teleDan}}

Discovering how to implement this solution took me quite a lot of research as at first I didn't know about the existance of the [[Property:OTS|OTS]], [[Property:NTS|NTS]], and [[Property:IPA|IPA]] properties, as their existence was somewhat buried in the [[Module:Dict D'ni|Dict D'ni]] module and {{tl|IPA}} template respectively. After figuring those out I managed to discover some modules that support the '<code>dnifont2ots</code>' and '<code>dnifont2nts</code>' functions.

It also took me a while to realise that the syntax <code><nowiki>[[Property::Value]]</nowiki></code> can be used to declare a value for a property in the same way as <code><nowiki>{{#set: Property=Value}}</nowiki></code>, and that consequently the following two lines of the D'ni Dict module are producing two properties:
* <code><nowiki>output = output..'* [[OTS]]: [[OTS::'..dnifont2ots(args['dnifont'])..']]\n'</nowiki></code>
* <code><nowiki>output = output..'* [[NTS]]: [[NTS::'..dnifont2nts(args['dnifont'])..']] '</nowiki></code>

Specifically:
* If the expression <code><nowiki>dnifont2ots(args['dnifont'])</nowiki></code> were to produce <code>teledahn</code> then the output <code><nowiki>* [[OTS]]: [[OTS::teledahn]]</nowiki></code> would be inserted into the page.
* If the expression <code><nowiki>dnifont2nts(args['dnifont'])</nowiki></code> were to produce <code>teledan</code> then the output <code><nowiki>* [[NTS]]: [[NTS::teledan]]</nowiki></code> would be inserted into the page.

In the case of the {{tl|IPA}} template, I simply hadn't peeked at its source. At one point I had separately thought of the possibility of including such a property in the {{tl|IPA}} template, but for a while after I had simply presumed that it wouldn't be there and hadn't thought to check until I ended up looking at the source by chance when editing my User page and noticing the property's presence.

After getting a working prototype, I went back and refined the templates several times, including changes such as adding a <code>link</code> parameter, changing how I was using the 'dnifont2ots' facilities (due to discovering a second module with the same functionality), and splitting the hover text over multiple lines.

=== Apocrypha Banner ===

{{
User:Pharap/Templates/Improvement Proposal Box
|reference=IP-002
|type=Template
|status=Unimplemented
}}

==== Summary ====

At the moment, [[GoArch:Apocrypha|apocrypha]] articles using the {{tlx|apocrypha}} template are marked with a small badge at the top right of the page which is unobvious and easily overlooked.

I propose that instead of (or in addition to) a small badge, apocrypha articles be marked with a large banner at the top of the page as is done with both Out-of-Cavern artices (e.g. [[Riven (game)]]) via the {{tlx|OOC}} tag and [[GoArch:Unexplored Branches|Unexplored Branches]] articles (e.g. [[Chiso Preniv]]) via the {{tlx|Unexplored Branches}} tag.

==== Reasoning ====

The reasoning behind this suggestion is to make apocrypha articles more obvious and less likely to be mistaken for 'official' content, particularly in cases where particularly well-made apocrypha with similar quality and/or appearance to official content might easily be mistaken for official content if one has overlooked the badge.

==== Example ====

The banner by including the {{tlx|apocrypha}} template would appear as thus:

{{ambox
| type=notice
| image=[[File:Apocrypha.png|50px]]
| issue = is [[GoArch:Apocrypha|apocrypha]]. It should be considered [[GoArch:Canon policy|non-canon]] and may consist of fan-created content.
| small = {{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}} }}
| sect = {{{sect|{{{section|{{{1|}}}}}}}}}
}}

The badge on the top right of the page could appear as it currently does or be omitted.

==== Implementation ====

The change could be enacted by the use of an {{tlx|ambox}} template.

<pre><nowiki>
<indicator name="apocrypha">[[File:Apocrypha.png|30px|link=GoArch:Apocrypha]]</indicator><includeonly>[[Category:Apocrypha]]</includeonly>
{{ambox
| type=notice
| image=[[File:Apocrypha.png|50px]]
| issue = is [[GoArch:Apocrypha|apocrypha]]. It should be considered [[GoArch:Canon policy|non-canon]] and may consist of fan-created content.
| small = {{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}} }}
| sect = {{{sect|{{{section|{{{1|}}}}}}}}}
}}
<noinclude>
'''This template is for indicating that an article is about a non-canon subject. Non-canon subjects include:
* Fan-created content, such as the [[Lara Documents]] or fan-created Ages
* Material from the Dark Horse comics
* Ret-conned content from the Myst novels (such as [[Tadjinar]])</noinclude>
</nowiki></pre>

This template currently includes no documentation, though if any were needed it should simply be a matter of adapting the documentation provided for the {{tlx|OOC}} or {{tlx|Unexplored Branches}} templates.

=== Hover Text Template ===

{{
User:Pharap/Templates/Improvement Proposal Box
|reference=IP-003
|type=Template
|status=Unimplemented
}}

==== Summary ====

I propose introducing a <code><nowiki>{{hover text}}</nowiki></code> template like [https://en.uesp.net/ UESP]'s <code><nowiki>{{</nowiki>[https://en.uesp.net/wiki/Template:Hover hover]<nowiki>}}</nowiki></code> template, which is itself based on Wikimedia's <code><nowiki>{{</nowiki>[https://meta.wikimedia.org/wiki/Template:H:title?useskin=vector H:title]<nowiki>}}</nowiki></code>.

==== Reasoning ====

This new template would be useful for adding contextual information as a basic tooltip, and could be used as a base for building further, more complex templates.

==== Example ====

* <code><nowiki>{{Hover text|This is the hovertext|This is the main text}}</nowiki></code> → {{User:Pharap/Templates/Hover text|This is the hover text|This is the main text}}
* <code><nowiki>{{Hover text|This is the hovertext|This is the main text|dotted=no}}</nowiki></code> → {{User:Pharap/Templates/Hover text|This is the hover text|This is the main text|dotted=no}}

==== Implementation ====

The easiest way to impelement this would be with a <code>title</code> attribute on a <code>span</code> element. There may, however, be a better, more sophisticated, or more semantically correct way to implement the template. Fortunately, it can be amended after-the-fact if necessary.

Additionally, the text would be underlined with a <span style="bottom-border: 1px dotted">dotted line</span> to highlight the fact the user can hover over it, and the cursor could be optionally changed to the <span style="cursor: help">help cursor</span>.

By default, the first parameter would be the hover text and the second parameter would be the main text. A <code>dotted</code> parameter would be used to disable the dotted line.

See <code><nowiki>{{</nowiki>[[User:Pharap/Templates/Hover text]]<nowiki>}}</nowiki></code> for a functional implementation.

=== Abbreviation Template ===

{{
User:Pharap/Templates/Improvement Proposal Box
|reference=IP-004
|type=Template
|status=Unimplemented
}}

==== Summary ====

This would function very much like the [[#Hover Template|aforementioned <code><nowiki>{{hover}}</nowiki></code> template]], but would instead rely on the <code><nowiki><abbr></nowiki></code> HTML element.

==== Reasoning ====

While the observable functionality is identical to <code><nowiki>{{hover}}</nowiki></code>, there would be a distinct semantic difference that may be of use to external tools, or perhaps to screenreaders.

Note, from [https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr#attributes Mozilla's documentation]:

<blockquote>
The title attribute has a specific semantic meaning when used with the <abbr> element; it must contain a full human-readable description or expansion of the abbreviation. This text is often presented by browsers as a tooltip when the mouse cursor is hovered over the element.
</blockquote>

==== Example ====

* Dictionary Abbreviations:
** {{User:Pharap/Templates/Abbreviation|full=noun|abbreviation=n.}}
** {{User:Pharap/Templates/Abbreviation|full=adjective|abbreviation=adj.}}
** {{User:Pharap/Templates/Abbreviation|full=preposition|abbreviation=prep.}}
** {{User:Pharap/Templates/Abbreviation|full=prefix|abbreviation=pre.}}
** {{User:Pharap/Templates/Abbreviation|full=suffix|abbreviation=suf.}}

==== Implementation ====

The implementation would use the <code><nowiki><abbr></nowiki></code> {{User:Pharap/Templates/Abbreviation|abbreviation=HTTP|full=HyperText Markup Language}} element and its <code>title</code> attribute.

See <code><nowiki>{{</nowiki>[[User:Pharap/Templates/Abbreviation]]<nowiki>}}</nowiki></code> for a functional implementation.

=== Sic Template ===

{{
User:Pharap/Templates/Improvement Proposal Box
|reference=IP-005
|type=Template
|status=Unimplemented
}}

==== Summary ====

At the moment the {{tl|sic}} template merely produces a box with a link to Wikipedia, roughly appearing as &#91;''[[w:sic|sic]]''&#93;. The template accepts word fragments, but doesn't do anything useful with them.

I would like to propose an alternative implementation of {{tl|sic}} that would be based on [https://en.uesp.net/wiki/Main_Page UESP]'s [https://en.uesp.net/wiki/Template:Sic implementation] of {{tl|sic}}. Specifically, it would accept the verbatim text and a corrected form, and provide the corrected form as hover text that appears when the incorrect word is hovered over with the reader's cursor.

(A surplus of examples can be found in the [https://en.uesp.net/wiki/Bloodmoon:Airship_Captain%27s_Journal Bloodmoon:Airship Captain's Journal] article.)

I would also propose that the revised {{tl|sic}} link to an internal article on the wiki rather than externally linking to Wikipedia, to avoid the generation of the <span class="extiw" style="padding: 8px;"></span>&nbsp;icon, which clutters the page. The most obvious candidate at the moment would be the [[GoArch:Style_guide#Quotations|Quotations]] section of the style guide.

==== Reasoning ====

Merely highlighting that a word is incorrect is of limited use and provides only half the information necessary to understand the problem, relying on the reader to inuit both what the problem actually is and what the correct text should be.

Providing a correction not only informs the reader of what the text should have said, but helps them to recognise why the incorrect text is incorrect.

==== Example ====

Examples:
* <code><nowiki>{{User:Pharap/Templates/Sic|Whark|Wahrk}}</nowiki></code> → {{User:Pharap/Templates/Sic|Whark|Wahrk}}
* <code><nowiki>{{User:Pharap/Templates/Sic|Ghen|Gehn}}</nowiki></code> → {{User:Pharap/Templates/Sic|Ghen|Gehn}}
* "<code><nowiki>{{User:Pharap/Templates/Sic|Muphry|Murphy|link=no}}'s law</nowiki></code>" → "{{User:Pharap/Templates/Sic|Muphry|Murphy|link=no}}'s law"

To provide a more concrete example, [[Reference:Gehn, Lab journal|Gehn's Lab Journal]] incorrectly says "discreet" instead of "discrete", and at present that looks like discreet {{sic|[discrete]}}. With the proposed change, it would appear as (something more like) {{User:Pharap/Templates/Sic|discreet|discrete}}.

==== Implementation ====

A functional implementation can be viewed at <code><nowiki>{{</nowiki>[[User:Pharap/Templates/Sic]]<nowiki>}}</nowiki></code>.

=== IPA Hover Guides ===

{{
User:Pharap/Templates/Improvement Proposal Box
|reference=IP-006
|type=Module
|status=Unimplemented
}}

==== Summary ====

Wikipedia has an {{tl|IPAc-en}} template that produces IPA that provides a pronunciation guide when hovering over the individual characters. For example, the [https://en.wikipedia.org/wiki/Basalt?useskin=vector Basalt] page features examples such as /ˈbæsɔːlt/ where hovering over the 'b' gives "'b' in 'buy'", hovering over the 'æ' gives "'a' in 'bad'", hovering over the 's' gives "'s' in 'sigh'", et cetera.

It would be useful if similar functionality could be reproduced on this wiki.

==== Reasoning ====

It would provide a useful starting point for people who aren't familiar with IPA and are trying to understand how to pronounce various names and D'ni words.

==== Example ====

A hypothetical <nowiki>{{IPAc-en|t|ɛ|.|l|ɛ|.|d|ɑ|n}}</nowiki> would give /<span style="border-bottom: 1px dotted"><span title="/t/: 't' in 'tigh'">t</span><span title="/ɛ/: 'e' in 'dress'">ɛ</span>.<span title="/l/: 'l' in 'lie'">l</span><span title="/ɛ/: 'e' in 'dress'">ɛ</span>.<span title="/d/: 'd' in 'dye'">d</span><span title="/ɑ/: 'a' in 'father'">ɑ</span><span title="/n/: 'n' in 'nigh'">n</span></span>/.

==== Implementation ====

Despite being used as a template, this would be best implemented as a module.

The exact implementation is currently ''to be confirmed'', but the general idea is simple enough:
* Each numbered parameter will be examined.
* The specific IPA character will be looked up in a table of tooltips.
* If a corresponding piece of tooltip text was found:
** The character will be inserted into the page surrounded by a <code>span</code> with the <code>title</code> set to whatever the found tooltip was.
** Otherwise, the character will be inserted without any additional processing.

The whole thing would be wrapped in a <code>span</code> element with its <code>style</code> attribute set to produce a dotted line, and that would be bookended by forward slashes.

=== Add a <code>quote</code> Parameter to {{tlx|cite journal}} ===

==== Summary ====

I propose to add a <code>quote</code> parameter to the {{tlx|cite journal}} template so that references may include specific quotes relevant to the claim being supported by the citation.

==== Reasoning ====

The intent of such a quotation would be to make it easier to verify claims as readers would not have to (for example) go hunting through entire journals just to find the one sentence that supports the claim made in the article.

==== Example ====

The <code>quote</code> parameter could then be used as thus:
<pre><nowiki>
<ref name="Tay">{{cite journal|author=Catherine|journal=Personal journal|journal-page=Reference:Catherine, personal journal (Riven)|game=Riven|quote=They have named it "Tay"}}</ref>
</nowiki></pre>

Producing an output of:
<blockquote><samp>Catherine, ''Personal journal''. Riven. "They have named it "Tay""</samp></blockquote>

The presence or absence of quote marks and/or the style of the quote marks would be up for discussion.

Should anyone find the nesting of the same style of quotes unsatisfactory, I ''believe'' it should be possible to enforce the inner quotes being made a different style.

==== Implementation ====

This proposal could be implemented by simply adding <code><nowiki>{{#if:{{{quote|}}}| "{{{quote}}}"|}}</nowiki></code> to the existing template, such that it becomes:

<pre><nowiki>
{{{author}}}. ''{{{journal-nolink|[[{{{journal-page|Reference:{{{author}}}, {{{journal}}}}}}|{{{journal}}}]]}}}''. {{{game-nolink|[[{{{game-page|{{{game}}}}}}|{{{game}}}]]}}}.{{#if:{{{quote|}}}| "{{{quote}}}"|}}<noinclude>{{documentation}}</noinclude>
</nowiki></pre>

The documentation for the template could be ammended with:

<pre><nowiki>
"quote":
{
	"label": "Quote",
	"description": "A selected quote from the referenced journal. The chosen quote should be relevant to the article content that makes use of the citation. If omitted, no quote is included in the reference.",
	"example": "They have named it \"Tay\"",
	"type": "string"
}
</nowiki></pre>

As well as the addition of <code>"quote"</code> to the end of the <code>paramOrder</code> array.

Note: In regards to enforcing that nested quotes use a different style, I don't believe templates alone are capable of text replacement that sophisticated, though it's possible they support some sort of regex-replacement feature that I'm unaware of at the time of writing. To support such a feature would, I believe, require a Lua module. I haven't researched that as I'm presuming it won't be an issue, but should it be an issue I have sufficient experience with Lua and parsing that I'm confident I could make a good go of it.