Main Page
From Metrixstream
(Difference between revisions)
MetrixAdmin (Talk | contribs) m (→Site Frontend) |
MetrixAdmin (Talk | contribs) m (→Site API) |
||
| (15 intermediate revisions by one user not shown) | |||
| Line 5: | Line 5: | ||
= Site Frontend = | = Site Frontend = | ||
| − | ; [[Site:Introduction|Introduction]] | + | ; [[Site:Frontend:Introduction|Introduction]] |
: Everything you need to know to get started making sites. | : Everything you need to know to get started making sites. | ||
; [[Site:Frontend:BuildingBlocks|Building Blocks]] | ; [[Site:Frontend:BuildingBlocks|Building Blocks]] | ||
| Line 38: | Line 38: | ||
The backend is responsible for executing queries to the database and returning their result in a format the frontend is capable of understanding. | The backend is responsible for executing queries to the database and returning their result in a format the frontend is capable of understanding. | ||
| − | ; [[Site:Backend: | + | ; [[Site:Backend:Queries|Backend Queries]] |
| − | : | + | : A list of the supplied backend queries. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
= Site API = | = Site API = | ||
| − | The API | + | The API allows modifications to objects through the backend. All API queries are sent through the same URL. It is common to assign this URL to a JavaScript variable that is then passed throughout your code. Make sure to assign this variable in your actual page definition rather than a JavaScript file. This is required because the templating engine is not available in external JavaScript fileds. |
| + | var urls = { | ||
| + | 'apiUrl': '<?cs call:getBasePostUrl() ?>' | ||
| + | }; | ||
| + | |||
| + | ; [[Site:API:Authentication|Authentication]] | ||
| + | : this includes support for login, signup, and logout functionality. | ||
| + | ; [[Site:API:Blocks|Blocks]] | ||
| + | : this includes support for adding, editing, and deleting blocks. Blocks allow users to prevent other users from viewing certain objects. | ||
; [[Site:API:Comments|Comments]] | ; [[Site:API:Comments|Comments]] | ||
| + | : this includes support for adding, editing, and deleting comments. | ||
| + | ; [[Site:API:Content|Content]] | ||
| + | : this includes support for adding, editing, and deleting content. | ||
; [[Site:API:Forums|Forums]] | ; [[Site:API:Forums|Forums]] | ||
| + | : this includes support for adding, editing, and deleting forums, threads, and replies. | ||
| + | ; [[Site:API:Moderate|Moderate]] | ||
| + | : this includes support for what functionality is available to moderators. | ||
; [[Site:API:PCR|Property Change Requests]] | ; [[Site:API:PCR|Property Change Requests]] | ||
| + | : this includes support for property changes to objects that require approval by an administrator before they go live. | ||
| + | ; [[Site:API:Users|Users]] | ||
| + | : this includes support for adding and editing users. | ||
| + | ; [[Site:API:UserCookieData|User Cookie Data]] | ||
| + | : this includes support for setting and deleting server side cookies. | ||
; [[Site:API:Wysiwyg|Wysiwyg Editor]] | ; [[Site:API:Wysiwyg|Wysiwyg Editor]] | ||
| + | : this includes support for retrieving the built in Wysiwyg Editor. | ||
| + | |||
| + | = Background Tasks = | ||
| + | |||
| + | Metrixstream has a background task manager that is capable of executing tasks at certain intervals. This can be useful for backing up the database, syncing content from one server to another, processing log files, etc. | ||
| + | |||
| + | More information is available on the [[Site:Integration|Integration]] page for those of you who want to create your own tasks. | ||
= Media Player = | = Media Player = | ||
| Line 58: | Line 80: | ||
The Metrixstream media player allows complete customization of the viewing experience. There are several skins available to customize the look and feel of the player. There is also a JavaScript interface that lets you control and manipulate the functionality of the player without having to edit any of the core framework. | The Metrixstream media player allows complete customization of the viewing experience. There are several skins available to customize the look and feel of the player. There is also a JavaScript interface that lets you control and manipulate the functionality of the player without having to edit any of the core framework. | ||
| − | ; [[ | + | ; [[MediaPlayer:Macros|Macros]] |
: Learn how to place a media player within a webpage. | : Learn how to place a media player within a webpage. | ||
| − | ; [[ | + | ; [[MediaPlayer:API:Calls|API Calls]] |
: The functions available to control the media player. | : The functions available to control the media player. | ||
| − | ; [[ | + | ; [[MediaPlayer:API:Callbacks|API Callbacks]] |
: The callbacks that can be registered to intercept certain actions done via the media player. | : The callbacks that can be registered to intercept certain actions done via the media player. | ||
| − | ; [[ | + | ; [[MediaPlayer:LiveEvents|Live Events]] |
: A list of all events available during a live event and how to interact with them. | : A list of all events available during a live event and how to interact with them. | ||
| − | ; [[ | + | ; [[MediaPlayer:Skins|Skins]] |
: A list of available skins for the media player. | : A list of available skins for the media player. | ||
| − | ; [[WMODE|WMODE]] | + | ; [[MediaPlayer:WMODE|WMODE]] |
: An important mode to understand that can effect the media player performance. | : An important mode to understand that can effect the media player performance. | ||
| + | |||
| + | = Custom Integration = | ||
| + | |||
| + | All of the above information is to educate you on how the internals of Metrixstream work and how to use what functionality is available to you. Sometimes you may need customization outside the core platform. This section is intended to go a step lower and see how you can end up making your own queries and tasks. | ||
| + | |||
| + | ; [[Site:Interfaces|Interfaces]] | ||
| + | : Interfaces necessary for custom integration. | ||
| + | ; [[Site:Integration|Integration]] | ||
| + | : Information on how to integrate directly into the Site Engine by providing your own Backend Contexts. | ||
Latest revision as of 21:33, 29 August 2012
Welcome to the Metrixstream development wiki. This guide is intended for a technical audience and will provide detailed information on how interact with Metrixstream and fine tune the user experience to your viewers.
As always you can email support@metrixstream.com with any of your questions.
Contents |
[edit] Site Frontend
- Introduction
- Everything you need to know to get started making sites.
- Building Blocks
- Learn about the tools at your disposal to build your website.
- Organization
- Learn how to organize your objects and feature them in the appropriate places.
- URL Parameters
- Learn how to manipulate a webpage via the URL.
- Faceted Search
- Performing complex searches to find content and profiles.
- Backend Contexts
- Allows you to request information from the backend.
- HDF Objects
- Various objects and what information they contain.
- Internal Macros
- Pre-existing macros provided to help with common tasks.
- SEO Friendly URLS
- Learn how to make SEO friendly URLS.
- Best Practices
- Some simple guidelines on how to make your development easier.
- Controllers
- Properly manage all of your functionality across the entire site.
- Forms
- Different method for how to collect information from the viewer.
- Macros
- Create macros for common functionality.
- Modules
- Package a feature in its entirety within the module framework.
[edit] Site Backend
The backend is responsible for executing queries to the database and returning their result in a format the frontend is capable of understanding.
- Backend Queries
- A list of the supplied backend queries.
[edit] Site API
The API allows modifications to objects through the backend. All API queries are sent through the same URL. It is common to assign this URL to a JavaScript variable that is then passed throughout your code. Make sure to assign this variable in your actual page definition rather than a JavaScript file. This is required because the templating engine is not available in external JavaScript fileds.
var urls = {
'apiUrl': '<?cs call:getBasePostUrl() ?>'
};
- Authentication
- this includes support for login, signup, and logout functionality.
- Blocks
- this includes support for adding, editing, and deleting blocks. Blocks allow users to prevent other users from viewing certain objects.
- Comments
- this includes support for adding, editing, and deleting comments.
- Content
- this includes support for adding, editing, and deleting content.
- Forums
- this includes support for adding, editing, and deleting forums, threads, and replies.
- Moderate
- this includes support for what functionality is available to moderators.
- Property Change Requests
- this includes support for property changes to objects that require approval by an administrator before they go live.
- Users
- this includes support for adding and editing users.
- User Cookie Data
- this includes support for setting and deleting server side cookies.
- Wysiwyg Editor
- this includes support for retrieving the built in Wysiwyg Editor.
[edit] Background Tasks
Metrixstream has a background task manager that is capable of executing tasks at certain intervals. This can be useful for backing up the database, syncing content from one server to another, processing log files, etc.
More information is available on the Integration page for those of you who want to create your own tasks.
[edit] Media Player
The Metrixstream media player allows complete customization of the viewing experience. There are several skins available to customize the look and feel of the player. There is also a JavaScript interface that lets you control and manipulate the functionality of the player without having to edit any of the core framework.
- Macros
- Learn how to place a media player within a webpage.
- API Calls
- The functions available to control the media player.
- API Callbacks
- The callbacks that can be registered to intercept certain actions done via the media player.
- Live Events
- A list of all events available during a live event and how to interact with them.
- Skins
- A list of available skins for the media player.
- WMODE
- An important mode to understand that can effect the media player performance.
[edit] Custom Integration
All of the above information is to educate you on how the internals of Metrixstream work and how to use what functionality is available to you. Sometimes you may need customization outside the core platform. This section is intended to go a step lower and see how you can end up making your own queries and tasks.
- Interfaces
- Interfaces necessary for custom integration.
- Integration
- Information on how to integrate directly into the Site Engine by providing your own Backend Contexts.
