Back to top anchor
Open main menu Close main menu

Sector Guide

The Sector guide provides step-by-step guidance for your Sector Projects.

Sector Index A-Z

Sector Index A-Z offers a simple and easy way to list content in an A-Z index. You can start from the included Index content type or re-use the included Index A-Z views to list any existing content alphabetically by title or by topic. 

Sector Index A-Z is an optional Sector Add-on. This Sector Add-on can be downloaded and installed via the Sector Index A-Z project on Drupal.org or using composer. Sector Index components and configuration make it easy to get started, and the sample content makes it easy to grasp the main features. 

Required Drupal contribution modules

  • Sector Index A-Z has dependencies to - and requires components from - the Sector Starter Kit 8.x-2.0-beta4 or higher.

Features and functionality

Sector Index A-Z can be used to search as well as list content in a an alphabetical index either by the title of a content node, or by an assigned topic. The Sector A-Z (by Title) view is a Search API view run from a full-text Search API index. The Sector A-Z (by Term) is a Drupal content view and uses double grouping to lists the topics A-Z followed by all the nodes that are assigned to the topic.

Sector Index A-Z includes:

  • Sector Index content type and displays
  • Sector Index topic taxonomy.         
  • Sector A-Z (by Title) view to search or list index content alphabetically by title. 
  • Sector A-Z (by Term) view to search or list index topics and related nodes alphabetically by term. 
  • And - as always - sample content to make it easy to get started

Related entities and configuration (Sector D8)

Sector Index content type

<your-domain>/admin/structure/types/manage/index

The Sector Index content type is preconfigured with a very basic set of fields and Display Suite view modes. 

Sector Index URL path pattern

<your-domain>/admin/config/search/path/patterns/index

Sector Index A-Z topic taxonomy 

<your-domain>/admin/structure/taxonomy/manage/index_type/overview

The Index A-Z topic . By default, the tags in this taxonomy are 'rabbit-holed' to 403 (Access denied). 

Sector A-Z (by Title) view 

<your-domain>/admin/structure/views/view/sector_a_z

Includes displays for the: 

  • Filtered view (Page) - the view page for the Index A-Z by Title landing page under /index. 
  • a Teaser (Block) - to embed into a page (disabled by default).
  • a Short Teaser (Block) - to embed into secondary region or a sidebar (disabled by default).

The Search API view uses fields (not Display Suite view modes) to allow the grouping by Alphabet. 

Sector A-Z (by Term) view 

<your-domain>/admin/structure/views/view/sector_a_z_alternate

Includes displays for the: 

  • Filtered view (Page) - the view page for the Index A-Z by Term landing page under /index-alternate. 

The Drupal view uses fields (not Display Suite view modes) to allow the double grouping by Alphabet and assigned nodes. 

Permissions 

<your-domain>/admin/people/permissions

On install, Sector Index adjusts the Sector Starter Kit permissions to allow Content editors and Content Administrators to manage content in the Content type Index. 

Sitemap XML settings

On install, Sector Index the add-on also includes the index pages in the sitemap xml.

<your-domain>/admin/config/search/xmlsitemap/entities/settings

Twig template files 

  • Template views-view-grouping--sector-a-z-alternate.html.twig 

The template adds a wrapping <div> with a class to the double grouping in the view allowing us to keep the alphabet groups together in a multi column view.

Sample content

3 Index nodes

  • A for Apple - Index content sample (/index/apple-index-content-sample)
  • Z for Zebra - Index content sample (/index/z-zebra-index-content-sample)
  • X for Xylophone - Index content sample (/index/x-xylophone-index-content-sample)

3 Index topic terms

  • C for Cow - Index topic sample term    
  • E for Elephant - Index topic sample term    
  • O for Octopus - Index topic sample term

 

Open Source award winner!

Sparks Interactive are delighted to accept the Open Source Use in Business award for Sector and the Sector.nz open source platform

Find out more

Subscribe for Sector updates