Note to AddOn Devs

Posts from previous Beta sessions

Note to AddOn Devs

Postby zanix » Sun Aug 26, 2007 10:15 am

This is just to inform of updates to the AddOn SDK for Roster 2.0

The framework may undergo slight changes over the course of beta testing
I will post changes and update to the AddOn SDK as they happen

http://www.wowroster.net/MediaWiki/AddonSDK

There is also a change log at the top of the wiki document
Pay attention to it for changes


Any of the addon devs are welcome to make changes or additions as needed (I can't possibly get everything in here)

If anyone does modify the addon sdk, please change the updated date (replace the date with 5 ~) and add to the mini change log

Replace the updated date
Updated: ~~~~~


Add to the mini change log
(Note: ~~~~ will be replaced with your user name and a date)
* ~~~~
** Some changes
** Other changes
*** Sub with bullet
**: Sub without bullet
Last edited by zanix on Wed Nov 28, 2007 3:28 am, edited 2 times in total.
Read the Forum Rules, the WiKi, and Search before posting!
WoWRoster v2.1 - SigGen v0.3.3.523 - WoWRosterDF
User avatar
zanix
Admin
Admin
WoWRoster.net Dev Team
WoWRoster.net Dev Team
UA/UU Developer
UA/UU Developer
 
Posts: 5543
Joined: Mon Jul 03, 2006 8:29 am
Location: Idaho Falls, Idaho
Realm: Doomhammer (PvE) - US

A note to AddOn Devs

Postby nightfighter » Thu Aug 30, 2007 4:17 am

I finally figured out why I am having trouble setting up the configuration of the Addon I am writing. There is no documentation on how to do it and all of what I am doing is by trial and error. Do you want to write the documentation for that or do you have a problem with me or any of the other developers working on the documentation for areas we are having trouble with?
User avatar
nightfighter
Roster AddOn Dev
Roster AddOn Dev
 
Posts: 169
Joined: Wed Jul 05, 2006 11:25 pm
Location: Boise, Idaho, USA

A note to AddOn Devs

Postby ds » Thu Aug 30, 2007 4:22 am

How could we say no to a volunteer Document writer?! :) :)
Image
ds
Roster AddOn Dev
Roster AddOn Dev
 
Posts: 297
Joined: Sat Jul 08, 2006 9:58 am

A note to AddOn Devs

Postby zanix » Thu Aug 30, 2007 4:22 am

I have no problem with people writing/modifying the wiki
I can always rollback or make edits myself

I added some more info in my first post
Read the Forum Rules, the WiKi, and Search before posting!
WoWRoster v2.1 - SigGen v0.3.3.523 - WoWRosterDF
User avatar
zanix
Admin
Admin
WoWRoster.net Dev Team
WoWRoster.net Dev Team
UA/UU Developer
UA/UU Developer
 
Posts: 5543
Joined: Mon Jul 03, 2006 8:29 am
Location: Idaho Falls, Idaho
Realm: Doomhammer (PvE) - US

A note to AddOn Devs

Postby PleegWat » Thu Aug 30, 2007 5:32 am

There's a bit of documentation in the source file (lib/config.lib.php). There was a doc file for the config in AdminPanel, but either it never got moved over or it got stripped cause zanix doesn't want a wildgrow of docs but all in the wiki, or some other reason I forgot.

config documentation wrote:$Id: config.txt 96 2006-08-22 15:07:24Z pleegwat $

This is the current functionality of the config class.

There are two classes of form types: Option blocks for layout, and the actual

options. Items of the page, pageframe, and pagehide class contain option blocks.

Items of the blockframe or blockhide class contain options.



Menu bar items:

page, pageframe, pagehide, blockframe, blockhide:

A page of options that gets selected with javascript

link:

An external link to be opened in the same window

newlink:

An external link to be opened in a new window



In the URLs for these links, %roster% is substituted for the roster

base url, and %addon% is substituted for the addon's dbname.



