Toolbar API - Revision history

Patricia Schmidt: /* Add an Extra Menu into an Exisiting JomSocial Toolbar */

2013-03-09T05:31:08Z

‎Add an Extra Menu into an Exisiting JomSocial Toolbar

Patricia Schmidt: /* Adding New Toolbar and Toolbar Menu Items */

2013-03-09T05:30:49Z

‎Adding New Toolbar and Toolbar Menu Items

Patricia Schmidt: /* Calling the CToolbar API */

2013-03-08T01:32:37Z

‎Calling the CToolbar API

Patricia Schmidt: /* Utilizing onSystemStart */

2013-03-08T01:31:23Z

‎Utilizing onSystemStart

Patricia Schmidt: /* Removing Core Menu Group / Items from JomSocial Toolbar */

2013-03-08T00:45:26Z

‎Removing Core Menu Group / Items from JomSocial Toolbar

Patricia Schmidt: /* Removing Core Menu Group / Items from JomSocial Toolbar */

2013-03-08T00:43:57Z

‎Removing Core Menu Group / Items from JomSocial Toolbar

Patricia Schmidt: /* Removing Core Menu Group / Items from JomSocial Toolbar */

2013-03-08T00:42:32Z

‎Removing Core Menu Group / Items from JomSocial Toolbar

Patricia Schmidt: /* Removing core menu group or core menu items from JomSocial toolbar */

2013-03-08T00:41:53Z

‎Removing core menu group or core menu items from JomSocial toolbar

Patricia Schmidt: /* Add extra menu into exisiting JomSocial toolbar */

2013-03-07T23:23:21Z

‎Add extra menu into exisiting JomSocial toolbar

Patricia Schmidt: /* Adding new 'toolbar' and toolbar's menu items */

2013-03-07T23:18:07Z

‎Adding new 'toolbar' and toolbar's menu items

@@ Line 226: / Line 226: @@
 Calling the same method addItem, you have now added the '''Logout''' menu item.
-[[File:Ctoolbar image02.jpg]]
+::: [[File:Ctoolbar image02.jpg]]
 ===Removing Core Menu Group / Items from JomSocial Toolbar===

@@ Line 194: / Line 194: @@
 </syntaxhighlight>
 <br />
-[[File:Ctoolbar image01.jpg]]
+::: [[File:Ctoolbar image01.jpg]]
 Above is the example of a JomSocial custom toolbar menu '''MyBlog'''.

