You are here

Home » API reference » Submenu Tree 7.2

README.txt in Submenu Tree 7.2

Same filename and directory in other branches
  1. 5 readme.txt
  2. 6 readme.txt
  3. 7 readme.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Usage
 * Sponsors
 * Maintainers

INTRODUCTION
------------

Submenu Tree provides a method for structuring content hierarchically. For
content which has a menu link, Submenu Tree display a list of content which is
at the same level or below the content in the menu.

Content that at the same level as a selected piece of content is referred to
as "sibling" content while content that is below a selected piece of content
is referred to as "sub" content.

Lists of sub or sibling content can be displayed either in a block or directly
inside of the body of a piece of content. Lists can be formatted in six
different ways:

 * Menu
 * Titles only
 * Teasers
 * Teasers with links
 * Full text
 * Full text with links

Submenu Tree also provides a block which displays "extended" links. Extended
links are made up of all menu links in an administrator-selected menu that are
two or more levels deep.

REQUIREMENTS
------------

The Block and Menu modules included with Drupal are required in order to
install Submenu Tree.

INSTALLATION
------------

Submenu Tree can be installed via the standard Drupal installation process
(http://drupal.org/node/895232).

CONFIGURATION
-----

Sub and sibling content default settings can be configured per content type on
the content types page [admin/structure/types].

Submenu Tree configuration options can be configured on the Submenu Tree
configuration page [admin/config/content/submenu-tree].

Configuration options include:

 * Block title generation
 * Extended menu

USAGE
-----

As an Administrator or a user with either the Administer submenu content or
Administer Sibling content permissions, you will see a vertical tab titled
"Sub and Sibling content" while editing content.

Selecting the tab will display options for enabling sub and/or sibling
content, depending on user permissions.

Selecting either option will enable the display of sub/sibling content for the
current content and expand the number of options presented. The additional
options include a title textfield, a display select box and a weight select
box. Note that both sub and sibling content can have unique titles, display
settings and weights.

Each option has an impact on the display of sub and/or sibling content:

 * Title
    Optionally specify a title display above the sub/sibling content list or
    as the sub/sibling content block title.
 * Display
    Selects where and how the sub/sibling content will be displayed. When
    displaying sub/sibling content in a block, ensure that the respective
    block(s) are enabled.
 * Weight
    Selects where in the page the sub/sibling content will appear when one of
    the "content" display types has been selected.

Sponsors
--------

Development of Submenu Tree is sponsored by ThinkLeft (http://thinkleft.com)
and the Ontario Ministry of Northern Development and Mines
(http://www.mndm.gov.on.ca).

MAINTAINERS
-----------

Current maintainer

 * Andrey Ivnitsky - https://www.drupal.org/u/itcrowd72

Previous maintainers:

 * Beng Tan - http://drupal.org/user/132729
 * Devin Carlson - http://drupal.org/user/290182

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Usage

  9.  * Sponsors

  10.  * Maintainers

  11. 

  12. INTRODUCTION

  13. ------------

  14. 

  15. Submenu Tree provides a method for structuring content hierarchically. For

  16. content which has a menu link, Submenu Tree display a list of content which is

  17. at the same level or below the content in the menu.

  18. 

  19. Content that at the same level as a selected piece of content is referred to

  20. as "sibling" content while content that is below a selected piece of content

  21. is referred to as "sub" content.

  22. 

  23. Lists of sub or sibling content can be displayed either in a block or directly

  24. inside of the body of a piece of content. Lists can be formatted in six

  25. different ways:

  26. 

  27.  * Menu

  28.  * Titles only

  29.  * Teasers

  30.  * Teasers with links

  31.  * Full text

  32.  * Full text with links

  33. 

  34. Submenu Tree also provides a block which displays "extended" links. Extended

  35. links are made up of all menu links in an administrator-selected menu that are

  36. two or more levels deep.

  37. 

  38. REQUIREMENTS

  39. ------------

  40. 

  41. The Block and Menu modules included with Drupal are required in order to

  42. install Submenu Tree.

  43. 

  44. INSTALLATION

  45. ------------

  46. 

  47. Submenu Tree can be installed via the standard Drupal installation process

  48. (http://drupal.org/node/895232).

  49. 

  50. CONFIGURATION

  51. -----

  52. 

  53. Sub and sibling content default settings can be configured per content type on

  54. the content types page [admin/structure/types].

  55. 

  56. Submenu Tree configuration options can be configured on the Submenu Tree

  57. configuration page [admin/config/content/submenu-tree].

  58. 

  59. Configuration options include:

  60. 

  61.  * Block title generation

  62.  * Extended menu

  63. 

  64. USAGE

  65. -----

  66. 

  67. As an Administrator or a user with either the Administer submenu content or

  68. Administer Sibling content permissions, you will see a vertical tab titled

  69. "Sub and Sibling content" while editing content.

  70. 

  71. Selecting the tab will display options for enabling sub and/or sibling

  72. content, depending on user permissions.

  73. 

  74. Selecting either option will enable the display of sub/sibling content for the

  75. current content and expand the number of options presented. The additional

  76. options include a title textfield, a display select box and a weight select

  77. box. Note that both sub and sibling content can have unique titles, display

  78. settings and weights.

  79. 

  80. Each option has an impact on the display of sub and/or sibling content:

  81. 

  82.  * Title

  83.     Optionally specify a title display above the sub/sibling content list or

  84.     as the sub/sibling content block title.

  85.  * Display

  86.     Selects where and how the sub/sibling content will be displayed. When

  87.     displaying sub/sibling content in a block, ensure that the respective

  88.     block(s) are enabled.

  89.  * Weight

  90.     Selects where in the page the sub/sibling content will appear when one of

  91.     the "content" display types has been selected.

  92. 

  93. Sponsors

  94. --------

  95. 

  96. Development of Submenu Tree is sponsored by ThinkLeft (http://thinkleft.com)

  97. and the Ontario Ministry of Northern Development and Mines

  98. (http://www.mndm.gov.on.ca).

  99. 

  100. MAINTAINERS

  101. -----------

  102. 

  103. Current maintainer

  104. 

  105.  * Andrey Ivnitsky - https://www.drupal.org/u/itcrowd72

  106. 

  107. Previous maintainers:

  108. 

  109.  * Beng Tan - http://drupal.org/user/132729

  110.  * Devin Carlson - http://drupal.org/user/290182