Administration
Project Navigation Standards
 |
 |
 |
 |
Contents |
 |
 |
 |
 |
Editing Navigation
The left hand navigation menu is edited by editing the "Navigation" page of a space. The easiest way to see the Navigation page is to type it in the URL for the page name in your space i.e.
https://cagrid.org/diplay/SPACEKEY/Navigation
. You can also see it by viewing the site map for your space.
Once you on the Navigation page, Edit the page. Use the following wiki markup as a guide for navigation:
{navtable}
{navtablerow}h2. [Notation|Notation Home]{navtablerow}
{navtablerow}
{menubar:id=notation|vertical=true|class=cagrid}
{menuitem}[Spaces and Children]{menuitem}
{menuitem}[Creating Spaces]{menuitem}
{menuitem}[Creating Pages]{menuitem}
{menuitem}[Using Wiki Markup]{menuitem}
{menuitem}[Notation Standards]{menuitem}
{menuitem}[User Macros]{menuitem}
{menuitem}[Navigation Menu]{menuitem}
{menuitem}[Export to PDF]{menuitem}
{menuitem}[Tips and Tricks]{menuitem}
{menubar}
{navtablerow}
{navtable}
This produces the navigation menu (for this Notation space only) that you see to the left.
Begin the navigation with {navtable}. The next line, {navtablerow}h2. [Link]{navtablerow} will be your heading for your navigation menu. The [Link] should be named the title of your space and point to an Overview page or home page for the space. On the next line {navtablerow} starts a new line. Next, {menubar:id=space name||vertial=true|classs=cagri} will start a vertical menu with an id set to your space name. 'Class" should always be set to "cagrid" to uphold cagrid notation standards and format (text, color).
Now that the menu has been set up, we can begin to insert the actual menu items. Here, {menuitem} indicates a new menu item. The [Link] contains the text for the menu item and points to the indicated page. These links work like any other, so different titles may be given to the links if desired i.e. [How to use wiki markup|Using wiki markup]. Once the desire menu item is inserted, be sure to close the macro with another {menuitem}.
Menus can also be used within the navigation menu. Here is an example:
{navtable}
{navtablerow}h2. [Federated Query Processor|fqp:Home]{navtablerow}
{navtablerow}
{menubar:id=fqp|vertical=true|class=cagrid}
{menuitem}[Overview|Overview]{menuitem}
{menuitem}[Project Status|Project Status]{menuitem}
{menu}[Downloads|Downloads]
{menuitem}[1.3|fqp13:Downloads]{menuitem}
{menuitem}[1.2|fqp12:Downloads]{menuitem}
{menu}
{menuitem}[Publications|Publications]{menuitem}
{menuitem}[Team|Team]{menuitem}
{menuitem}[Support|Support]{menuitem}
{menubar}
{navtablerow}
{navtable}
After the menu item, "Project Status", there is {menu} for "Downloads". This produces a horizontal pop out menu which then lists its own menu items, "1.3" and "1.2". This is followed by {menu} to close the macro and then continues with the other menu items for the navigation panel.
It is also possible to have a sub-menu within a menu. Here is an example:
{navtable}
{navtablerow}h2. [Federated Query Processor|fqp:Home]{navtablerow}
{navtablerow}
{menubar:id=fqp|vertical=true|class=cagrid}
{menuitem}[Overview|Overview]{menuitem}
{menuitem}[Project Status|Project Status]{menuitem}
{menu}[Documentation|Documentation]
{menuitem}[Administrators Guide|fqp13:Administrators Guide]{menuitem}
{menuitem}[Developers Guide|fqp13:Developers Guide]{menuitem}
{menuitem}[Design Guide|fqp13:Design Guide]{menuitem}
{submenu}[Federated Query Processor 1.2|fqp12:Documentation]
{menuitem}[Administrators Guide|fqp12:Administrators Guide]{menuitem}
{menuitem}[Developers Guide|fqp12:Developers Guide]{menuitem}
{menuitem}[Design Guide|fqp12:Design Guide]{menuitem}
{menuitem}[Distributed Common Query Language|fqp12:DCQL]{menuitem}
{submenu}
{menu}
{menu}[Downloads|Downloads]
{menuitem}[1.3|fqp13:Downloads]{menuitem}
{menuitem}[1.2|fqp12:Downloads]{menuitem}
{menu}
{menuitem}[Publications|Publications]{menuitem}
{menuitem}[Team|Team]{menuitem}
{menuitem}[Support|Support]{menuitem}
{menubar}
{navtablerow}
{navtable}
Notice how within the {menu} for "Documentation" there is a lit of {menuitem} and then a {submenu}. This {submenu} has "Federated Query Processor 1.2." as the menu item for the "Documentation" menu and then creates another horizontal pop-out menu with "Administrators Guide", "Developers Guide", "Design Guide", and "Distributed Common Query Language" as menu items. The {submenu} is then closed and then the {menu} is closed. The navigation then continues with another "Downloads" menu which was described previously.
Order of navigation items
First link in the navigation table should be the title of the space/project (e.g., Dorian) that is an active link directly to the project overview. For simplicity we will use the Dorian project as an example.
Dorian --> Link to dorian:Home. (In other projects, the Home page is sometimes is just an {include:projectspace:Overview})
- Overview --> Link to dorian:Overview. If the Overview is the same as the Home page, then this doesn't need to be in the navigation. For Dorian, the Home page and Overview page are different and therefore both are included in the navigation.
- Documentation --> Links to dorian:Documentation and is also a menu (This documentation page is just {include:dorian14:Documentation} so that it includes the content for the latest version.)
- Under the Documentation menu, there are menuitems that are links to current documentation (e.g., Dorian 1.4 Users Guide, Dorian 1.4 Administrators Guide)
- Also under the Documentation menu, there is a Previous versions submenu with:
- caGrid 1.2, caGrid 1.3 sub-submenus with links to documentation for their respective versions
- Downloads --> Link to dorian:Downloads, which uses a {include:dorian14:Downloads} to show the latest version.
- Publications (Optional)
- Team
- For caGrid Projects (marked with the caGrid logo) the team page should include the caGrid Devolopment Team page: {include:community:caGrid Development Team}
- Support (Only for non-core projects. Non-core projects should have this to reference outside contacts for support of the service. Core projects will have the Support space.