Well, I created this page: http://wiki.alioth.net/index.php/Index_of_artefactsCholmondely wrote: ↑Sun May 09, 2021 9:09 pmHappy to give it a stab! If it works, superb! If not, we'll just to have to come up with another approach!
Righty-ho!hiran wrote: ↑Mon May 10, 2021 8:11 pmWell, I created this page: http://wiki.alioth.net/index.php/Index_of_artefactsCholmondely wrote: ↑Sun May 09, 2021 9:09 pmHappy to give it a stab! If it works, superb! If not, we'll just to have to come up with another approach!
It contains nothing useful, just consists of links to other pages. From a few steps away you can see the documentation coverage just by rating red vs blue colour.
The list is all the names of OXPs, Ships and Equipment as they come with expansions registered in the Expansion Manager.Cholmondely wrote: ↑Mon May 10, 2021 9:26 pmRighty-ho!hiran wrote: ↑Mon May 10, 2021 8:11 pmWell, I created this page: http://wiki.alioth.net/index.php/Index_of_artefactsCholmondely wrote: ↑Sun May 09, 2021 9:09 pmHappy to give it a stab! If it works, superb! If not, we'll just to have to come up with another approach!
It contains nothing useful, just consists of links to other pages. From a few steps away you can see the documentation coverage just by rating red vs blue colour.
What do we do next, old boy? Do we want to create links/pages for everything on your list? Or what?
What actually is your list?
I think that renaming pages is not the best way to go about things, (it gives poor old Maik a major attack of the galloping heeby-jeebies for some reason that undoubtedly makes a lot of sense) if we can avoid it.hiran wrote: ↑Tue May 11, 2021 9:24 amThe list is all the names of OXPs, Ships and Equipment as they come with expansions registered in the Expansion Manager.
So potentially users will install these items and want to know more about them. (at least I do)
As we already assumed, some of the pages already exist. That is good, there is no need to create them at all.
Some other pages seem to be missing. Over time it makes sense to create meaningful content.
More of a challenge is if pages exist under different names. You ask what should be done, and I believe there are options we can choose from:
- we can rename the existing pages. This may make sense where a single page contains the necessary knowledge.
Renaming or adding forewords would standardize that information on any item can be found under a page with the item name. That would make it a lot easier for users to find the right content.
- we can create a 'foreword' page that links to the other existing page(s). This would make sense either because there are multiple good pages already or we hesitate to rename the original user's page.
I just pointed out a way to ensure we have documentation for all the artefacts. It allows a structured approach, maybe even distributing the topics over multiple forum members. The more exceptions you defend the more error prone the process becomes.Cholmondely wrote: ↑Tue May 11, 2021 12:32 pmI would further argue that "Cargo Scoop as Standard" does not need a wiki page. And that what there is for "Reverse Y Control" suffices.
That leaves MFD - CommsLog, Rescue Stations, Assassins Guild & Heavy Metal Freight Hauler needing redirects.
Do you agree? What do you suggest? What would you like to do?
If we just start working through the OXZ names and leave Griff and other problematics for last? Then we can "pm" Griff and decide with him how to tackle things.
And if you dig up any unlinked pieces of equipment let me know!
I'm not too sure what an artefact is!hiran wrote: ↑Tue May 11, 2021 7:04 pmI just pointed out a way to ensure we have documentation for all the artefacts. It allows a structured approach, maybe even distributing the topics over multiple forum members. The more exceptions you defend the more error prone the process becomes.Cholmondely wrote: ↑Tue May 11, 2021 12:32 pmI would further argue that "Cargo Scoop as Standard" does not need a wiki page. And that what there is for "Reverse Y Control" suffices.
That leaves MFD - CommsLog, Rescue Stations, Assassins Guild & Heavy Metal Freight Hauler needing redirects.
Do you agree? What do you suggest? What would you like to do?
If we just start working through the OXZ names and leave Griff and other problematics for last? Then we can "pm" Griff and decide with him how to tackle things.
And if you dig up any unlinked pieces of equipment let me know!
I'm afraid I am novice enough that I cannot contribute meaningful content for the pages, so that leaves the 'work' to you and more experienced commanders, maybe even the OXP authors.
I do enough of mastery of the dark arts so your litmus test is already implemented.Cholmondely wrote: ↑Tue May 11, 2021 7:19 pmI suppose that my litmus test is based around typing the entry into the wiki search box. If the relevant entry comes up as a suggestion - and is recognisable - then there is no need for a new page (redirect or otherwise).
1) Litmus test: Aaah ... that's not quite what I meant, I'm afraid. Although your implementation is very useful (but see below...).hiran wrote: ↑Tue May 11, 2021 7:27 pmI do enough of mastery of the dark arts so your litmus test is already implemented.Cholmondely wrote: ↑Tue May 11, 2021 7:19 pmI suppose that my litmus test is based around typing the entry into the wiki search box. If the relevant entry comes up as a suggestion - and is recognisable - then there is no need for a new page (redirect or otherwise).
Have a look at https://app.box.com/s/s66ozjm3wzotuyeexxer38qgge8p3tzq
The index.html page does not just list all the artefacts (OXPs, equipment and ships), it also comments them with either the word "Wiki" or "Missing".
Wiki is a link to the found wiki page (and this 'found' refers to the result of the wiki search box). If no good result is returned the word "Missing" is displayed.
You may as well take it from there, although that solution does not allow the charm of the wiki page management functions to be used. And someone (currently me) would have to run the indexing regularly.
I get the point. While something like that could be implemented, it would not deliver semantically correct data. Anything potentially can flash up while typing text, and an automatic tool would not be able to guess it is the desired page. Doing that could make us feel safe and comfortable while we are actually not.Cholmondely wrote: ↑Sun May 16, 2021 10:10 am1) Litmus test: Aaah ... that's not quite what I meant, I'm afraid. Although your implementation is very useful (but see below...).
[...]
In each case, if one cuts and pastes there is no link. But if one types in the words and watches the little box ...
That might be an interesting one. Do we expect the wiki index and the html index to be exactly the same? I believe the glitch comes from different matching algorithms which is ok in rare cases.Cholmondely wrote: ↑Sun May 16, 2021 10:10 am2) While Gatling Gun (the OXP) has a wiki page and is shown as having such on your wiki Index of artefacts page, the page in the outputdir3 says no wiki! One presumes it is a minor glitch of some sort.
Sounds ok for me. If you can handle that amount of traffic I am fine with that.Cholmondely wrote: ↑Sun May 16, 2021 10:10 am3) I've been using your new wiki page to decide what to mangle as it updates itself. Again, very helpful, thank you!
4) I would hope that regular indexing would be unnecessary. Once the wiki is up to date, and we know the date that it is was up to date, it is then a simple matter of checking the new additions to the Expansions Manager list on the http://www.oolite.org/ website, and adding in new equipment and OXZ's every once in a while as needed.
There have been 26 OXZ releases/updates since 1st January. Only 5 were not entered/updated on the wiki by their authors. I don't think that that is too serious a problem!
Maybe we can define different areas:andrax_iON wrote: ↑Mon May 17, 2021 7:10 amMr. C : re yr question on suggestions for the wiki, the only thing that strikes me is that there's no easy channel to development-related pages; things like the JavaScript reference page spring to mind, but I suspect there are other key pages that might be made more accessible/available from a 'landing' page, linked from the main wiki page.
Is some of hiran's work maybe a way to collect/collate dev-specific info?
cheers
That's a part of my concern - as a very recent visitor to Oolite from the uncharted backwaters of the unfashionable end of the western spiral arm of the Galaxy, I'm not sure.
I am not sure of the connection but may as well have a blind spot.andrax_iON wrote: ↑Mon May 17, 2021 9:50 pmI think your reasoning re potential categories (above) is good, but I've no idea if/what existing content might meet those descriptions; I was wondering if some of the work you've done to date might help with this.
Good catch! That is a topic suitable both for Oolite core and OXP development. So we need to allow single topics to be visible/reachable from several areas. And the areas resemble use cases.andrax_iON wrote: ↑Mon May 17, 2021 9:50 pmThings like the Oolite object model (which has a neatly circular reference at http://wiki.alioth.net/index.php/Catego ... _Reference), event handlers, property lists.. the info's there, but navigation can be challenging.