Difference between revisions of "Directories Module"

From JReviews Documentation
Jump to: navigation, search
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
You can use Directories Module as Directory/Section/Category navigation tree.
+
You can use the Directories module to display the complete directory/category navigation tree.
  
Here is how the module looks like by default:
+
'''Example of the module layout:'''
  
[[File:DirectoriesModule.png]]
+
[[File:directories-module.png]]
  
 +
== Directories Module Parameters ==
  
 +
[[File:directories-module-params.png]]
  
You can set "_folders" as ''jReviews Template Suffix'' in module's parameters to display alternative theme file with folder icons:
+
'''JReviews Theme Suffix''' - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs. The module comes with one default suffix "_folders" which will add folder icons next to the links.
  
[[File:DirectoriesModule2.png]]
+
'''Directory IDs (optional)''' - here you can choose to show only specific directories by entering their ID numbers. ID numbers of directories can be found in JReviews Directories Manager.
  
 +
'''Show Directory Links''' - if disabled, the module will hide directory links and show only category links.
  
 +
== Customizing the Directories Module ==
  
You can also configure which directories will be displayed in the module by adding Directory IDs in the module's parameters.
+
If you want to customize the theme file of the Directories Module, this is its default location:
  
 +
*<span style="color: blue">/com_jreviews/jreviews/views/themes/default/modules/directories.thtml</span>
 +
 +
Before you start customizing the theme files, make sure you read about  [[JReviews Code Overrides]] functionality and create a custom theme.
 +
 +
You can create multiple custom copies of the Directories Module theme file and enter their suffixes in the '''Theme Suffix''' parameter. Remember to clear JReviews File Registry when creating new theme files.
  
  

Latest revision as of 14:12, 9 January 2014

You can use the Directories module to display the complete directory/category navigation tree.

Example of the module layout:

Directories-module.png

Directories Module Parameters

Directories-module-params.png

JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs. The module comes with one default suffix "_folders" which will add folder icons next to the links.

Directory IDs (optional) - here you can choose to show only specific directories by entering their ID numbers. ID numbers of directories can be found in JReviews Directories Manager.

Show Directory Links - if disabled, the module will hide directory links and show only category links.

Customizing the Directories Module

If you want to customize the theme file of the Directories Module, this is its default location:

  • /com_jreviews/jreviews/views/themes/default/modules/directories.thtml

Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.

You can create multiple custom copies of the Directories Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.