History: Directory Details

Source of version: 5 (current)

^This page ((needs review))^
! Directory Details

!! Modules
|| __Module Name__ | __Module Title (English)__ | __Description__ 
directory_last_sites | Last Sites | sites most recently added
directory_top_sites | Top Sites | most-visited sites
directory_stats | Directory Stats | numbers of sites, sites to validate, site categories, searches, and visited links 
since_last_visit | Since your last visit | New sites are included along with other Tiki additions
since_last_visit_new | Since your last visit| ::":: || 

!! Permissions
|| __Permission Name__ | __Description__ | __Default Level__
tiki_p_admin_directory | Can admin the directory | editors
tiki_p_admin_directory_cats | Can admin directory categories | editors
tiki_p_admin_directory_sites | Can admin directory sites | editors
tiki_p_autosubmit_link | Submited links are valid | editors
tiki_p_submit_link | Can submit sites to the directory | basic
tiki_p_validate_links | Can validate submitted links | editors
tiki_p_view_directory | Can use the directory | basic ||

!! Preferences
|| __Preference Item (en)__ | __Pref name in tiki_preferences table__ | __Default value__ | 
Number of columns per page when listing categories | directory_columns | 3
Links per page | directory_links_per_page | 20  
Method to open directory links | directory_open_links | n  
Validate URLs | directory_validate_urls | n  
Enable cool sites | directory_cool_sites | y 
Feature - Directory | feature_directory | n ||

!! Database Tables
|| __Table Name__ | __Columns__ | __Description__ 
tiki_directory_categories | categId%%% parent%%% name%%% description%%% childrenType%%% sites%%% viewableChildren%%% allowSites%%% showCount%%% editorGroup%%%   hits%%% | Directory category information as set by configuration, and accumulated
tiki_directory_search | term%%% hits%%% | Search terms used and number of hits
tiki_directory_sites | siteId%%% name%%% description%%% url%%%  country%%% hits%%% isValid%%% created%%% lastModif%%% cache%%% cache_timestamp%%% |Directory link information as submitted in new site addition, and accumulated 
tiki_category_sites | categId%%%siteId | Category to directory link information
Directory-related information is also stored in tiki_preferences and tiki_permissions (see above), tiki_live_support_modules, tiki_menu_options and users_permissions tables.||

!! Files Used
|| __File Name__ | __Location__ | __Description/Purpose__ 
tiki-admin_include_directory.php | / | Admin Directory page (tiki-admin.php?page=directory)
tiki-directories_rss.php | / | Displays Directory RSS Feed
tiki-directory_add_site.php | / | Site submit form
tiki-directory_add_tiki_site.php | / | Specifically for adding a TIki site (but how is this accessed/used?)
tiki-directory_admin.php | / | Directory Administration page
tiki-directory_admin_categories.php | / | Admin directory categories page
tiki-directory_admin_related.php | / | Admin related categories page
tiki-directory_admin_sites.php | / | Admin sites page
tiki-directory_browse.php | / | Browse Directory page
tiki-directory_ranking.php | / | Directory ranking page
tiki-directory_redirect.php | / | Redirects link request to external site
tiki-directory_rss.php | / | Displays specific Directory RSS feed
tiki-directory_search.php | / | Displays search results
tiki-directory_validate_sites.php | / | Validate sites (by admin or editor)
mod-directory_last_sites.php | /modules | Displays sites most recently added, in module
mod-directory_stats.php | /modules | Displays Directory stats in a module
mod-directory_top_sites.php | /modules | Displays most-visited sites in a module
mod-since_last_visit.php | /modules | Displays Tiki site additions since user's last visit
mod-since_last_visit_new.php | /modules | Displays Tiki site additions since user's last visit
tiki-admin-include-directory.tpl | /templates | (tiki-admin.php?page=directory) Directory config 
tiki-directory_add_site.tpl | /templates | Layout for Admin sites page
tiki-directory_admin.tpl | /templates | Layout for Admin sites page
tiki-directory_admin_bar.tpl | /templates | Layout for Admin navbar
tiki-directory_admin_categories.tpl | /templates | Layout for Admin sites page
tiki-directory_admin_related.tpl | /templates | Layout for Admin sites page
tiki-directory_admin_sites.tpl | /templates | Layout for Admin sites page
tiki-directory_bar.tpl | /templates | Layout for navbar
tiki-directory_browse.tpl | /templates | Layout for Browse Directory page
tiki-directory_footer.tpl | /templates | Layout for page-bottom stats
tiki-directory_ranking.tpl | /templates | Layout for Directory ranking page
tiki-directory_search.tpl | /templates | Layout for Search Results page
tiki-directory_validate_sites.tpl | /templates | Layout for Admin sites page
mod-directory_last_sites.tpl | /templates/modules  | Layout for Last sites module
mod-directory_stats.tpl | /templates/modules | Layout for Directory stats module 
mod-directory_top_sites.tpl | /templates/modules | Layout for Top Sites module  
mod-since_last_visit.tpl | /templates/modules | Layout for Since your last visit module  
mod-since_last_visit2.tpl | /templates/modules | Layout for Since your last visit2 module 
tiki-calendar.php | / | Calendar also can display Directory link additions.
tiki-calendar.tpl |  /templates | Layout for Tiki Calendar  
::In general, the .php files supply the logic, the .tpl files the layout.::|| 

