As I was working on my next user story I stumbled upon a problem (more like my misjudgement than a problem) that was unsolvable without changing the current implementation of importing sprites too much.
Initially, I thought that when sprite sheet configuration is exported as XML, group and sprite names should be exported as tags to allow users access nodes directly with XPath. So, for example, the following sprite tree
would’ve produced the following configuration
<sheet> <buttons> <default x="" y="" width="" height="" /> <pressed x="" y="" width="" height="" /> </buttons> </sheet>
But, I did not take into account that I had no character restrictions on names and that they could include characters deemed illegal by W3C XML specification.
To fix this I decided to allow only characters defined by XML specification, fix names that contained illegal characters and let users change names manually when importing sprites into sprite sheet, if they wish so. I also decided to make the importing process a little bit more generic, as before, adding a single sprite and adding a whole folder of sprites were two separate operations.
I combined the two separate operations into one single wizard. Users can now specify whether they want to add a couple of sprites or the whole folder of sprites in one wizard. Sprites will then be loaded and displayed in a preview tree where users can choose which sprites to add to a sprite sheet. The image bellow illustrates this process.
When users are happy with selected sprites they can move to the next page where they can rename sprites and fix conflicts. At the moment, users can only rename one sprite at a time but in the future users will be able to rename a batch of sprites all at once. Controls will look something similar to Find/Replace tool in Eclipse.
As I was close to finishing these changes I talked to Alan Morey to get his input about this. He suggested that exporting names as tags was not a good idea and that instead I should export names just like other attributes to have something like this,
<sheet> <group name="buttons"> <sprite name="default" x="" y="" width="" height="" /> <sprite name="pressed" x="" y="" width="" height="" /> </group> </sheet>
I liked the idea but I was still concerned with allowing users to access nodes directly with XPath like so,
But he insisted that users will most likely be concerned with importing the whole sprite sheet configuration and then accessing nodes with my API, and I can also provide an API for addressing sprites similar to XPath. So, to keep story short, I took his suggestions in and now names are exported as attributes.
This brought my attention back to my original problem. If I keep names as attributes then there is no problem with illegal characters! Well, at least in XML configuration. Other configuration formats that will be implemented in the future may still have a problem with illegal characters but I’ll let it bother me when the time comes to implementing them.
So, at the end of the day, I have changed the way users import sprites, implemented the rename feature to allow users rename sprites in bulk and kept no restrictions on name characters.