Site:Frontend:Introduction - Revision history

MetrixAdmin: MetrixAdmin moved page Site:Introduction to Site:Frontend:Introduction

2012-07-01T20:24:09Z

MetrixAdmin moved page Site:Introduction to Site:Frontend:Introduction

MetrixAdmin at 20:20, 1 July 2012

2012-07-01T20:20:33Z

MetrixAdmin at 19:47, 1 July 2012

2012-07-01T19:47:28Z

MetrixAdmin: /* Backend */

2012-06-30T23:49:33Z

‎Backend

MetrixAdmin: /* Looking through a list of items */

2011-10-01T23:08:03Z

‎Looking through a list of items

MetrixAdmin: /* Simple conditional logic checks with if/then statements */

2011-10-01T23:07:48Z

‎Simple conditional logic checks with if/then statements

MetrixAdmin: /* Call a built-in macro */

2011-10-01T18:15:22Z

‎Call a built-in macro

MetrixAdmin: /* Properly escape variables using html, javascript, and url escaping */

2011-10-01T18:14:52Z

‎Properly escape variables using html, javascript, and url escaping

MetrixAdmin: /* Clearsilver */

2011-10-01T18:13:20Z

‎Clearsilver

MetrixAdmin: /* HDF */

2011-10-01T18:11:28Z

‎HDF

← Older revision		Revision as of 20:20, 1 July 2012
Line 22:		Line 22:

	Pages also have the ability to specify additional backend contexts, which let you create a modular structure to your page, such as popular videos in the upper right, latest comments in the upper left, and staff favorite content on the rest of the page. That example would be handled by creating a primary context and then two additional contexts.		Pages also have the ability to specify additional backend contexts, which let you create a modular structure to your page, such as popular videos in the upper right, latest comments in the upper left, and staff favorite content on the rest of the page. That example would be handled by creating a primary context and then two additional contexts.
		+
		+	== Frontend ==
		+
		+	The frontend is responsible for choosing what backend queries to use per page and then using the results to generate the page through the Clearsilver templating language.

	== Clearsilver ==		== Clearsilver ==

@@ Line 7: / Line 7: @@
 The backend is responsible for coming up with efficient and scalable database queries so that you can reliably use them as you create your web pages.
-Throughout your site building, you will most likely never be accessing the backend directly. This is all provided for you through a backend context which describes how a backend query should be executed.
+Throughout your site building, you will most likely never be accessing the backend directly. This is all provided for you through a backend context, which describes how a backend query should be executed.
-== Context ==
+== Backend Query ==
-A context is a collection of various backend queries that you have at your disposal to build each site page. Common contexts include "account content", "account profiles", "transaction history", etc.
+A Backend Query is a mechanism that retrieves data from the backend.
-Each page is responsible for specifying a context. A context represents what backend queries is going to be performed.
+== Backend Context ==
-== Additional Context ==
+A Backend Context is a configuration for how a Backend Query should be executed. This configuration commonly includes # of objects, sorting field, ordering method, etc.
-Pages also have the ability to specify additional contexts, which let you create a modular structure to your page, such as popular videos in the upper right, latest comments in the upper left, and staff favorite content on the rest of the page. That example would be handled by creating a primary context and then two additional contexts.
+Each page has the option of specifying a backend context.
 == Clearsilver ==

@@ Line 7: / Line 7: @@
 The backend is responsible for coming up with efficient and scalable database queries so that you can reliably use them as you create your web pages.
-Throughout your site building, you will most likely never be accessing the backend directly. This is all provided for you through a context.
+Throughout your site building, you will most likely never be accessing the backend directly. This is all provided for you through a backend context which describes how a backend query should be executed.
 == Context ==

@@ Line 41: / Line 41: @@
   <?cs /if ?>
-=== Looking through a list of items ===
+=== Looping through a list of items ===
   <?cs each:item = MS.content.items ?>

@@ Line 40: / Line 40: @@
     Please login!
   <?cs /if ?>
 === Properly escape variables using html, javascript, and url escaping ===

@@ Line 52: / Line 52: @@
   <a href="http://www.test.com/?user=<?cs var:url_escape(MS.site.user.username) ?>">click here to go to your public profile page</a></nowiki>
-=== Call a built-in macro ===
+=== Use a built-in macro ===
   <img src="<?cs call:getStaticUrl("logo.jpg") ?>" />

@@ Line 49: / Line 49: @@
   <input type="text" name="username" value="<?cs var:html_escape(MS.site.user.username) ?>">
-  <a href="http://www.test.com/?user=<?cs var:url_escape(MS.site.user.username) ?>">click here to go to your public profile page</a>
+ <nowiki>
 === Call a built-in macro ===

@@ Line 29: / Line 29: @@
 In general Clearsilver allows you to do the following:
-===Output a variable from the HTML to the actual page===
+=== Output a variable from the HTML to the actual page ===
   Hey <?cs var:MS.site.user.username ?>, welcome back to our site!
-===Simple conditional logic checks with if/then statements===
+=== Simple conditional logic checks with if/then statements ===
   <?cs if:MS.site.user.loggedIn ?>
@@ Line 41: / Line 41: @@
   <?cs /if ?>
-===Properly escape variables using html, javascript, and url escaping===
+=== Properly escape variables using html, javascript, and url escaping ===
   <script type="text/javascript">
@@ Line 50: / Line 50: @@
   <a href="http://www.test.com/?user=<?cs var:url_escape(MS.site.user.username) ?>">click here to go to your public profile page</a>
 Detailed documentation of the Clearsilver language is available here: http://www.clearsilver.net/docs/

@@ Line 57: / Line 57: @@
 The HDF is simply a term of a list of key-value pairs. This usually consists of content titles, player urls, image urls, user information, etc. The job of each page is to reference the HDF object through Clearsilver the template is to reference the HDF keys, so you can output the HDF values.
-=== Example ===
+If you aren't sure what fields are available, add the hdf parameter to the end of your site URL. (Example: http://www.test.com/?hdf) It will output all the available HDF keys.
-−
-−
-If you are unable to create the page you want, then you either aren't using the right context, or you need a custom extension to add additional fields to the HDF. Contact [mailto:support@metrixstream.com support@metrixstream.com] for a quick consultation on how to accomplish what you want.
-−
-If you ever aren't sure what fields are available, add &hdf to the end of your site URL. It will output all the available HDF keys.