Suggestions for the Wiki regarding Factorio Expansion Add-ons

[Bilka]

How will the new 2.0 items and technologies find their way into the wiki?

Infoboxes and icons are already largely automated, so it's only a matter of updating that for 2.0, which I plan to do this and next week.

For locale, I generally do not recommend to blindly copy to Template:Translation from the locale file, since you may end up with a lot that's never used on the wiki.

[Bilka]

A progress update: I have created two templates, Template:SA to mark links as Space Age exclusive and Template:About/Space_age for whole pages and sections. These are quite barebones for now, if you have ideas for how to make them fancier please edit them.

Related to that, someone already started making some pages for Fulgora's items, thank you! I went through some of them and added the templates as an example for how I envision their use, see e.g. https://wiki.factorio.com/Electromagnetic_science_pack. It would be great to see feedback on that, or changes and so on, so we can establish a system as a community before the 21st. As the text below the wiki page edit box says, please "edit mercilessly". I don't want dictate a particularly style, I want this to serve as a starting point to improve upon.

[Tertius]

Nice. The Template:SA looks nice and clean.

The "About" template however appears kind of wooden and convoluted. Do we really need a whole sentence to explain, including the word "paid" on every Space Age item?
Imagine this sentence will appear on 30% of all items:
"This article is about a feature exclusive to the paid Space Age expansion."
With the same reasoning, we could add a section to all items to differ between items, technologies, game concepts, etc.
"This article is about an item in Factorio, a factory building game available from Steam, GoG and WUBE:"
All this ist just cluttering the articles, in my opinion.

How about just a slightly larger Space Age icon, added at the end of the title of the article, to mark an article Space Age related? The picture says it all. If it is paid or not can be seen by clicking on the icon and reading the Space Age article. Additionally I propose to add the small icon in the infobox after the item name, since often you directly look at the infobox instead of reading the whole article from top to bottom.

[GoatWizard]

Template:About/Space_age. These are quite barebones for now, if you have ideas for how to make them fancier please edit them.

1. One suggestion is to have the icon before the sentence and make to it a little larger. Two examples from eu4 wiki:
Article example: https://eu4.paradoxwikis.com/March
Section example: https://eu4.paradoxwikis.com/Land_warfare#Sortie

2. Another suggestion is to reword the sentence so that "Space Age" is closer to the beginning of the sentence, since "Space Age" is the important information.
Examples:
-"Space Age{SA} expansion exclusive feature."
-"The Space Age{SA} expansion is required for this feature..."
-"Exclusive to the Space Age{SA} expansion."
-"Need Space Age{SA} enabled for this feature."
-"Available only with the Space Age{SA} expansion enabled."

[Bilka]

Text shortened, thanks for the suggestions. I think it's good to keep some text so that it's clear what the icon means, at least while the expansion is new.

[Bilka]

Checking back in here with a summary of the current state of the templates.

Templates for space age pages/sections/links: https://wiki.factorio.com/Template:Space_age (Used via {{SA}}) and https://wiki.factorio.com/Template:About/Space_age.

The new item and recipe icons are already uploaded/updated. The tech icons will come with expansion release (scripted).

I will use a script to update the data for the vanilla infoboxes (2.0 without space age) upon expansion release, this script is already done and tested.

I am working on a script to move and archive pages related to various vanilla item/tech renames and removals, this should be simple and I expect to get it done until release and will run it with release.

The infobox template code is not yet updated to handle space age recipe/tech variants or quality. This is my next task after the vanilla page moves/archiving. Space age related infobox data will only be automated later, there are still some technical issue to figure out first. (For example, right now the data would show that you need the recycling technology for concrete, which is obviously wrong.)


Discussion points that were brought up on talk pages, looking for input:
How to handle the enemies page? https://wiki.factorio.com/Talk:Enemies#Update_to_2.0
Template:Inventory or a new Template:Factoriopedia? https://wiki.factorio.com/User_talk:Bil ... _templates

[Bilka]

The tech icons will come with expansion release (scripted).

I will use a script to update the data for the vanilla infoboxes (2.0 without space age) upon expansion release.

I am working on a script to move and archive pages related to various vanilla item/tech renames and removals, this should be simple and I expect to get it done until release and will run it with release.

All done. This means all expected script runs are completed for now. Now come manual page updates and for me the work on the infobox template to get space age support.

Let me know if any of the mentioned things look broken.

[Bilka]

The infobox template now supports different recipes, technology costs and recipe tree/tech tree related properties for base game vs space age. This is documented on https://wiki.factorio.com/Template:Infobox but a summary:

• If an object is only available in space age (e.g. Electromagnetic plant) set space-age=yes and use the normal properties for everything (recipe etc)
• If an object is always available, but partially altered by the space age mod (e.g. Rocket silo research) set changed-by-space-age-mod=yes and use space-age-cost and cost and so on to separate vanilla and space age mod.
• If an object is not available in space age (Satellite) set space-age=no and use the normal properties for everything (recipe etc)
• If an object is always available but not altered by the space age mod, set nothing. Set appropriate space age properties directly (e.g. recyling results).

