[Scummvm-devel] Website re-write, updated directory structure

Fredrik Wendel fredrik_w at users.sourceforge.net
Sat May 23 23:06:39 CEST 2009


Hi again,

The new website backend re-write has brought some changes to the directory 
structure. Eugene asked me to write up some small guide to the new structure, 
which I think is a very good idea.

Basically, anything that is data feed to the website is found under data/ and 
website specific things are in the root, while PHP files are under include/.

/
--/css :: contains all the different CSS files
--/data
----/compatibility :: contains the compatibility chart XML files
----/downloads :: contains the local downloads
----/media :: contains media files (press page), ie scanned articles (just one)
----/news :: the news items reside here
----/screenshots :: screenshots have moved here
--/images :: images used by the website
--/include :: where the PHP-files reside
----/Models :: models used to create objects from the XML-files
----/Objects :: objects representing the different items on the website
----/Pages :: the controllers used to map objects data to smarty templates
----/smarty :: the HTML templating engine used
--/javascripts :: javascripts for the website
--/templates :: the smarty templates

So if you want to update some compatiblity data, you should now edit an XML-file 
in data/compatibility. The format is pretty self-explaining.

For news posts, if you have an image, the correct way to link it now is 
"data/news/image.ext" instead of earlier "news/image.ext".

The MD5 sums was previously generated by some script that spat out an md5.inc 
file, the new website parse the scumm_md5.txt file directly. So that's one step 
less.

For the credits, the credits.pl script has been updated, now use "credits.pl 
--xml-website" for generating XML-for the website. For docbook XML use 
"--xml-docbook".

I think that should be all. I will try and write up a more proper documentation 
as soon as I can, in the meantime, don't hesitate to ask if there's something 
you're wondering over.


Regards,
Fredrik




More information about the Scummvm-devel mailing list