Options blocks:

page{n:

n collumns of options blocks

pageframe{n

n collumns of options blocks in a border

pagehide{n

n collumns of options blocks in a border, with a show/hide option



blockframe

A list of options in a border

blockhide

A list of options in a border, witha show/hide option

function{name

Calls the function called name with no parameters to produce the HTML

for the page. If this is a tab (directly linked from the switch menu on

the left side) it is put outside the main form so you can put forms in it.



Options:

text{n|m

A text box m characters wide, maximum of n characters input

radio{op1^val1|op2^val2|op3^val3...

A list of radio buttons with labels op1, op2, op3,... which produce

values val1, val2, val3,... Labels are literal, not localization keys.

select{op1^val1|op2^val2|op3^val3...

A a dropdown box with options op1, op2, op3,... which produce

values val1, val2, val3,... Labels are literal, not localization keys.

function{name

Calls the function called name with the option record as parameter to

produce the HTML for the option.

display

Displays the option's setting.





config.func.php:

Both function types call functions that are defined in a file called

'config.func.php' in your addon's directory. If this file sets

$addon_hastopbox to true it should define a function topbox(). The html

returned by this function will be put above the options in the middle

collumn.


The only change since I last updated that file is that the config.func.php is now in the admin/ dir.
Last edited by PleegWat on Thu Aug 30, 2007 5:36 am, edited 1 time in total.
I <3 /bin/bash
User avatar
PleegWat
WoWRoster.net Dev Team
WoWRoster.net Dev Team
 
Posts: 1636
Joined: Tue Jul 04, 2006 1:43 pm

A note to AddOn Devs

Postby zanix » Wed Sep 26, 2007 12:36 am

AddonSDK has been updated

Added 2 new addon installer functions
Install::add_table() , Install::drop_table()
Install::add_table() is required for adding new tables to the roster db as it automatically sets the correct charset
Install::drop_table() is not required, just useful

Updated the example installer file to be more 'complete'
Read the Forum Rules, the WiKi, and Search before posting!
WoWRoster v2.1 - SigGen v0.3.3.523 - WoWRosterDF
User avatar
zanix
Admin
Admin
WoWRoster.net Dev Team
WoWRoster.net Dev Team
UA/UU Developer
UA/UU Developer
 
Posts: 5543
Joined: Mon Jul 03, 2006 8:29 am
Location: Idaho Falls, Idaho
Realm: Doomhammer (PvE) - US

A note to AddOn Devs

Postby zanix » Fri Oct 26, 2007 6:09 am

AddonSDK has been updated
* 2 new installer menu functions
* Install::add_menu_pane()
* Install::remove_menu_pane()
o Details on these new functions can be found under "8.5 Creating/Editing Menu Entries"
* Install::add_menu_button() has an additional parameter $section
o This allows you to add a menu button to a custom made menu pane
* Install::create_table() now adds the table name to the drop list
o This means that when the addon has an error on installation, these tables will also be dropped

These changes are currently in the SVN
Read the Forum Rules, the WiKi, and Search before posting!
WoWRoster v2.1 - SigGen v0.3.3.523 - WoWRosterDF
User avatar
zanix
Admin
Admin
WoWRoster.net Dev Team
WoWRoster.net Dev Team
UA/UU Developer
UA/UU Developer
 
Posts: 5543
Joined: Mon Jul 03, 2006 8:29 am
Location: Idaho Falls, Idaho
Realm: Doomhammer (PvE) - US

A note to AddOn Devs

Postby zanix » Mon Nov 26, 2007 11:30 am

AddonSDK has been updated
  • Changes to how $roster->output['show_menu'] works
  • Added info on adding additional lua files for upload
    • This isn't new but I am finally adding info about it
Read the Forum Rules, the WiKi, and Search before posting!
WoWRoster v2.1 - SigGen v0.3.3.523 - WoWRosterDF
User avatar
zanix
Admin
Admin
WoWRoster.net Dev Team
WoWRoster.net Dev Team
UA/UU Developer
UA/UU Developer
 
Posts: 5543
Joined: Mon Jul 03, 2006 8:29 am
Location: Idaho Falls, Idaho
Realm: Doomhammer (PvE) - US

Note to AddOn Devs

Postby zanix » Wed Nov 28, 2007 3:31 am

AddOn installer class names now must be named
addonnameInstall

install.def.php
Code: Select all
class addonnameInstall
{
....
}


For example, the memberslist addon installer class name must be
memberslistInstall


This change will also appear in the addon sdk
Last edited by zanix on Wed Nov 28, 2007 3:32 am, edited 1 time in total.
Read the Forum Rules, the WiKi, and Search before posting!
WoWRoster v2.1 - SigGen v0.3.3.523 - WoWRosterDF
User avatar
zanix
Admin
Admin
WoWRoster.net Dev Team
WoWRoster.net Dev Team
UA/UU Developer
UA/UU Developer
 
Posts: 5543
Joined: Mon Jul 03, 2006 8:29 am
Location: Idaho Falls, Idaho
Realm: Doomhammer (PvE) - US

Note to AddOn Devs

Postby zanix » Thu Feb 14, 2008 12:06 pm

AddOn SDK updated quite a few times since the last post
I hope you addon devs have been paying attention

  • Zanix 23:02, 13 February 2008 (CST)
    • Quite a few changes went into the search framework over the last few days
    • This update reflects those changes and the Search Framework in its current form
  • Zanix 23:52, 11 February 2008 (CST)
    • Added some missing $addon data
    • Updated search class info for svn1655
  • Zanix 22:13, 5 February 2008 (CST)
    • Updated some examples, and some of the wording in a few places
    • Roster Auth changes
  • Zanix 21:04, 10 January 2008 (PST)
    • Roster login changes
  • Gaxme 10:41 7 January 2008 (PST)
    • The $installer->remove_config($id) function exists, now listed here
  • Gaxme 17:37, 3 January 2008 (PST)
    • Added note regarding additional lua files for upload (lower case)
Read the Forum Rules, the WiKi, and Search before posting!
WoWRoster v2.1 - SigGen v0.3.3.523 - WoWRosterDF
User avatar
zanix
Admin
Admin
WoWRoster.net Dev Team
WoWRoster.net Dev Team
UA/UU Developer
UA/UU Developer
 
Posts: 5543
Joined: Mon Jul 03, 2006 8:29 am
Location: Idaho Falls, Idaho
Realm: Doomhammer (PvE) - US

Note to AddOn Devs

Postby zanix » Fri Mar 07, 2008 11:38 am

As of svn 1722, certain images have been moved to the templates/default/images/ directory

This was done because these images are generic enough that a new theme designer might want to replace these images

ADDONS WILL NEED TO BE UPDATED FOR THE NEW IMAGE LOCATIONS

$roster->config['theme_path'] will point to the url path of the current theme (ex. /roster/templates/default) and should be used to point to images in the template directory

Example
An image that used to be accessed this way
Code: Select all
$roster->config['img_url'] . 'minus.gif'

Should now be accessed this way
Code: Select all
$roster->config['theme_path'] . '/images/minus.gif'


Please note that $roster->config['theme_path'] does NOT have an ending slash unlike $roster->config['img_url'] which does have an ending slash
Read the Forum Rules, the WiKi, and Search before posting!
WoWRoster v2.1 - SigGen v0.3.3.523 - WoWRosterDF
User avatar
zanix
Admin
Admin
WoWRoster.net Dev Team
WoWRoster.net Dev Team
UA/UU Developer
UA/UU Developer
 
Posts: 5543
Joined: Mon Jul 03, 2006 8:29 am
Location: Idaho Falls, Idaho
Realm: Doomhammer (PvE) - US


Return to Archived

Who is online

Users browsing this forum: No registered users and 0 guests

cron