As noted in the previous post, I'm still looking into automating getting the space age data into the infoboxes.

[shopt]

So should we hold off on manual infobox fixes for now? I just made one to PLD, but if it's going to be automated I'll not bother with more.

Also, is there some way we are tracking which pages have been updated (or looked at and decided no updates needed) for 2.0?

[Bilka]

So should we hold off on manual infobox fixes for now? I just made one to PLD, but if it's going to be automated I'll not bother with more.

The automation can handle the following infobox fields:

• internal-name, prototype-type (general)
• health, mining-time, map-color, pollution, resistance (entities, tiles)
• cost-multiplier, cost, allows, effects, required-technologies, internal-name, category (technologies)
• consumers, required-technologies (items)
• recipe, total-raw, producers (recipes)

That's what I automatically updated for 2.0 vanilla on release day.

I'm looking into adding support for space age variants of:

• cost-multiplier, cost, allows, effects, required-technologies (technologies)
• consumers, required-technologies (items)
• recipe, total-raw (recipes)

I already prepared spoil time and am hoping to automate research triggers, spoil result, space age exclusivity, changed-by-space-age-mod and possibly rocket capacity.

So, your manual addition for PLD needed to be manually done anyway and you didn't waste any work.

Currently my number 1 priority is to get the templates themselves on the wiki into a state where people data can be input, whether it's manually or automatically. Infoboxes are still missing various rows (e.g. rocket capacity and spoil result) and support for showing quality variants and there are other templates on the wiki that also need me to update them.

Only after that will I return to automating the data input. The data input can theoretically be done by other people when I'm unavailable, so it's less important for now, even though I'd love to have it automated as quickly as possible. I will unavailable for some days next week and I can't tell yet whether I will get to this automation before then.

Also, is there some way we are tracking which pages have been updated (or looked at and decided no updates needed) for 2.0?

No. Previously I've found that there was no way to track this that didn't add tons of overhead. I would recommend to look at the Stub category for new pages needing more info, the wanted pages for missing pages and otherwise just update what you come across.

[untitled7]

Throwing my thoughts into the ring without having read the entire thread.
I don't necessarily think items that are unchanged except for quality and consumers. Maybe don't really need an extra tab?

Quality:
I have so far not seen anyone suggest a tooltip, like the game offers. Marking a value with a diamond and on hover summons the tooltip that shows the info.
The battle here is only the one against the wikitext parser (and web accessibility guidelines), but I've written something much more complicated for the Oxygen Not Included Wiki myself

Consumers:
I looked over the lua and think I know where you would put in whether or not to display space age on the icon
in the Infobox Module
where the _vrow_item() is called for "Consumed by" Line 235: the args could be expanded by a boolean to show the mod icon
in Line 275: the _vrow() call, that boolean needs to be passed to the arg of parsing._item(frame, arg)

then in Infobox/parsing Line 31
this now needs to differentiate if it only got a string as argument or a list (with a string and bool)
regular behaviour if only a string
with the bool, within the loop it would compare the individual strings to a blacklist/whitelist and call the template expansion of icon/special accordingly.

I [...] am hoping to automate [...] space age exclusivity

I'm assuming those blacklist/whitelist items are not easily generated?

A progress update: I have created [...] templates, Template:SA

ngl, File:Space_age_icon.png and File:No_space_age_icon.png have poor readability
On the Satelite page for example, to the topright of the Satelite image, if you don't already know what it is, you wouldn't gain any info from it.
I recommend at least adding a hover text to the image that spells out what it means, maybe even a proper tooltip with a larger version of the icon

(Subpoint: Save the state of these tabs sitewide)

If you're still looking, saving that preferences is quite easy via javascript, there's mediawiki functionality for that, but if the user is not logged in, a fallback would be local browser storage

Code: Select all

// load
var spaceAgeUsed = mw.user.options.get('factorio--uses-spaceage');
if (typeof spaceAgeUsed !== 'boolean')
    spaceAgeUsed = (localStorage.getItem('factorio--uses-spaceage') === "true");

// store
mw.user.options.set('factorio--uses-spaceage', spaceAgeUsed);
localStorage.setItem('factorio--uses-spaceage', spaceAgeUsed.toString());

and entirely unrelated to what I just said: the Atlyss wiki has a custom double-tabber Infobox to show of armour from front/back and for different dye-jobs, example: Leather Cap on the Atlyss wiki

[untitled7]

Quality:
I have so far not seen anyone suggest a tooltip, like the game offers. Marking a value with a diamond and on hover summons the tooltip that shows the info.
The battle here is only the one against the wikitext parser (and web accessibility guidelines), but I've written something much more complicated for the Oxygen Not Included Wiki myself

Quickly rewritten that tooltip and got it to work:


but I'm not allowed to make even my personal common.js on the wiki

[Wrincewind]

A tool tip would be handy, but I worry that it'd harm accessibility and usability for people with screen readers, people on mobile, people with scripts disabled, etc. I think the same info presented as a collapsed table would be easier for accessibility, and wouldn't require any custom JS.

