User Tools
tutorials:development:hello_world_page
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
tutorials:development:hello_world_page [2009/01/13 17:25] jonyo created |
tutorials:development:hello_world_page [2014/09/25 16:55] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Hello World using Addon Page ====== | ====== Hello World using Addon Page ====== | ||
| - | This tutorial will walk you through the steps for creating an addon that will replace the **(!MAINBODY!)** (or **{body_html}** | + | This tutorial will walk you through the steps for creating an addon that will replace the **{body_html}** of a template with the text **Hello World**. |
| If you need your addon to display it's own page, use this tutorial as a starting point. | If you need your addon to display it's own page, use this tutorial as a starting point. | ||
| - | **Requires Geo 4.0 or higher.** The following is not possible in Geo 3.1 and earlier, because the functionality for an addon to display it's own page was added to the addon system in 4.0. | + | **Requires Geo 4.0.0** |
| + | |||
| + | The following is not possible in Geo 3.1 and earlier, because the functionality for an addon to display it's own page was added to the addon system in 4.0. | ||
| - In the **addons/** directory, create a new directory named " | - In the **addons/** directory, create a new directory named " | ||
| Line 13: | Line 15: | ||
| //file / | //file / | ||
| - | class addon_hello_world_info { | + | class addon_hello_world_info |
| - | var $name = ' | + | { |
| - | var $version = ' | + | public |
| - | var $title = 'Hello World'; | + | public |
| - | var $author = "Hello World, Inc."; | + | public |
| - | var $description = ' | + | public |
| - | var $auth_tag = ' | + | public |
| - | var $pages = array ( | + | public |
| + | public | ||
| ' | ' | ||
| ); | ); | ||
| Line 29: | Line 32: | ||
| //file: / | //file: / | ||
| - | class addon_hello_world_pages { | + | class addon_hello_world_pages |
| - | function hello_world_page(){ | + | { |
| + | public | ||
| + | { | ||
| //Note: The method name matches the page name used in the $pages var in info.php | //Note: The method name matches the page name used in the $pages var in info.php | ||
| return "Hello World!"; | return "Hello World!"; | ||
| Line 37: | Line 42: | ||
| - Now, go into addon management at [[admin_menu/ | - Now, go into addon management at [[admin_menu/ | ||
| - There should now be a link for **Edit Page** for the Hello World addon. | - There should now be a link for **Edit Page** for the Hello World addon. | ||
| - | - On this page, select what template you want to use for your page, one template for every language you have defined, and save the changes. | + | - On this page, select what template you want to use for your page, one template for every language you have defined, and save the changes. |
| - While still on the page, look for the **Link to Page**. | - While still on the page, look for the **Link to Page**. | ||
| - | This isn't the limit of what addons can do, to see everything addons can do get the example addon (should be a free addon in the client area). It demonstrates the use of tags, along with all of the other current abilities of addons. Plus, as long as you make your addon name unique enough (the addon' | + | This isn't the limit of what addons can do, to see everything addons can do get the example addon (should be a free addon in the client area). It further |
| ===== Alternate Page Display Methods ===== | ===== Alternate Page Display Methods ===== | ||
| You are not limited to returning the text you want to be displayed on the page, below are some alternate things you can do. | You are not limited to returning the text you want to be displayed on the page, below are some alternate things you can do. | ||
| - | |||
| ==== Display the Entire Page Yourself ==== | ==== Display the Entire Page Yourself ==== | ||
| - | At the time the method is called in the pages.php file, nothing is displayed on the page yet, even if cache is turned on or if using [[admin_menu/ | + | At the time the method is called in the pages.php file, nothing is displayed on the page yet, even if cache is turned on. This means, if you wanted to you could display the entire page yourself, by doing something like this for your **pages.php** file: |
| <code php> | <code php> | ||
| Line 56: | Line 60: | ||
| // | // | ||
| - | class addon_hello_world_pages { | + | class addon_hello_world_pages |
| - | function hello_world_page(){ | + | { |
| + | public | ||
| + | { | ||
| //Note: The method name matches the page name used in the $pages var in info.php | //Note: The method name matches the page name used in the $pages var in info.php | ||
| ?> | ?> | ||
| Line 77: | Line 83: | ||
| }</ | }</ | ||
| - | When you use this method, you do not need to worry about setting the template for the page as described in **step | + | When you use this method, you do not need to worry about setting the template for the page as described in **step |
| ==== Use Smarty Templates (Recommended) ==== | ==== Use Smarty Templates (Recommended) ==== | ||
| Line 99: | Line 105: | ||
| //extend our info class, so we can use $this-> to access vars in it | //extend our info class, so we can use $this-> to access vars in it | ||
| - | class addon_hello_world_pages extends addon_hello_world_info { | + | class addon_hello_world_pages extends addon_hello_world_info |
| + | { | ||
| - | function hello_world_page(){ | + | public |
| + | { | ||
| //Note: The method name matches the page name used in the $pages var in info.php | //Note: The method name matches the page name used in the $pages var in info.php | ||
| //First, get instance of the view class | //First, get instance of the view class | ||
| Line 116: | Line 124: | ||
| } | } | ||
| }</ | }</ | ||
| + | - Follow **step 7** from the original instructions above, to view your page. If everything is working correctly, you should see the "Hello World!" | ||
tutorials/development/hello_world_page.1231867525.txt.gz · Last modified: 2014/09/25 16:55 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
