Official Documentation?

[Bennett 🚀]

When is this going to come out? I'd like to know what to expect when it comes to variable appearing on certain pages, what elements are always going to be in a template, stuff like that.

[Luke]

ProBoards are working on one but it isn't ready to be released to the public yet

[Pebble]

Yep. This would be nice!

If there are some variables knocking about like the V4 ones,,,

var pb_bubble = 0;
var pb_skinid = 1;
var pb_username = 'pebbleleague';
var pb_forum = '';
var pb_displayname = 'Pebble';
var pb_adfloat = 1;
var pb_admovement = "center";
var pb_adx = 0;
var pb_VersionNo = 4.5;
var pb_this = '';
var pb_action = 'display';

The data is there in V5 but maybe I've missed an easy way of extracting it like the V4 pb_variable?

Maybe it's there This is the first day I've built some plug-ins........ If it is , let me know!

[Jordan]

Nov 1, 2012 18:17:10 GMT -8 Jordan said:

var user_url = proboards.data('user').url;
var user_id = proboards.data('user').id;
var display_name = proboards.data('user').name;

Here are a few other things you can access in the same way.

proboards.data([
      ['time_style', 0],
      ['military_time', 0],
      ['timezone', "-5.00"],
      ['serverDate', 1351822305000],
      ['search-query-min', 3],
      ['search-query-max', 50],
      ['is_current_user_guest', ""],
      ['home_new_post_src', "/images/icons/board-no-new-post.png"],
      ['shoutbox_init', {
            "newestAt": "0",
            "lastUpdateTime": 1351041542000,
            "smileyList": ["", "/images/smiley/smiley.png", "", "/images/smiley/tongue.png", "", "/images/smiley/plain.png", "", "/images/smiley/cry.png", "", "/images/smiley/angry.png", "", "/images/smiley/grin.png", "", "/images/smiley/sad.png", "", "/images/smiley/eyesroll.png", "", "/images/smiley/wink.png", "", "/images/smiley/cool.png", "", "/images/smiley/squint.png", "", "/images/smiley/huh.png", "", "/images/smiley/shocked.png", "", "/images/smiley/rofl.png", "", "/images/smiley/dead.png", "", "/images/smiley/insane.png", "", "/images/smiley/sick.png", "", "/images/smiley/cheesy.png", "", "/images/smiley/browraise.png", "", "/images/smiley/superangry.png", "", "/images/smiley/lipssealed.png", "", "/images/smiley/kiss.png", "", "/images/smiley/nerd.png", "", "/images/smiley/notamused.png", "", "/images/smiley/undecided.png", "", "/images/smiley/asleep.png", "", "/images/smiley/embarrassed.png", "", "/images/smiley/wavey.png", "", "/images/smiley/pirate.png", "", "/images/smiley/ninja.png"]
      }],
      ['shoutbox_add_url', "/shoutbox/add"],
      ['shoutbox_edit_url', "/shoutbox/edit"],
      ['shoutbox_message_url', "/shoutbox/get"],
      ['shoutbox_remove_url', "/shoutbox/remove"],
      ['shoutbox_update_url', "/shoutbox/update"],
      ['csrf_token', "xxxxxxxx"],
      ['user', {
            "is_logged_in": 1,
            "theme_id": "3",
            "url": "/user/1",
            "name": "Jordan",
            "id": "1",
            "is_staff": "1"
      }],
      ['route', {
            "params": {},
            "name": "home"
      }],
      ['page', {}]
]);

[Pebble]

Cheers Jordan ,

[Bennett 🚀]

Nov 5, 2012 13:28:07 GMT -8 Jordan said:

Nov 1, 2012 18:17:10 GMT -8 Jordan said:

var user_url = proboards.data('user').url;
var user_id = proboards.data('user').id;
var display_name = proboards.data('user').name;

Here are a few other things you can access in the same way.

proboards.data([
      ['time_style', 0],
      ['military_time', 0],
      ['timezone', "-5.00"],
      ['serverDate', 1351822305000],
      ['search-query-min', 3],
      ['search-query-max', 50],
      ['is_current_user_guest', ""],
      ['home_new_post_src', "/images/icons/board-no-new-post.png"],
      ['shoutbox_init', {
            "newestAt": "0",
            "lastUpdateTime": 1351041542000,
            "smileyList": ["", "/images/smiley/smiley.png", "", "/images/smiley/tongue.png", "", "/images/smiley/plain.png", "", "/images/smiley/cry.png", "", "/images/smiley/angry.png", "", "/images/smiley/grin.png", "", "/images/smiley/sad.png", "", "/images/smiley/eyesroll.png", "", "/images/smiley/wink.png", "", "/images/smiley/cool.png", "", "/images/smiley/squint.png", "", "/images/smiley/huh.png", "", "/images/smiley/shocked.png", "", "/images/smiley/rofl.png", "", "/images/smiley/dead.png", "", "/images/smiley/insane.png", "", "/images/smiley/sick.png", "", "/images/smiley/cheesy.png", "", "/images/smiley/browraise.png", "", "/images/smiley/superangry.png", "", "/images/smiley/lipssealed.png", "", "/images/smiley/kiss.png", "", "/images/smiley/nerd.png", "", "/images/smiley/notamused.png", "", "/images/smiley/undecided.png", "", "/images/smiley/asleep.png", "", "/images/smiley/embarrassed.png", "", "/images/smiley/wavey.png", "", "/images/smiley/pirate.png", "", "/images/smiley/ninja.png"]
      }],
      ['shoutbox_add_url', "/shoutbox/add"],
      ['shoutbox_edit_url', "/shoutbox/edit"],
      ['shoutbox_message_url', "/shoutbox/get"],
      ['shoutbox_remove_url', "/shoutbox/remove"],
      ['shoutbox_update_url', "/shoutbox/update"],
      ['csrf_token', "xxxxxxxx"],
      ['user', {
            "is_logged_in": 1,
            "theme_id": "3",
            "url": "/user/1",
            "name": "Jordan",
            "id": "1",
            "is_staff": "1"
      }],
      ['route', {
            "params": {},
            "name": "home"
      }],
      ['page', {}]
]);

Are these on every page?

[VS Admin]

Yes, however a note: our official documentation will tell you which of these you can rely on. Some of them are subject to change. You can expect the most common things to be accessible (such as the user's name, id, url, etc).

[Martyn Dale]

As an additional note, by editing the templates you can add even more, even ones with the same name. For example

<script>
pb_username = '$[current_user.username.escaped]';
pb_name = '$[current_user.name.escaped]';
</script>

The reason for the escaped part, is so it returns the escaped version of the strings. You wouldn't want users putting JavaScript in their display names and having that executing on the page!

[Chris]

Nov 5, 2012 17:48:18 GMT -8 Martyn Dale said:

The reason for the escaped part, is so it returns the escaped version of the strings.

It would be greatly helpful if tidbits such as that were released prior to the holy grail guide especially since they cannot be ascertained using the Thomas A. Anderson ("Wake up, Neo...") tactic of returning to the source.