@@ Line 64: / Line 64: @@
   */
 function addGroup($key, $caption='', $link=''){}
 /**
@@ Line 71: / Line 70: @@
   */
 function removeGroup($key){}
 /**
@@ Line 86: / Line 82: @@
   */
 function addItem($groupKey, $itemKey, $caption='', $link='', $order='append', $isScriptCall=false, $hasSeparator=false){}
 /**
@@ Line 96: / Line 89: @@
   */
 function removeItem($groupKey, $itemKey){}
 /**
@@ Line 107: / Line 97: @@
   */
 function getMenuItems($groupKey, $order){}
 /**
@@ Line 116: / Line 103: @@
   */
 function getExtraToolbars(){}
 /**
@@ Line 126: / Line 110: @@
   */
 function getToolbarItems($groupKey){}
 /**
@@ Line 136: / Line 117: @@
   */
 function hasToolBarGroup($groupKey){}
 /**
@@ Line 146: / Line 124: @@
   */
 function getActiveToolBarGroup($uri){}
 /**
@@ Line 155: / Line 130: @@
   */
 function getToolBarGroupKey(){}
 /**
@@ Line 165: / Line 137: @@
   */
 function getGroupActiveView($viewName){}
 /**

@@ Line 4: / Line 4: @@
 ===Utilizing onSystemStart===
-The toolbar API will only work in any of your plugins through [[onSystemStart|onSystemStart]] function. In JomSocial, every page will first execute this [[onSystemStart|onSystemStart]] trigger. Therefore, calling this toolbar API in onSystemStart will ease the creation of custom toolbars in JomSocial.
+The '''Toolbar API''' will only work in your plugins through [[onSystemStart|onSystemStart]] function. In JomSocial, every page will first execute this [[onSystemStart|onSystemStart]] trigger. Therefore, calling this '''Toolbar API''' in onSystemStart will ease the creation of custom toolbars in JomSocial.
 <syntaxhighlight lang="php">
 function onSystemStart()

@@ Line 260: / Line 260: @@
 ===Removing Core Menu Group / Items from JomSocial Toolbar===
-CToolbar library actually allow you to remove any core menu items or even removing the core menu group completely from showing. To remove a core menu group from the JomSocial toolbar, we use the function removeGroup().
+The CToolbar library actually allows you to remove any core menu items or even remove the core menu group completely. To remove a core menu group from the JomSocial toolbar, we use the function removeGroup().
 <syntaxhighlight lang="php">
 $toolbar->removeGroup(TOOLBAR_INBOX);

@@ Line 270: / Line 270: @@
 </syntaxhighlight>
 <br />
-Here is the key string that used in JomSocial toolbar menu items.
+Here are the key strings that are used in the JomSocial toolbar menu items:
 <syntaxhighlight lang="php">
 Profile
-'PROFILE_AVATAR'       - Change profile picture
+'PROFILE_AVATAR'       - Change Profile Picture
 'PROFILE_EDIT_PROFILE' - Edit Profile
 'PROFILE_EDIT_DETAILS' - Edit Details
@@ Line 281: / Line 281: @@
 Friends
-'FRIEND_SHOW_ALL_FRIENDS'       - Show all
+'FRIEND_SHOW_ALL_FRIENDS'       - Show All
 'FRIEND_SEARCH_FRIENDS'         - Search
 'FRIEND_ADVANCE_SEARCH_FRIENDS' - Advanced Search
 'FRIEND_INVITE_FRIENDS'         - Invite Friends
-'FRIEND_REQUEST_SENT'           - Request sent
+'FRIEND_REQUEST_SENT'           - Request Sent
-'FRIEND_PENDING_APPROVAL'       - Pending my approval
+'FRIEND_PENDING_APPROVAL'       - Pending My Approval
 Application

@@ Line 259: / Line 259: @@
 [[File:Ctoolbar image02.jpg]]
-===Removing core menu group or core menu items from JomSocial toolbar===
+===Removing Core Menu Group / Items from JomSocial Toolbar===
-Ctoolbar library actually allow you to remove any core menu items or even removing the core menu group completely from showing. To remove a core menu group from JomSocial toolbar, we use function removeGroup().
+Ctoolbar library actually allow you to remove any core menu items or even removing the core menu group completely from showing. To remove a core menu group from the JomSocial toolbar, we use the function removeGroup().
 <syntaxhighlight lang="php">
 $toolbar->removeGroup(TOOLBAR_INBOX);
 </syntaxhighlight>
 <br />
-If you just want to remove one or some of the core menu items, then you should use this function removeItem() instead. By giving the correct menu group key and menu item key, you can remove any of the core menu items from JomSocial.
+If you want to remove one or more of the core menu items, then you should use this function removeItem() instead. By giving the correct '''Menu Group Key''' and '''Menu Item Key''', you can remove any of the core menu items from JomSocial.
 <syntaxhighlight lang="php">
 $toolbar->removeItem(TOOLBAR_INBOX, 'INBOX_INBOX');

@@ Line 229: / Line 229: @@
 Above is the example of a JomSocial custom toolbar menu '''MyBlog'''.
-===Add extra menu into exisiting JomSocial toolbar ===
+===Add an Extra Menu into an Exisiting JomSocial Toolbar ===
-In some circumstances, we need to add extra menu items into JomSocial existing toolbar menu. CToolbar allow you to achieve that. Below is the existing constant / predefined toolbars that are available by default.
+In some circumstances, we need to add extra menu items into the existing JomSocial toolbar menu. CToolbar allows you to achieve that. Below are the existing constant / predefined toolbars that are available by default.
 <syntaxhighlight lang="php">
 TOOLBAR_HOME	- Home toolbar
@@ Line 239: / Line 239: @@
 </syntaxhighlight>
 <br />
-The example below will demonstrate how you add 'Logout' menu item into 'Home' toolbar.
+The example below demonstrates how you add a '''Logout''' menu item to the '''Home''' toolbar.
 <syntaxhighlight lang="php">
 function onSystemStart()
@@ Line 255: / Line 255: @@
 </syntaxhighlight>
 <br />
-Calling the same method addItem, you now added the 'Logout' menu item.
+Calling the same method addItem, you have now added the '''Logout''' menu item.
 [[File:Ctoolbar image02.jpg]]

@@ Line 178: / Line 178: @@
 <br />
-===Adding new 'toolbar' and toolbar's menu items ===
+===Adding New Toolbar and Toolbar Menu Items===
-Below statement is how we can add new toolbar, or, preferable 'tab', into jomsocial.
+We can add a new toolbar or '''tab''' into JomSocial in the following manner:
 <syntaxhighlight lang="php">
 $toolbar->addGroup('MYBLOG', 'MyBlog', JRoute::_('index.php?option=com_myblog&task=adminhome&Itemid='.$myblogItemId));
@@ Line 185: / Line 185: @@
 <br />
-Here is the function defination of addGroup:
+Here is the function definition of addGroup:
 <syntaxhighlight lang="php">
 function addGroup($key, $caption='', $link=''){}
@@ Line 194: / Line 194: @@
 </syntaxhighlight>
 <br />
-If your menu link is point to outside of JomSocial, you should use JRoute::_() instead of CRoute::_(). Also, you must add the group follow by the group's items otherwise all your item will not be shown in JomSocial toolbar menu.
+If your menu link is pointing outside of JomSocial, you should use JRoute::_() instead of CRoute::_(). Also, you must add the group followed by the group's items; otherwise, all your items will not be shown in the JomSocial toolbar menu.
 <syntaxhighlight lang="php">
 $toolbar->addItem('MYBLOG', 'MYBLOG_VIEW', 'View Your Blog',
@@ Line 203: / Line 203: @@
 </syntaxhighlight>
 <br />
-Above is how you add menu items into your own toolbar tab. addItem works almost the same as addGroup but with few extra parameters with the following order.
+The above is how you add menu items into your own toolbar tab. addItem works almost the same as addGroup, but with a few extra parameters in the following order:
 <syntaxhighlight lang="php">
@@ Line 213: / Line 213: @@
 $link         - The url link.
 $order	      - The order of the menu item. Possible value ( 'prepend','append' ). Default is 'append'
-$isScriptCall - To indicate whether this is a javascript function or is a anchor link.
+$isScriptCall - To indicate whether this is a JavaScript function or is a anchor link.
 $hasSeparator - To indicate whether this item should use the class 'seperator' from JomSocial.
 </syntaxhighlight>
 <br />
-Below is the example on how you can call a javascript function from the link.
+Below is an example on how you can call a JavaScript function from the link:
 <syntaxhighlight lang="php">
 $writeUrl	= 'myAzrulShowWindow(\''.JURI::root().'index.php?option=com_myblog'
@@ Line 227: / Line 227: @@
 [[File:Ctoolbar image01.jpg]]
-Above is the example of JomSocial custom toolbar menu 'MyBlog'.
+Above is the example of a JomSocial custom toolbar menu '''MyBlog'''.
 ===Add extra menu into exisiting JomSocial toolbar ===