Difference between revisions of "User:Murph"

From Kerbal Space Program Wiki
Jump to: navigation, search
m (Use cases: Nested navboxes)
m (TODO: nonumtoc)
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
I'm just using this page as my personal sandbox.  Please do not edit this page or any of its subpages without my express permission (unless you are an official wiki admin, of course, and it's actually causing any problems).
+
{{Userboxtop}}
 +
{{User en}}
 +
{{Userboxbottom}}
  
== [[/Template:Navbox]] ==
+
I'm just using this page as a mixture of my personal sandbox, and a place to publish some of my thoughts about things I'm doing on the wiki.  Please do not edit this page or any of its subpages without my express permission (unless you are an official wiki admin, of course, and it's actually causing any problems).
  
=== Things I'd like to improve ===
+
'''Warning: Those who do not know anything about the deeper details of the MediaWiki parser or templates may wish to stop reading nowI do not accept any responsibility for mental damage caused by reading about things like that;-)'''
* The current {{Tl|Navbox}} template is a horribly dense block of wiki script code.  It carries a warning not to edit it due to the complexity, which is quite justified, but the complexity is made far worse by it being collapsed into a single block of impossible to maintain code (I rate it as impossible for anyone to reliably maintain, even seasoned MediaWiki experts).
 
* We're using raw {{Tl|FlipBox}} templates as navboxes, with each instance containing its own style information and variancesThis makes it harder to maintain a consistent visual result across the wiki, as well as duplicating maintenance effort and potential errors/variations.
 
* Wikipedia provide [[w:Wikipedia:WikiProject Transwiki/Template:Navbox]] for other wikis to freely use under the [[w:Wikipedia:CC BY-SA|CC BY-SA]] licenseIt looks like our existing Navbox may have been based on a version of this, '''in breach of the Wikipedia license''' (it is not attributed to them, there's no attribution provided at all).
 
  
=== Goals ===
+
== TODO ==
* Work towards a "one true navbox" template which covers all of our major cases and covers them convincingly well.
+
Some things I want to remember to do:
* Replace existing navbox template with an uncollapsed version that will be maintainable (with care, it's still going to be complex).
 
* Comply with Wikipedia's license.
 
  
=== Use cases ===
+
* Convert {{tl|Hidden}} to mw-collapsible
 +
* Add "nonumtoc" to {{tl|TOC}} for things like [[Version history]]
  
'''N.B. The CSS used by my test template is not currently on the site, it's being loaded locally for me only.  The test boxes will not be correctly formatted for anyone else.'''
+
== Importing templates ==
  
<!-- Usage:
+
I've imported quite a large number of Wikipedia utility templates.  My rationale is that a rich availability of good quality utility templates can really help a wiki.  People familiar with editing on Wikipedia and other WMF wikis should now find our site much more pleasant to work with, since their familiar tools are more readily to hand.  It's about trying to make life easier for editors, and trying to make our wiki as good as it possibly can be.  A great many of the templates that I have imported are to support {{tl|Documentation}}, and things like a comprehensive set of the special 1, 2, and 3 special character templates for working with template parameters and tables.  It should also now be considerably easier to import miscellaneous WMF templates as and when people need them, as the core support and utility templates that they rely on are much more complete.
  
{{Navbox
+
== [[Template:Documentation]] ==
| name      = {{subst:PAGENAME}}{{subst:void|Don't change anything on this line. It will change itself when you save.}}
 
| title      =
 
| listclass  = hlist
 
| state      = {{{state|}}}
 
  
| above      =
+
''See [[{{TALKPAGENAME}}#Template:Documentation]].''
| image      =
 
  
| group1    =
+
== [[/Template:Infobox]] ==
| list1      =
 
  
| group2    =
+
Having pretty much got {{tl|Navbox}} well under control, I'm also going to take a look at {{tl|Infobox}} as well. I'm not sure if it really needs any serious attention or not, but I do want to at least evaluate our existing infobox templates against the final pre-Lua Wikipedia ones, to see if there's any benefit for us.
| list2      =
 
  ...
 
| group20    =
 
| list20    =
 
  
| below      =
+
'''Status:''' No obvious immediate easy benefits from WP version.  Replacing our version with the WP one as the core would be a lot of work.  Still evaluating both of them, but no plans to do much with WP's version right now.  Back burner, pretty much.
}}
 
  
-->
+
== [[/Template:Navbar]] ==
  
==== Simple short test with missing group ====
+
'''Status:''' Done. (But awaiting CSS update which needs administrator rights.)
{{/Template:Navbox
 
| name  = Murph
 
| state  = uncollapsed
 
| title  = {{{title}}}
 
| above  = {{{above}}}
 
| image  = {{{image}}}
 
| group1 = {{{group1}}}
 
| list1  = {{{list1}}}
 
| group2 = {{{group2}}}
 
| list2  = {{{list2}}}
 
| list3  = {{{list3}}} ''without {{{group3}}}''
 
| group4 = {{{group4}}}
 
| list4  = {{{list4}}}
 
| below = {{{below}}}
 
}}
 
  
==== Simple 20 group test ====
+
Support template for various things.  Generates the {{/Template:Navbar|User:Murph|mini=1}} links on boxes and so on.
 +
I have successfully updated our main {{tl|navbar}} to the final non-[[w:Wikipedia:Lua|Lua]] version from the English Wikipedia.  It looks like that is the "final" version that will ever be available from WMF for non-Lua wikis.  It's actually a fairly simple template overall but our previous version was an unmaintainable collapsed solid blob of code, and had some questionable features added to it for the free wiki site it was scraped off.  It was also being used in breach of the [[Project:CC BY-SA|CC BY-SA]] license, as there was zero attribution for it, as required by the license (despite the horrible code formatting, it was clearly originally from WP).
  
{{/Template:Navbox
+
== [[/Template:Navbox]] ==
| name = Murph
 
| title = {{{title}}}
 
| state  = uncollapsed
 
| title  = {{{title}}}
 
| above  = {{{above}}}
 
| image  = {{{image}}}
 
| group1 = {{{group1}}}
 
| list1  = {{{list1}}}
 
| group2 = {{{group2}}}
 
| list2  = {{{list2}}}
 
| group3 = {{{group3}}}
 
| list3  = {{{list3}}}
 
| group4 = {{{group4}}}
 
| list4  = {{{list4}}}
 
| group5 = {{{group5}}}
 
| list5  = {{{list5}}}
 
| group6 = {{{group6}}}
 
| list6  = {{{list6}}}
 
| group7 = {{{group7}}}
 
| list7  = {{{list7}}}
 
| group8 = {{{group8}}}
 
| list8  = {{{list8}}}
 
| group9 = {{{group9}}}
 
| list9  = {{{list9}}}
 
| group10 = {{{group10}}}
 
| list10  = {{{list10}}}
 
| group11 = {{{group11}}}
 
| list11  = {{{list11}}}
 
| group12 = {{{group12}}}
 
| list12  = {{{list12}}}
 
| group13 = {{{group13}}}
 
| list13  = {{{list13}}}
 
| group14 = {{{group14}}}
 
| list14  = {{{list14}}}
 
| group15 = {{{group15}}}
 
| list15  = {{{list15}}}
 
| group16 = {{{group16}}}
 
| list16  = {{{list16}}}
 
| group17 = {{{group17}}}
 
| list17  = {{{list17}}}
 
| group18 = {{{group18}}}
 
| list18  = {{{list18}}}
 
| group19 = {{{group19}}}
 
| list19  = {{{list19}}}
 
| group20 = {{{group20}}}
 
| list20  = {{{list20}}}
 
| below  = {{{below}}}
 
}}
 
  
==== [[Template:Versions]] ====
+
'''Status:''' Template framework done other than small tweaking as needed.  CSS update awaiting administrator.  {{tl|Demo parts}}, {{tl|Parts}}, {{tl|Stock craft}}, and {{tl|Versions}} using it via inline style attributes as an imperfect and inefficient hack (acceptable in the short term with good visual result, but quite undesirable in the long term).
  
===== Current production version =====
+
=== Things I'd like to improve ===
{{Versions}}
 
  
===== Test version =====
+
* {{Strikethrough|The current {{Tl|Navbox}} template is a horribly dense block of wiki script code.  It carries a warning not to edit it due to the complexity, which is quite justified, but the complexity is made far worse by it being collapsed into a single block of impossible to maintain code (I rate it as impossible for anyone to reliably maintain, even seasoned MediaWiki experts).}}  ''Done.''
{{/Template:Navbox
+
* We're using raw {{Tl|FlipBox}} templates as navboxes, with each instance containing its own style information and variances. This makes it harder to maintain a consistent visual result across the wiki, as well as duplicating maintenance effort and potential errors/variations. ''Good progress, have replacements for all once the CSS is updated (working on the precise details of what the update should be).''
|state=<noinclude>uncollapsed</noinclude><includeonly>{{{state|collapsed}}}</includeonly>
+
* Wikipedia provide [[w:Wikipedia:WikiProject Transwiki/Template:Navbox]] for other wikis to freely use under the [[Project:CC BY-SA|CC BY-SA]] license. It looks like our existing Navbox may have been based on a version of this, '''in breach of the Wikipedia license''' (it is not attributed to them, there's no attribution provided at all). ''Mostly compliant now, full compliance in sight soon.''
|title= {{if lang link|Version history|en=''Kerbal Space Program versions''|ru=''версии KSP''|fr=''Versions de Kerbal Space Program''|ja=''Kerbal Space Program'' のバージョン|ko=''커발 스페이스 프로그램의 버전''}}
 
|name=Versions
 
|image=
 
|above=
 
|titlestyle = background:#DDD;
 
|groupstyle = background: #EEE; font-weight: bold; width:50px; text-align: center;
 
|liststyle = background: #DDD;
 
|belowstyle = background: #EEE; text-align: center;
 
|group1    = {{lang|en=''Upcoming''|ru=''Предстоящие''|ja={{Nowrap|''更新予定''}}|fr=''À venir''|ko={{Nowrap|''예정''}}}}
 
|list1      = {{if lang link|Planned features|ru=планируемые новшества|fr=Fonctionnalités prévues|ko=개발 예정인 항목}}
 
|group2    = {{lang|en=''Official release''|fr=''Versions officielles''|ko=''정식''}}
 
|list2      = {{if lang link|1.0.2}} {{!}} {{if lang link|1.0.1}} {{!}} {{if lang link|1.0}}
 
|group3    = {{lang|en=''Beta''|fr=''Bêta''|ja=ベータ|ko=''베타''}}
 
|list3      = {{if lang link|0.90.0}}
 
|group4    = {{lang|en=''Alpha''|ja=アルファ|ko=''알파''}}
 
|list4      = {{if lang link|0.25}} {{!}} {{if lang link|0.24.2}} {{!}} {{if lang link|0.24.1}} {{!}} {{if lang link|0.24}} {{!}} {{if lang link|0.23.5}} {{!}} {{if lang link|0.23}} {{pipe}} {{if lang link|0.22}} {{pipe}} {{if lang link|0.21.1}} {{pipe}} {{if lang link|0.21}} {{pipe}} {{if lang link|0.20.2}} {{pipe}} {{if lang link|0.20.1}} {{pipe}} {{if lang link|0.20}} {{pipe}} {{if lang link|0.19.1}} {{pipe}} {{if lang link|0.19}} {{pipe}} {{if lang link|0.18.4}} {{pipe}} {{if lang link|0.18.2}} {{pipe}} {{if lang link|0.18.1}} {{pipe}} {{if lang link|0.18}} {{pipe}} {{if lang link|0.17.1}} {{pipe}} {{if lang link|0.17}} {{pipe}} {{if lang link|0.16}} {{pipe}} {{if lang link|0.15.2}} {{pipe}} {{if lang link|0.15.1}} {{pipe}} {{if lang link|0.15}} {{pipe}} {{if lang link|0.14.4}} {{pipe}} {{if lang link|0.14.3}} {{pipe}} {{if lang link|0.14.2}} {{pipe}} {{if lang link|0.14.1}} {{pipe}} {{if lang link|0.14}} {{pipe}} {{if lang link|0.13.2}} {{pipe}} {{if lang link|0.13.1}} {{pipe}} {{if lang link|0.13}} {{pipe}} {{if lang link|0.12}} {{pipe}} {{if lang link|0.11.1}} {{pipe}} {{if lang link|0.11}} {{pipe}} {{if lang link|0.10.1}} {{pipe}} {{if lang link|0.10}} {{pipe}} {{if lang link|0.9}} {{pipe}} {{if lang link|0.8.5}} {{pipe}} {{if lang link|0.8.4}} {{pipe}} {{if lang link|0.8.3}} {{pipe}} {{if lang link|0.8.2}} {{pipe}} {{if lang link|0.8.1}} {{pipe}} {{if lang link|0.8}} {{pipe}} {{if lang link|0.7.3}} {{pipe}}
 
{{if lang link|Version history|de=Versionsgeschichte|ru=История версий|fr=Historique des Versions|ja=バージョン履歴|ko=개발 연혁}}
 
|group5    = {{lang|en=''Demo''|fr=''Démo''|ja=デモ|ko={{Nowrap|''체험판''}}}}
 
|list5      = {{if lang link|0.18.3}} {{pipe}} [[0.13.3|0.13.3 ({{Dict|old}})]]
 
}}
 
  
==== [[Template:Stock craft]] ====
+
=== Goals ===
===== Current production version =====
 
{{Stock craft}}
 
  
===== Test version =====
+
* Work towards a "one true navbox" template which covers all of our major cases and covers them convincingly well.
{{/Template:Navbox
+
* Replace existing navbox template with an uncollapsed version that will be maintainable (with care, it's still going to be complex).
| name = Stock craft
+
* Comply with Wikipedia's license.
| title = [[Stock craft]]
 
| listclass = hlist
 
| state = {{{state|}}}
 
  
| group1= {{if lang link|Rocket|en=Rockets|hu=Rakéták|ru=Ракеты}}
+
=== Status ===
| list1 =
 
* {{if lang link|Ion-Powered Space Probe}}
 
* {{if lang link|Kerbal 2}}
 
* {{if lang link|Kerbal X}}
 
* {{if lang link|Learstar A1}}
 
* {{if lang link|Orbiter 1A}}
 
* {{if lang link|Rover + Skycrane}}
 
* {{if lang link|Space Station Core}}
 
* {{if lang link|Super-Heavy Lander}}
 
* {{if lang link|Two-Stage Lander}}
 
* {{if lang link|Z-MAP Satellite Launch Kit}}
 
  
| group2 = {{if lang link|Plane|en=Planes|hu=Repülőgépek|ru=Самолёты}}
+
Our out of date, unmaintainable, and copyright infringing {{tl|Navbox}} has now been replaced with the final non-[[w:Wikipedia:Lua|Lua]] version from the English Wikipedia.  It now has attribution, so it is no longer being used in breach of the [[Project:CC BY-SA|CC BY-SA]] license (everything I have imported states the source is Wikipedia and that it's CC BY-SA, although I now realise that full compliance should really involve a notice within the docs, which I'm gradually correcting).  Although I need to clean up the compliance a little more, I'm confident that we're no longer in full breach of the license, and would not have any serious problems if a WMF lawyer were to look at the site, as there's at least some attribution in the edit history for everything I have touched and the remainder is being fixed reasonably quickly.
| list2 =
 
* {{if lang link|Aeris 3A}}
 
* {{if lang link|Aeris 4A}}
 
* {{if lang link|Albatross 3}}
 
* {{if lang link|Ravenspear Mk1}}
 
* {{if lang link|Ravenspear Mk3}}
 
* {{if lang link|Ravenspear Mk4}}
 
* {{if lang link|Rocket-power VTOL}}
 
* {{if lang link|Stearwing A300}}
 
* {{if lang link|Stearwing D45}}
 
}}
 
  
==== [[Template:Parts]] ====
+
It looks to be working very nicely when the CSS is there for it, and I'm working on the details for that.  We're at least 90% of the way to having full feature navboxes with pretty much all the functionality you'll find on WP.
===== Current production version =====
 
{{Parts}}
 
  
===== Test version =====
+
=== Test cases ===
{{/Template:Navbox
 
| name = Parts
 
| title = [[Parts]]
 
| state = {{{state|}}}
 
| list1 = {{/Template:Navbox|child
 
| navbar = plain
 
| title = Group 1
 
| listclass = hlist
 
| group1 = Subgroup 1
 
| list1 =
 
* Subgroup 1 part 1
 
* Subgroup 1 part 2
 
| group2 = Subgroup 2
 
| list2 =
 
* Subgroup 2 part 1
 
* Subgroup 2 part 2
 
}}
 
| list2 = {{/Template:Navbox|child
 
| navbar = plain
 
| title = Group 2
 
| listclass = hlist
 
| group1 = Subgroup 1
 
| list1 =
 
* Subgroup 1 part 1
 
* Subgroup 1 part 2
 
| group2 = Subgroup 2
 
| list2 =
 
* Subgroup 2 part 1
 
* Subgroup 2 part 2
 
}}
 
}}
 
  
== [[/Template:Navbar]] ==
+
{{Box|type=notice|The CSS used by most of my test cases is not currently on the site, it's being loaded locally for me only.  The test cases will not be correctly formatted for anyone else.}}
Support template for Template:Navbox
+
 
 +
:''See [[Template:Navbox/testcases]].''

Latest revision as of 13:45, 11 June 2015

Template:User en

I'm just using this page as a mixture of my personal sandbox, and a place to publish some of my thoughts about things I'm doing on the wiki. Please do not edit this page or any of its subpages without my express permission (unless you are an official wiki admin, of course, and it's actually causing any problems).

Warning: Those who do not know anything about the deeper details of the MediaWiki parser or templates may wish to stop reading now. I do not accept any responsibility for mental damage caused by reading about things like that.  ;-)

TODO

Some things I want to remember to do:

Importing templates

I've imported quite a large number of Wikipedia utility templates. My rationale is that a rich availability of good quality utility templates can really help a wiki. People familiar with editing on Wikipedia and other WMF wikis should now find our site much more pleasant to work with, since their familiar tools are more readily to hand. It's about trying to make life easier for editors, and trying to make our wiki as good as it possibly can be. A great many of the templates that I have imported are to support {{Documentation}}, and things like a comprehensive set of the special 1, 2, and 3 special character templates for working with template parameters and tables. It should also now be considerably easier to import miscellaneous WMF templates as and when people need them, as the core support and utility templates that they rely on are much more complete.

Template:Documentation

See User talk:Murph#Template:Documentation.

/Template:Infobox

Having pretty much got {{Navbox}} well under control, I'm also going to take a look at {{Infobox}} as well. I'm not sure if it really needs any serious attention or not, but I do want to at least evaluate our existing infobox templates against the final pre-Lua Wikipedia ones, to see if there's any benefit for us.

Status: No obvious immediate easy benefits from WP version. Replacing our version with the WP one as the core would be a lot of work. Still evaluating both of them, but no plans to do much with WP's version right now. Back burner, pretty much.

/Template:Navbar

Status: Done. (But awaiting CSS update which needs administrator rights.)

Support template for various things. Generates the v · d · e links on boxes and so on. I have successfully updated our main {{navbar}} to the final non-Lua version from the English Wikipedia. It looks like that is the "final" version that will ever be available from WMF for non-Lua wikis. It's actually a fairly simple template overall but our previous version was an unmaintainable collapsed solid blob of code, and had some questionable features added to it for the free wiki site it was scraped off. It was also being used in breach of the CC BY-SA license, as there was zero attribution for it, as required by the license (despite the horrible code formatting, it was clearly originally from WP).

/Template:Navbox

Status: Template framework done other than small tweaking as needed. CSS update awaiting administrator. {{Demo parts}}, {{Parts}}, {{Stock craft}}, and {{Versions}} using it via inline style attributes as an imperfect and inefficient hack (acceptable in the short term with good visual result, but quite undesirable in the long term).

Things I'd like to improve

  • The current {{Navbox}} template is a horribly dense block of wiki script code. It carries a warning not to edit it due to the complexity, which is quite justified, but the complexity is made far worse by it being collapsed into a single block of impossible to maintain code (I rate it as impossible for anyone to reliably maintain, even seasoned MediaWiki experts). Done.
  • We're using raw {{FlipBox}} templates as navboxes, with each instance containing its own style information and variances. This makes it harder to maintain a consistent visual result across the wiki, as well as duplicating maintenance effort and potential errors/variations. Good progress, have replacements for all once the CSS is updated (working on the precise details of what the update should be).
  • Wikipedia provide w:Wikipedia:WikiProject Transwiki/Template:Navbox for other wikis to freely use under the CC BY-SA license. It looks like our existing Navbox may have been based on a version of this, in breach of the Wikipedia license (it is not attributed to them, there's no attribution provided at all). Mostly compliant now, full compliance in sight soon.

Goals

  • Work towards a "one true navbox" template which covers all of our major cases and covers them convincingly well.
  • Replace existing navbox template with an uncollapsed version that will be maintainable (with care, it's still going to be complex).
  • Comply with Wikipedia's license.

Status

Our out of date, unmaintainable, and copyright infringing {{Navbox}} has now been replaced with the final non-Lua version from the English Wikipedia. It now has attribution, so it is no longer being used in breach of the CC BY-SA license (everything I have imported states the source is Wikipedia and that it's CC BY-SA, although I now realise that full compliance should really involve a notice within the docs, which I'm gradually correcting). Although I need to clean up the compliance a little more, I'm confident that we're no longer in full breach of the license, and would not have any serious problems if a WMF lawyer were to look at the site, as there's at least some attribution in the edit history for everything I have touched and the remainder is being fixed reasonably quickly.

It looks to be working very nicely when the CSS is there for it, and I'm working on the details for that. We're at least 90% of the way to having full feature navboxes with pretty much all the functionality you'll find on WP.

Test cases

The CSS used by most of my test cases is not currently on the site, it's being loaded locally for me only. The test cases will not be correctly formatted for anyone else.
See Template:Navbox/testcases.