[shopt]

Honestly I would prefer to see all 5 numbers at once, just separated by slashes, rather than the tooltip style used in-game. Accessibility is yet another reason I think we shouldn't go down this path.

[untitled7]

A tool tip would be handy, but I worry that it'd harm accessibility and usability for people with screen readers, people on mobile, people with scripts disabled, etc. I think the same info presented as a collapsed table would be easier for accessibility, and wouldn't require any custom JS.

correct, I already pointed out the accessibility issues as I suggested it. I just wrote it because I had the time to paint a better picture of what I said.
as far as screen readers are concerned: my solution adds the quality information after pageload is finished (it changes the DOM, so I have to wait until it's finished building before applying anything), so if you load the page and then switch to reader mode, the info would be there. But not if the page is already loaded in reader mode (or print view), it wouldn't show up

a collapsible table would require custom js, if we want to make it pretty and fit well in the already existing infobox. Writing the functionality takes maybe 10 minutes. Making it pretty and fit in well is a different task.

Honestly I would prefer to see all 5 numbers at once, just separated by slashes, rather than the tooltip style used in-game. Accessibility is yet another reason I think we shouldn't go down this path.

One issue with the slashes is the unit of the inserters which are given in °/s, so they already have slashes inside of them. Now of course you can also have the numbers without units and the unit at the end but it still looks a bit weird...
80/120/160/240/300 °/s
or other uses of the slash in something like "Resistances: Fire: 0/90%"

[Bilka]

Throwing my thoughts into the ring without having read the entire thread.
I don't necessarily think items that are unchanged except for quality and consumers. Maybe don't really need an extra tab?

That is funny to read because over the day I've added support for multiple to be changed by space-age because someone noticed they're needed. All the space age variants I listed above are confirmed to be needed. So yes we do need the tabs.

As you noticed, the space age icon overlay on icons isn't very readable. Furthermore, currently the icon means that the item is exclusive to spage age/removed in space age, which is already stated on the page itself with the space age templates. But consumers aren't modified like that, for example red circuits are consumed by artillery in base game, but not in space age. But that doesn't make artillery an item that's removed in space age - the recipes are just different. So using the icon overlay for that would give it more meanings that also make it worse that it's not super clear.

I [...] am hoping to automate [...] space age exclusivity

I'm assuming those blacklist/whitelist items are not easily generated?

They should be easily generated, just a matter of doing. The generation likely wont happen this week because I am away for a few days.

If you're still looking, saving that preferences is quite easy via javascript, there's mediawiki functionality for that

I wasn't aware of the mw function, thank you!

Honestly I would prefer to see all 5 numbers at once, just separated by slashes, rather than the tooltip style used in-game. Accessibility is yet another reason I think we shouldn't go down this path.

One issue with the slashes is the unit of the inserters which are given in °/s, so they already have slashes inside of them. Now of course you can also have the numbers without units and the unit at the end but it still looks a bit weird...
80/120/160/240/300 °/s
or other uses of the slash in something like "Resistances: Fire: 0/90%"

Thanks for the template! I adjusted it to use | as the separator so we don't have this problems and made it always shows all qualities.

In the future I would like to look into automatically displaying the quality diamond on the title of rows that use the quality template, but that's for not today. Same with implementing the persistent tab state.

With https://wiki.factorio.com/Template:Quality and the rows I added to the infobox template today, infoboxes are looking pretty complete to hold all the data we would need for 2.0!

Regarding outdated pages, there's Category:Pages_needing_clean-up which some people have been adding pages to using the cleanup template.

[untitled7]

tabber it is then!
Made another mockup, this time for a tabber with images

code

css:

Code: Select all

ul.tabbernav {
  padding-right: 4px;
}
ul.tabbernav li {
  display: inline-block;
  width: 50%;
}

ul.tabbernav li a {
  display: block;
  text-align: center;
  margin-bottom: -0.45em;
}

ul.tabbernav li a img {
  margin: 0 1px 1.5px 0;
}

ul.tabbernav li.tabberactive a img {
  margin: 1.5px 0 0 1px;
}

(this of course depends on load order)

js:

Code: Select all

// match these for translations
var imageSource = {
    "Base game": "/images/Factorio-logo.png",
    "Space Age mod": "/images/Space-Age-logo.png"
};

$(document).ready(function () {
    $('.infobox div.tabber ul.tabbernav li a').each(function() { 
        var title = $(this).attr('title');
        if (title !== undefined) {
            $(this).html('').append(
                $('<img>', {
                    alt : title,
                    src : imageSource[title],
                    height : '20px',
                    width : 'auto'
                })
            );
        }
    });
});

Kinda related, but it's own issue alltogether: I pointed it out as an example, but the rotation speed of inserters which is now affected by quality... is not on the wiki at all and the Infobox Module doesn't handle arguments for it.

I also noticed that the wiki is running the Tabber Extension, which is legacy now.

[Edit] changed the javascript