Development

sfBreadNav (diff)

You must first sign up to be able to contribute.

Changes from Version 1 of sfBreadNav

Show
Ignore:
Author:
jarro (IP: 64.26.147.214)
Timestamp:
04/24/08 17:33:16 (9 years ago)
Comment:

v1

Legend:

Unmodified
Added
Removed
Modified
  • sfBreadNav

    v0 v1  
     1= sfBreadNav 1.0.4   April 24, 2008 = 
     2 
     3A very basic navigation system for Symfony 1.1 templates.   
     4This is a lightweight alternative for when you just want a quick way to add navigation to a site or prototype.   
     5 
     6Allows the mangagment of a navigational tree for the purpose of generating a bread crumb and credential controlled menu. 
     7 
     8Drop down menu is css based for search engine compatibility and easy customization.  Includes ie hacks for ie5.5 and ie6  
     9== Requirements == 
     10 
     11Symfony 1.1 
     12 
     13sfPropelActAsNestedSetPlugin 
     14http://trac.symfony-project.com/wiki/sfPropelActAsNestedSetBehaviorPlugin 
     15 
     16sfGuardPlugin  
     17http://trac.symfony-project.com/wiki/sfGuardPluginFor11 
     18 
     19== Installation == 
     20 
     21Install plugin 
     22{{{ 
     23$ php symfony plugin:install http://plugins.symfony-project.com/sfBreadNav 
     24 
     25$ php symfony propel:build-all 
     26 
     27$ php symfony cc 
     28}}} 
     29 
     30If your going to use the Menu generator ensure that the web assets were copied to the web directory 
     31These are just the css files for the nav bar. 
     32 
     33== Configuration == 
     34 
     35 
     36-Setting up admin panel. 
     37 
     38In your backend add sfBreadNavAdmin module to your settings.yml 
     39 
     40Example 
     41{{{ 
     42all: 
     43  .settings: 
     44    enabled_modules:        [default, sfGuardGroup, sfGuardUser, sfGuardPermission, sfBreadNavAdmin] 
     45}}} 
     46 
     47http://localhost/backend.php/sfBreadNavAdmin 
     48 
     49Each node requires  a name, module and action. Credential is optional. 
     50 
     51To simply hide a menu button for people not logged in set the credential to authenticated. 
     52Credentials do not cascade so you can apply them to nodes individually and orphaned nodes will propogate up. 
     53 
     54-Setting up bread crumb 
     55 
     56add the following line to your template body.   
     57{{{ 
     58<?php include_partial('sfBreadNav/breadcrumb') ?> 
     59}}} 
     60 
     61-Setting up the navigation menu 
     62 
     63Add the following to your template body. 
     64{{{ 
     65<?php include_partial('sfBreadNav/navmenu') ?> 
     66}}} 
     67Add the following to your template head. 
     68{{{ 
     69<link rel="stylesheet" type="text/css" media="screen" href="/css/menuh.css" /> 
     70<?php include_partial('sfBreadNav/iehack') ?> 
     71}}} 
     72 
     73== To Do == 
     74 
     75-high priority 
     76Enable caching of menu and breadcrumb.  Will attempt as soon as the 1.1 cache documentation is updated. 
     77 
     78 
     79-medium priority  
     80Enable I8ln 
     81 
     82-low priority 
     83Multiple menu trees.  To allow seperate menus for frontend and backend etc. 
     84Improve the default css menu theme, improve the admin theme. 
     85 
     86   
     87== License == 
     88 
     89LGPL   
     90-Author:   
     91Jarred Freeman