Difference between revisions of "Development Resources/HOWTO/Left Menu"

From Eclipsepedia

Jump to: navigation, search
(New page: ===(1) Using the Infrastructure=== The format and content of the project's pages, including the project home page, is under the sole control of the project's Committers (subject, of course...)
 
(Removed <em> from example code, because they are showing up verbatim and does not work when trying to cut & paste this code)
Line 6: Line 6:
  
 
===PHP Code for Standard Left Menu===
 
===PHP Code for Standard Left Menu===
The PHP to create the single common nav items on the    home page is to include this code before the <code> $App-&gt;generate_page(...)</code> and    before any project-specific $Nav items are added: (note that <em>internalprojectid</em>    is the project's Foundation internal database key, e.g., technology.foobar)
+
The PHP to create the single common nav items on the    home page is to include this code before the <code> $App-&gt;generate_page(...)</code> and    before any project-specific $Nav items are added: (note that <em>internalprojectid</em>    is the project's Foundation internal database key, e.g. <tt>technology.foobar</tt>,
 +
and <em>shortname</em> is the short name of project when accessing from eclipse.org, i.e. <tt>foobar</tt> from www.eclipse.org/foobar)
 
<pre style="border: thin 1px dashed; background-color: ivory;  
 
<pre style="border: thin 1px dashed; background-color: ivory;  
 
padding-top: 2px;  
 
padding-top: 2px;  
Line 12: Line 13:
 
padding-right: 2px;
 
padding-right: 2px;
 
padding-bottom: 2px">$Nav-&gt;setLinkList( array() );
 
padding-bottom: 2px">$Nav-&gt;setLinkList( array() );
$Nav-&gt;addNavSeparator( "<em>Project Name</em>", "/<em>shortname</em>" );
+
$Nav-&gt;addNavSeparator( "Project Name", "/shortname" );
 
$Nav-&gt;addCustomNav( "About This Project",
 
$Nav-&gt;addCustomNav( "About This Project",
     "/projects/project_summary.php?projectid=<em>internalprojectid</em>", "", 1  );</pre>
+
     "/projects/project_summary.php?projectid=internalprojectid", "", 1  );</pre>
 
      
 
      
 
===The Standard Left Menu Item Looks Like This...===
 
===The Standard Left Menu Item Looks Like This...===

Revision as of 13:25, 29 October 2008

(1) Using the Infrastructure

The format and content of the project's pages, including the project home page, is under the sole control of the project's Committers (subject, of course, to common sense about truth, decency, project relevance, security issues, etc.) with two exceptions:

  1. R Each project is required to have a single standard top-of-the-left-nav navigation link to the standard project page for that project so that common information, such as where to find downloads and how to get started with the project, is easily and consistently available for all projects.
  2. R Projects in the Incubation Phase are required to conform to certain labeling, including having an incubation graphic on the home page.

PHP Code for Standard Left Menu

The PHP to create the single common nav items on the home page is to include this code before the $App->generate_page(...) and before any project-specific $Nav items are added: (note that internalprojectid is the project's Foundation internal database key, e.g. technology.foobar, and shortname is the short name of project when accessing from eclipse.org, i.e. foobar from www.eclipse.org/foobar)

$Nav->setLinkList( array() );
$Nav->addNavSeparator( "Project Name", "/shortname" );
$Nav->addCustomNav( "About This Project",
    "/projects/project_summary.php?projectid=internalprojectid", "", 1  );

The Standard Left Menu Item Looks Like This...

Common-left-nav.gif

The "About This Project" is the one standard item. It can be first (preferred) or second (after a "project home page" link). Everything else in the left menu is controlled by the Dash project itself.

The "About This Project" item links to the standard project page for Dash. The standard project pages have the same layout and information for each project making it easy for new users to find information about downloads, newsgroups, committers, project plans, etc.

Standard-project-page-small.gif


This page is moderated by Anne Jacko and Bjorn Freeman-Benson (Eclipse Foundation)