User:FrozenPlum: Difference between revisions

From DynamicPageList3 Manual
Content added Content deleted
imported>FrozenPlum
mNo edit summary
imported>FrozenPlum
m (Update my reminders to myself before my brain eats them lol.)
Line 2: Line 2:


==Self Reminders==
==Self Reminders==

Still '''need to add notes''' to areas where there's code but a non-working example (preferably before making the wiki public again, link to info about this to let users know more explicitly why they don't work (yet) and that there's a plan for this also). I have this template for it, but I'm too tired and need a break before I put it everywhere it needs to go to head off any questions about this portion. I still have a few things to fix yet also... if I can get both of these done, then ready to open for business again. Here's the template because I'll forget tomorrow:
* Still need to work though [[Special:WantedPages]] to fix or change any of these that should or should not be there.
* The pages for submitting a bug report, installing, getting extension (its MW page, github), giving feedback etc are not here yet and where this all goes might get juggled around depending on UO's feedback.
* There probably should be a page explaining how to enable DPL3 on Miraheze (or linking to MH ManageWiki docs and at least saying what tab the extension is found in).
* Still '''need to add notes''' to areas where there's code but a non-working example (preferably before making the wiki public again, link to info about this to let users know more explicitly why they don't work (yet) and that there's a plan for this also). I have this template for it, but I'm too tired and need a break before I put it everywhere it needs to go to head off any questions about this portion. I still have a few things to fix yet also... if I can get both of these done, then ready to open for business again. Here's the template because I'll forget tomorrow:
{{tempnote}}
{{tempnote}}



Revision as of 02:56, 30 March 2022

This is not my wiki, I'm just a Miraheze user helping to get some content moved over. Feel free to reach me on my Talk page.

Self Reminders

  • Still need to work though Special:WantedPages to fix or change any of these that should or should not be there.
  • The pages for submitting a bug report, installing, getting extension (its MW page, github), giving feedback etc are not here yet and where this all goes might get juggled around depending on UO's feedback.
  • There probably should be a page explaining how to enable DPL3 on Miraheze (or linking to MH ManageWiki docs and at least saying what tab the extension is found in).
  • Still need to add notes to areas where there's code but a non-working example (preferably before making the wiki public again, link to info about this to let users know more explicitly why they don't work (yet) and that there's a plan for this also). I have this template for it, but I'm too tired and need a break before I put it everywhere it needs to go to head off any questions about this portion. I still have a few things to fix yet also... if I can get both of these done, then ready to open for business again. Here's the template because I'll forget tomorrow:
This example is currently non-working, it may be replaced or removed at a later date to improve the clarity of this manual. As this needs to be done at a deliberate pace, the Gamepedia DPL3 Manual can be used in the interim, keeping in mind some functions may have changed.

DPL3 Code Demos

I'm aware almost all use examples are currently broken, this is intentional until they can be replaced because this resource is in development. It is not ideal to have manual pages manifest inside the manual itself (this adds a level of unnecessary complexity for new users). Ideally, it would be optimal to have different example categories to draw from (e.g., fruit, pastries, cities, etc.) that are overly simple, and nearly impossible to confuse other site content. Some time is needed to determine a solid instructional plan for this, it will likely be similar to the examples used in the Help:Tables page to explain tables simply, on MediaWiki.org. It is best practice to begin with the simplest examples possible, to avoid ambiguity and any level of unnecessary complexity. This type of approach shifts the focus from the output to the learning at hand because the concepts used in the examples are highly intuitive and easily understood or ignored. It is best practice to use simple concepts in examples, and only add complexity of the learning itself (not the examples) as the complexity of the task increases. I need some time to think of a solid structure and organization for these "demo pages" (such as category:fruit, category:pastry category:city etc). Please be patient, until the examples are corrected, please use the Gamepedia DPL3 Manual.

Examples

It would be good to have "more examples" links in-line, in each parameter's page section, that display a full selection of examples specific to a given parameter. Ideally, these should be named with parameter name first followed by "example" or "(Example)" (this allows examples to be quickly-skimmable from different entry points, like the Examples page, where it would make readers do less work to find what they want).

The logic is to cater to different audiences and entry points to the information:

  1. Comprehensive – Audience: Average or infrequent visitors, needing to re-read parameter sections – Examples still say in-line, just also linking to "more examples" for a larger selection of and different use cases/examples for that parameter.
  2. Task-based – Audience: Moderate to advanced and/or frequent visitors, already having read the parameter sections. – Allows a fast starting point/reference, or quick copy/paste of example code to adapt, without having to sift though the longer pages or their TOCs (A problem with the current Gamepedia DPL3 Manual).

Individual examples for "More Examples" may need their own pages, so they can be categorized by parameter use, and then transcluded or DPL3 included, into the other pages mentioned ^ above. I'm still thinking about a system of sorts for this, it may take some time to hatch a solid plan.

The DPL2 site had an Examples category, but the examples had generic names like "Example 002" which made the task-based approach not feasible because you'd either have to click every one, or had to sift though manual sections like the Gamepedia Manual currently. Also, too many in-line examlpes can cause issues. Some titles are a little strange, like "Example:_Display_images_used" but that type of categorization and/or page might be a good idea for when users want to see different ways to display images! Relevant examples, to the task at hand, just need to be way easier to find, which is why I'd need some time to think about approaching this systematically.

=Templates using Variables and Loops

The following use Variables (also some use Loops, plus string functions enabled in ManageWiki for parser functions), which will perhaps need simplification and replacement later:

  1. {{DPL parameter}} – for linking to a parameter (also linked to current DPL syntax template, where the global vars are declared).
  2. {{DPL syntax}} – for displaying variations on mode=modename
    • Am considering replacing with {{syntax|text{{=}}value}}
  3. {{And}} – Possibly never would have found this if I hadn't been going through pages and templates individually... since there appears to be no tracking categories for some extensions.
  4. {{Key}} - Not sure this template complexity is really necessary at all.