widelands / widelands-website

The widelands website is a bunch of applications for the django web framework. It is developed in the open here.
https://www.widelands.org/
GNU General Public License v2.0
15 stars 10 forks source link

Add the name attribute to the encyclopedia #216

Closed gunchleoc closed 5 years ago

gunchleoc commented 5 years ago

I think it would be nice to have the name attribute (needed for scripting) in the encyclopedia on the website.

The main reason for this suggestion is that digging through the folders and open each init.lua to get the correct attribute for 'name = ..' could be a hard search, especially for beginners. The encyclopedia is well structured and the attribute 'name' is already available, but not shown (it is used for the links)

I have no idea how to provide them though, because there is not many space.

Open for discussion :-)


Imported from Launchpad using lp2gh.

gunchleoc commented 5 years ago

(by franku) An attempt

gunchleoc commented 5 years ago

(by franku) I decided to have the name attribute in the column 'Description' as a small text.

For the Workers i have also added a column "Works At" with links pointing to the details page.

gunchleoc commented 5 years ago

(by gunchleoc) Good idea.

I don't like it on top with the different text sizes. How about putting it below the descname or below the image, with the "internal name:" prefix omitted?

gunchleoc commented 5 years ago

(by franku) Of course i had tried your suggestion also... The problem: The string can be very long, e.g. "atlanteans_woodcutters_house" which will not fit in the width. We could use automatic line breaks, but this is ugly at all and may result in:

"atlanteans_wo odcutters_hous e"

Not speaking for the wares and workers pages, where the first is much smaller.

I have also tried to show the Description at top of the and the name on the bottom of the , but i didn't get it to work.

The reason why it is smaller in size, is that i wanted to have it different from the other stuff. Also tried to have it at last line in the description, but that looks also not good.

I thought also to make a checkbox on top of the page called "Show names for scripting: [ ]". So the names can be shown if needed. I will try that next.

Currently i am working on the Wares page to show "Produced at/by".

gunchleoc commented 5 years ago

(by gunchleoc) Sounds like you already tried everything. A checkbox is a good idea - maybe have it add an extra column?

gunchleoc commented 5 years ago

(by gunchleoc) Concerning the produced by, the information is already there if the user clicks on the ware and accesses the interactive graph. Maybe make it more obvious that that function is available, e.g.via an introductory text or a "more..." link?

gunchleoc commented 5 years ago

(by franku) The economy graphs needs fixing as well: They consist of an image with an image map https://www.w3schools.com/tags/tag_map.asp

Wide images get scaled down to fit the area, but the areas of the imagemap does not reflect the downscale. You could see this in the attached screenshot: The small thin blue oval line is the area where one has to click for the ax, whereas the oval for the ax is left of the area. Try it out yourself by opening https://wl.widelands.org/encyclopedia/barbarians/wares/ax/ and make the browsers window smaller. I think this could be solved when the economy graphs are displayed top-down instead of LTR. But this is another task.

I will give the images (links) which points to economy graphs a tooltip. This is not good for screenreaders, but i guess screen readers can't handle the economy graphs very well :-(

Regarding the checkbox for the name attribute: I have implemented it now in a way to show them with some space below the description (in the same table cell). Because it will be only interesting for scenario creators, i think this is fine. Some screenshots will follow. I am still struggling with the width of the columns... and the design of the templates.

gunchleoc commented 5 years ago

(by franku)

gunchleoc commented 5 years ago

(by franku) Forgotton: I think it would be nice to have the used tool in the workers page. E.g. "Needs Tool: Bradpaddle". But this information couldn't be extracted right now.

Maybe it is also not necessary to store all those informations in the database and instead read them directly form json files? No idea if this would affect loading times that much.

gunchleoc commented 5 years ago

(by gunchleoc) The screenshots in #8 look good to me :)