Page 1 of 1

MMWiki Scripting (Automation objects) Pages Templates

Posted: Tue Apr 08, 2008 9:32 pm
by MoDementia
I have added 2 templates to a couple of pages on the MMWiki site to hopefully generate some user feedback.
The idea is to give new scripters as much information as possible to get them started.
Pages with the new templates.
Title
Album

This is how they used to look
Title
Album

The first template is a table on the right hand side summarising the properties of the object (field/data) Includes:

Scripting Object: Its parent source
Value Name: The name used to reference it in a script
Value Type: Value, String or Object. (Can be added together, can be uppercased etc, needs further manipulation to be displayed)
Database Table: Which table in the database it is from
Field Name: The database column name
Field Type: The database type, Text, Integer, Date etc
Tracklist Column: The title of the information in MM (what a user would call it)
Example Data: An example of the data (may require further manipulation to be readable, i.e. date conversion, seperate based on delimiter ";" etc)
Hierarchy: Not formalised yet but gives an idea of how many parents the value has before it is usable as user output.

The second template is a generic VBscript that replaces the appropriate code to produce a usable example of how to access the data (probably needs an explaination of how to copy and paste it for MM use)

Adding the templates to other pages is a single line entry in the page with the template name and the values for the various (9)properties seperated by a pipe "|"
I have used ABBA's Waterloo as an example track. :)
eg.
Title

Code: Select all

{{Property Summary|SongData|Title|String|Songs|SongTitle|Text|Title|Waterloo|Main List Sub Item String}}
Album

Code: Select all

{{Property Summary|SongData|Album|Object|Songs|Album|Text|||Sub List}}
Hopefully other users/scripters will add the templates to pages they visit/use while they are there :P

Detailed Information on the templates will be updated Here

Posted: Tue Apr 08, 2008 10:23 pm
by MoDementia
ok, there is actually text in the first post now :)

Posted: Wed Apr 09, 2008 3:30 am
by trixmoto
I like the table, that's very useful. I think the example is a bit scary though! How about something a bit simpler?

Posted: Wed Apr 09, 2008 11:55 am
by Steegy
I'm thinking now as the scripter I am now (somewhat more advanced) but also as the scripter I was some years ago (quite not advanced).

I think each scripting help/reference page should have a small example that is related to the page (like it is now, but better maintained). For large script examples, there's the Sample Scripts page.


As I've already shown, I like the property summary table. However, I think you might want to reconsider the "hierarchy" part; the need and interpretation isn't very clear/correct to me.
I also somewhat doubt if the "example" part will be needed. E.g. it's the Title field of a SongData object, which accepts a String (or "Text") --> should be quite obvious that this fields accepts the song's title as value.

Re: MMWiki Scripting (Automation objects) Pages Templates

Posted: Thu Apr 10, 2008 4:05 am
by MoDementia
I have reduced the sample code considerably and added another sample script here

Pages with the new templates.
Title
Album

Leaving the "example" out for Title etc would probably not make any difference but things like ratings, internal dates, song lengths etc it would be advantages to see that the rating is in fact a number between -1 and 100 not 0.5, 1.0, 1.5.

I'm not happy with "hierarchy" either but some sort of comparitive category would help.
While Title is the same as Rating
Album is different
and
AlbumArt is different again.

Posted: Thu Apr 10, 2008 4:12 am
by trixmoto
That's a much nicer example! :)