DynamicPageList3 Manual talk:Feedback: Difference between revisions

m
miraheze:dpl3>Soukupmi
(→‎Template Styles: I just re-did the last changes from Lens0021 oldid=2067 as it seems there had been an edit-clash mistake)
imported>FrozenPlum
 
(6 intermediate revisions by the same user not shown)
Line 180:
 
:Yes, content, writing and examples done first, then styles and formatting later, please. I didn't know there would be a problem using template styles (I don't use it). I thought you'd do it for manual parts like navigation, keys, DPL parameter first (I can't think of any good reason why users should be able to change example styles, honestly, that is not a necessity). Also, I apologize, I thought when you got to the examples, if template styles caused a problem that would complicate those examples, I thought you would know to stop there. I can clearly see now that template styles are impractical and problematic to be used on examples because of how the examples are done--this is exactly the reason I wanted questions, suggestions and changes to wait until '''after I was done fixing all the other content'''--the problem that happened explains perfectly ''why'' this stuff needs to wait; because all of the questions/requests and suggestions made will be easy to answer (or have been already answered) by the time I'm done that work. So, I'll say it again, please give me time to get the articles well written and examples working before making more questions/requests/suggestions/changes (those things that can wait, they will also be much easier to see/understand, discuss, do, and change '''''after''''' my initial work is done, but not before). Thanks for your understanding and willingness to wait until that's done, it is much appreciated. [[User:FrozenPlum|FrozenPlum]] ([[User talk:FrozenPlum|talk]]) 06:23, 20 April 2022 (UTC)
 
::Thanks to you both! I agree the order of doing is important. I will try not to take a long time to get the changes done, but that being said I do need to do it in small chunks over time, I apologize in advance for this inconvenience. PS. Thanks for fixing the edit conflict, Soukupmi (I hadn't noticed it). [[User:FrozenPlum|FrozenPlum]] ([[User talk:FrozenPlum|talk]]) 08:12, 20 April 2022 (UTC)
 
==Content Items that will need doing==
There are some items that need doing in the content, that would be very helpful to have (if '''anyone''' feels like doing it, if not, we'll/I'll get to it eventually). This can serve as a reminder/checklist for later, too:
* If there are defaults for anything (which there should be for many things) they need:
:* <code><nowiki> — ('''default''' is false)</nowiki></code> for this: — ('''default''' is false)
:* Or <code><nowiki> — ('''default''')</nowiki></code> for this: — ('''default'''), (if the option at hand is the default).
: We can refer [https://github.com/Universal-Omega/DynamicPageList3/blob/da27636f6b294f64e379c1fca96cbee0bbd83bc9/includes/ParametersData.php#L219 this] that [[User:Lens0021|Lens0021]] linked, since that may have the rest of the missing defaults.
* Variable names should be in code blocks, and if not in close proximity to an already linked repeat or its own page section. These should also generally have the variable linked using the "DPL" template: <code><nowiki><code>{{DPL|%PAGE%}}</code></nowiki></code>
* Parameter names should also be in code blocks, and, if not in close proximity to its own section or another already linked repeat, should be also linked: <code><nowiki><code>{{DPL|title}}</code></nowiki></code>. The only thing to keep an eye out for is, if a ''value'' is specified, that value should be in italics (there are a number of places this is not yet the case), e.g., <code>addcontribution=true</code> should be <code>addcontribution=''true''</code>, though of course in templates such as <code><nowiki>{{DPL parameter}}</nowiki></code>, the equals characters needs to be <code><nowiki>{{=}}</nowiki></code> or use <code><nowiki><nowiki></nowiki></nowiki></code>.
* We do need to check the parameter descriptions (thanks Lens0021 for pointing this out) against [https://github.com/Universal-Omega/DynamicPageList3/blob/da27636f6b294f64e379c1fca96cbee0bbd83bc9/includes/ParametersData.php#L219 the descriptions in the parameters.php] to see if they still align, if there's missing/useful information that needs adding, or if functions changed; though, we can't just take that wording as-is (there's a license difference--again thanks to Lens0021 for noticing that), we need to describe that behavior in our own (different) wording, which shouldn't be a problem (I may tweak this wording a bit as it relates to other paramters).
* If there are concepts that are moderate to advanced MediaWiki knowledge ("sortkey" and magic words were examples I linked) would be nice to link these to the relevant MediaWiki manual page for easy understanding/reading.
* Anywhere we're referring to the DPL3 extension in the text (not in syntax or examples of course), ideally these can be swapped from "DPL" to "DPL3" (eventually this may also aid SEO, when it's time to look at such, later on).
* There may need to be a review for minor fixes, typos, spacing adjustments for readability; I'm making sure headings, syntax lines, examples, have the equivalent of 2 lines of space between each to increase scanning ability and readability (which is necessary from teaching/learning perspective, and also makes page editing far easier spotting things on longer pages).
* When the examples are more complete (apologies, I'm cross-referencing and testing examples from multiple pages when doing this and filing bug reports, so it's taking some time, especially for the complex ones) after that, they'll need to be reviewed/checked for any missing information and to make sure they're clear and concise. I may need a few run-throughs to refine some of these, and you guys will likely spot errors/problems I missed (please feel free to just fix these, I can look at refining later if there needs to be a writing style tweak.
* I forgot to add [[Other parameters]] into the sidebar below [[Controlling output volume]], that'll need to get added later (this is more of a reminder for a later list to discuss). H4's also need a color (maybe deep blue or the MH logo dark brown) to set them apart from bold text (this has always annoyed me, that they'd make the default H4 style for vector to perfectly match bold text. A heading should never blend in with body text, that makes '''zero''' sense, probably they wanted to avoid imposing a color on people, so left it for customization). For now, I have an (ugly and temporary) <nowiki>{{hr}}</nowiki> style to separate these, it will need to be fixed/replaced later, when H4 is fixed (for now I need visual separation between these to finish working on and sorting out their complex {{DPL|include}} examples. I had to do that only as a temporary adjustment, to be able to work in a sane way). I'm still working through some of the harder to test and untangle examples.
Cheers [[User:FrozenPlum|FrozenPlum]] ([[User talk:FrozenPlum|talk]]) 21:32, 22 April 2022 (UTC)
 
==Taking more breaks==
I’m having problems with spasm, focus, and a number of other significant things. As there is no urgency for the resource (I asked CA in discord that there was “no urgency”, and this was indicated to be fine), I will need to do contributions at slower speed. Hobby (slow) is about all I can manage, but even doing things at that pace, I’m reminded I still routinely end up burnt out and not feeling well (as is the case atm). The good thing is, things are getting somewhat closer to being organized, working, and approaching ready, there’s just a bit more to go; so, I’ll try to finish the last section of my plan, I’ll just do that more spaced out and taking more breaks. I apologize for the length of time this is taking, and the need to take ''more'' time; I just can’t do normal-paced things due to my limitations. Sometimes I forget my limitations for a short while, until my body gives me a rather harsh reminder (it’s currently on strike XD). [[User:FrozenPlum|FrozenPlum]] ([[User talk:FrozenPlum|talk]]) 21:04, 25 April 2022 (UTC)
: The other good thing is, most things that are not working are now marked as such here (the other things seem to be fixed and working well again, which is awesome), and the Gamepedia/Fandom DPL3 manual can be used in the meantime, as it is still the official manual on the [[mw:Extension:DynamicPageList3|extension page]] until this one is more ready. [[User:FrozenPlum|FrozenPlum]] ([[User talk:FrozenPlum|talk]]) 21:22, 25 April 2022 (UTC)
Anonymous user