!! CSS Selectors
||__Selector__|__Applies to/%%%description__|__Template file__|__Page file__ 
a.pagetitle | page title | tiki-directory_browse.tpl%%% tiki-directory_ranking.tpl%%%  tiki-directory_search.tpl%%% tiki-directory_validate_sites.tpl%%% tiki-directory_add_site.tpl%%% tiki-directory_admin.tpl%%% tiki-directory_admin_categories.tpl%%% tiki-directory_admin_related.tpl | (The page the selector is used on is a php file with same name as the respective template except as indicated below.)
div#pageheader |breadcrumbs | tiki-directory_browse.tpl |  
a.dirlink | category path links%%% related-category path links | tiki-directory_browse.tpl |
div.dircategs |  table containing subcategories |  tiki-directory_browse.tpl | 
a.dirsublink |  subcategory links |  tiki-directory_browse.tpl%%%  tiki-directory_search.tpl |
div.dirlistsites |  list of site links |  tiki-directory_browse.tpl%%%  tiki-directory_search.tpl |
div.dirsite |  individual site information | tiki-directory_browse.tpl%%%  tiki-directory_search.tpl |
a.dirsitelink | link | tiki-directory_browse.tpl |
span.dirsitedesc | site description | tiki-directory_browse.tpl%%% tiki-directory_search.tpl |
span.dirsitecats | site category | tiki-directory_browse.tpl%%% tiki-directory_search.tpl |
span.dirsitetrail | Added, updated, hits, etc. info | tiki-directory_browse.tpl%%%  tiki-directory_search.tpl | 
div.mini | Page number, prev, next links | tiki-directory_browse.tpl%%% tiki-directory_search.tpl %%% tiki-directory_ranking.tpl %%% tiki-directory_validate_sites.tpl%%% tiki-directory_admin_categories.tpl%%% tiki-directory_admin_related.tpl |
a.prevnext | Page number, prev, next page links | tiki-directory_browse.tpl %%% tiki-directory_search.tpl%%% tiki-directory_ranking.tpl%%% tiki-directory_validate_sites.tpl%%% tiki-directory_admin_categories.tpl%%% tiki-directory_admin_related.tpl |
div.dirrelated | Related categories info |  tiki-directory_browse.tpl |
div#page-bar | navigation bar | tiki-directory_bar.tpl%%% %%% %%% %%% %%% tiki-directory_admin_bar.tpl | tiki-directory_browse.php %%% tiki-directory_search.php %%% tiki-directory_ranking.php %%% tiki-directory_add_site.php %%% %%% tiki-directory_admin.php %%% tiki-directory_admin_categories.php %%% tiki-directory_admin_related.php %%% tiki-directory_admin_sites.php %%% tiki-directory_validate_sites.php 
div.button2 |  navbar item | tiki-directory_bar.tpl%%% %%% %%% %%% %%% tiki-directory_admin_bar.tpl | tiki-directory_browse.php %%% tiki-directory_search.php %%% tiki-directory_ranking.php %%% tiki-directory_add_site.php %%% %%%  tiki-directory_admin.php %%% tiki-directory_admin_categories.php %%% tiki-directory_admin_related.php %%% tiki-directory_admin_sites.php %%% tiki-directory_validate_sites.php 
a.linkbut |  navbar link | tiki-directory_bar.tpl%%% %%% %%% %%% %%% tiki-directory_admin_bar.tpl |  tiki-directory_browse.php %%% tiki-directory_search.php %%% tiki-directory_ranking.php %%% tiki-directory_add_site.php %%% %%% tiki-directory_admin.php %%% tiki-directory_admin_categories.php %%% tiki-directory_admin_related.php %%% tiki-directory_admin_sites.php %%% tiki-directory_validate_sites.php 
div.dirfooter | page-bottom statistics | tiki-directory_footer.tpl | tiki-directory_browse.php 
td.dirfooter | individual stat items | tiki-directory_footer.tpl | tiki-directory_browse.php
table.normal | contains the site listings | tiki-directory_ranking.tpl%%% tiki-directory_validate_sites.tpl%%% tiki-directory_add_site.tpl%%% tiki-directory_admin_categories.tpl%%%tiki-directory_admin_related.tpl | %%% %%% tiki-register_site.php 
td.heading | column heading cell | tiki-directory_ranking.tpl%%% tiki-directory_validate_sites.tpl%%% tiki-directory_admin_categories.tpl | 
a.tableheading |  column heading | link tiki-directory_ranking.tpl%%% tiki-directory_validate_sites.tpl%%% tiki-directory_admin_categories.tpl%%% tiki-directory_admin_related.tpl | 
td.even, td.odd | alternating link rows | tiki-directory_ranking.tpl%%% tiki-directory_validate_sites.tpl%%% tiki-directory_admin_categories.tpl |
a.link | links to sites%%% %%% %%% link to categories | tiki-directory_ranking.tpl%%% tiki-directory_validate_sites.tpl%%% tiki-directory_admin.tpl%%% tiki-directory_admin_categories.tpl | 
a.tikihelp |  help link | tiki-directory_validate_sites.tpl%%% tiki-directory_admin.tpl%%% tiki-directory_admin_categories.tpl%%% tiki-directory_admin_related.tpl | 
td.formcolor | form table cells | tiki-directory_add_site.tpl%%% tiki-directory_admin_categories.tpl%%% tiki-directory_admin_related.tpl | tiki-register_site.php%%%  
span.highlight | message | tiki-directory_add_site.tpl | tiki-register_site.php
div.Caldir div.calId | Calendar Directory link | tiki-calendar.tpl |  
span.calprio | Calendar Directory link | tiki-calendar.tpl | 
a.linkmenu | Calendar Directory link | tiki-calendar.tpl | ||

!! Others
|| __Name__ | __Specification__ | __Description__ 
Tiki section | feature_directory | Used in menu item description ||

-=More Documentation=-
* ((Directory)) - Overview of the Directory feature.
* ((Directory User)) - How to use the Directory once it has been activated and configured. 
* ((Directory Admin)) - How to activate and configure the Directory, including determining its organization and page display, and setting appropriate permissions.