Wiki changes

General discussion about LÖVE, Lua, game development, puns, and unicorns.
User avatar
qaisjp
Party member
Posts: 490
Joined: Tue Sep 04, 2012 10:49 am
Location: United Kingdom
Contact:

Wiki changes

Post by qaisjp »

Recently I have created some wiki changes - namely some templates. I'd just like what you guys feel about it. See the before and afters:
I know this new design cannot be applied in all cases, but better for mainly argument changes (instead of an entirely new function heading)
I also noticed that there is "#set Since:080" inside the newin template, I have applied this into my new template.

Argument changes:
love.keyboard.isDown [Before] [After]
love.graphics.drawq [Before] [After]
love.event.push [Before] [After]

Title changes:
love.graphics.newStencil [Before] [After]

Enum changes:
ShapeType [Before] [After]

Dynamic arguments:
love.physics.newRectangleShape [Before] [After]
Last edited by qaisjp on Sun Oct 21, 2012 2:24 pm, edited 4 times in total.
Lua is not an acronym.
User avatar
Robin
The Omniscient
Posts: 6506
Joined: Fri Feb 20, 2009 4:29 pm
Location: The Netherlands
Contact:

Re: Wiki changes

Post by Robin »

It seems like a nice idea, but it looks a bit noisy in practice. This only really works well if arguments are added. If they are removed, change in meaning or are shuffled around, this gets really hard to read rather quickly.
Help us help you: attach a .love.
User avatar
qaisjp
Party member
Posts: 490
Joined: Tue Sep 04, 2012 10:49 am
Location: United Kingdom
Contact:

Re: Wiki changes

Post by qaisjp »

Lua is not an acronym.
User avatar
Robin
The Omniscient
Posts: 6506
Joined: Fri Feb 20, 2009 4:29 pm
Location: The Netherlands
Contact:

Re: Wiki changes

Post by Robin »

The one for love.graphics.newStencil seems rather out of place: it is kind of odd to place the function description inside the notice box.
Help us help you: attach a .love.
User avatar
josefnpat
Inner party member
Posts: 955
Joined: Wed Oct 05, 2011 1:36 am
Location: your basement
Contact:

Re: Wiki changes

Post by josefnpat »

You seem to be breaking some common styles across the wiki;
FYzK5.png
FYzK5.png (75.91 KiB) Viewed 255 times
Missing Sentinel Software | Twitter

FORCIBLY IGNORED.
<leafo> when in doubt delete all of your code
<bartbes> git rm -r *
<bartbes> git commit -m "Fixed all bugs"
<bartbes> git push
User avatar
slime
Solid Snayke
Posts: 3170
Joined: Mon Aug 23, 2010 6:45 am
Location: Nova Scotia, Canada
Contact:

Re: Wiki changes

Post by slime »

I would rather have the current/old style everywhere than your changes, I think. It has too little to offer while not being able to display many types of version changes very well.
Santos
Party member
Posts: 384
Joined: Sat Oct 22, 2011 7:37 am

Re: Wiki changes

Post by Santos »

I'm glad that you're thinking of way to improve the wiki! :)

I think the most important thing is providing good documentation for people who use the current version, because I'd assume the vast majority of LÖVE users would be using this. If this is true, perhaps the most obvious solution would be to completely remove all of the outdated documentation. But then, what about people who aren't using the current version? Is it possible to completely remove all of the outdated documentation and still somehow provide documentation for users of older versions?

Here are some other possible changes to the wiki to consider:
  • Concept:Current doesn't seem to work as intended. It seems like the idea is to remove outdated functions and types from the lists, for example to remove Framebuffer from the list of love.graphics types. I think this is a great idea!
  • The function lists are in alphabetical order, and I think that it would be easier to explore the functionality of LÖVE if these were categorized instead. On the love.graphics page for example, there are functions related to drawing primitives, the state of primitives, colors, the coordinate system, the drawing region, the window/display, etc. However in alphabetical order, they are all spread out, and I think if they were organized it would be a lot easier to discover what functionality is available.
  • I wonder about the wiki experience for new users... I not sure Programming in Lua or the other linked-to resources for learning Lua are suitable for people who don't already know a similar programming language... and they'd no doubt go to the games page, but a lot of the games are incompatible with the latest version... I don't really have any answers though.
  • The list of libraries is needlessly divided, perhaps someone who can edit locked pages could fix this.
User avatar
qaisjp
Party member
Posts: 490
Joined: Tue Sep 04, 2012 10:49 am
Location: United Kingdom
Contact:

Re: Wiki changes

Post by qaisjp »

Thank you Santos.
josenfpat, what do you mean? The "i" looks weird on yours though.
Lua is not an acronym.
User avatar
josefnpat
Inner party member
Posts: 955
Joined: Wed Oct 05, 2011 1:36 am
Location: your basement
Contact:

Re: Wiki changes

Post by josefnpat »

qaisjp wrote:Thank you Santos.
josenfpat, what do you mean? The "i" looks weird on yours though.
The "Availible since 0.7.2" window.

Also, the i is from the ubuntu mono font that's overriding my default in my browser.
Missing Sentinel Software | Twitter

FORCIBLY IGNORED.
<leafo> when in doubt delete all of your code
<bartbes> git rm -r *
<bartbes> git commit -m "Fixed all bugs"
<bartbes> git push
User avatar
qaisjp
Party member
Posts: 490
Joined: Tue Sep 04, 2012 10:49 am
Location: United Kingdom
Contact:

Re: Wiki changes

Post by qaisjp »

josefnpat wrote:
qaisjp wrote:Thank you Santos.
josenfpat, what do you mean? The "i" looks weird on yours though.
The "Availible since 0.7.2" window.

Also, the i is from the ubuntu mono font that's overriding my default in my browser.
Um.. that's what I am trying to highlight..
Lua is not an acronym.
Post Reply

Who is online

Users browsing this forum: No registered users and 5 guests