orchardtaxonomies Wiki Rss Feed

Updated Wiki: Home

sebastienros — Fri, 15 Jun 2012 23:49:21 GMT

Orchard Taxonomies

The Orchard Taxonomies module adds a way to manage taxonomies, and assign them to specific content types, thus allowing content classification and filtering.

What is a Taxonomy

A taxonomy is a hierarchical set of terms used to classify content. Taxonomies differ from tags as they are controlled, whereas tags can be freely defined. The Orchard Taxonomies module adds a way to manage taxonomies, and assign them to specific content types, thus allowing content classification and filtering.

What is it useful for ?

Taxonomies can be used to streamline content editing by providing a set of predefined values to content authors. It is also useful to drive the front page display by filtering the elements to display on each page, based on their categories.

Where do I start ?

You should condider reading the documentation as it shows some typical usage scenarios, and will guide you from installing the module, to advanced usage and configuration.

You can also watch this video from Bertrand Le Roy, Program Manager on Orchard.
http://www.youtube.com/watch?v=B3jhgTeiEtw&feature=player_embedded

Updated Wiki: Home

sebastienros — Wed, 25 May 2011 18:35:17 GMT

Orchard Taxonomies

The Orchard Taxonomies module adds a way to manage taxonomies, and assign them to specific content types, thus allowing content classification and filtering.

What is a Taxonomy

A taxonomy is a hierarchical set of terms used to classify content. Taxonomies differ from tags as they controlled, whereas tags can be freely defined. The Orchard Taxonomies module adds a way to manage taxonomies, and assign them to specific content types, thus allowing content classification and filtering.

What is it useful for ?

Where do I start ?

Updated Wiki: Editing the vocabulary

sebastienros — Sun, 26 Dec 2010 17:29:26 GMT

Editing the Vocabulary

To edit the vocabulary of a taxonomy, click on Taxonomies from the admin panel, and in front of the taxonomy click Vocabulary. From there you can add new terms or edit the existing ones. If you hit Create new term then you can select the parent term for this new one, from the existing terms.

Selecting Terms

When a field has been added to a content type, just edit one of these content types, and the fields will be displayed for edition.
Depending on the fields' options, you will be able to select one or more terms, and also might be restricted from selecting terms other than the leaf ones if it's a hierarchical vocabulary.

Updated Wiki: Creating a Taxonomy

sebastienros — Sun, 26 Dec 2010 17:24:52 GMT

Creating a Taxonomy

Creating a new taxonomy is as simple as going to the Taxonomy menu item in the admin panel, and clicking on Create New Taxonomy.

Once the taxonomy is created and populated, you can link it from any content type

Adding a Taxonomy to a Content Type

In the admin panel, click on Content Types
Click on Edit fot the content type you want to modify
In front of Fields, click Add
Give it a name, and select TaxonomyField
Click Save
Expand the new Field section
Select the desired taxonomy name
Click Save

Updated Wiki: Managing taxonomies

sebastienros — Sun, 26 Dec 2010 17:18:57 GMT

Overview

When a taxonomy is created, you can manage its terms, which are then called the vocabulary. Those terms can be hierarchical.

Dynamic Term Content Types

Once a taxonomy has been created, a new Content Type is available, named under the taxonomy's name and "Term". Like "Topcis Term". This type is usefull if custom fields or parts must be added to all the terms of specific taxonomies. For instance, each term of a taxonomy named "Directors" could require an associated image field to select a picture when creating a adding a new term to this taxonomy.

Updated Wiki: Managing taxonomies

sebastienros — Sun, 26 Dec 2010 17:17:59 GMT

Overview

When a taxonomy is created, you can manage its terms, which are then called the vocabulary. Those terms can be hierarchical.

Dynamic Term Content Types

Updated Wiki: Displaying content

sebastienros — Sun, 26 Dec 2010 17:11:49 GMT

List Shape

The whole displayed list has its own shape, named Taxonomy.List. The original one can be found under /Contrib.Taxonomies/Views/Items/Taxonomy.List.cshtml.
This shape exposes a few alternates like these ones:

Taxonomy.List.TaxonomySlug.cshtml
Taxonomy.List.TaxonomySlug-TermSlug.cshtml
Taxonomy.List.TermId.cshtml

For instance, if a taxonomy is named Categories and the list for the tern France is displayed, France being a sub term of World, then the following alternates are availabe:

Taxonomy.List.Categories.cshtml
Taxonomy.List.Categories-World.cshtml
Taxonomy.List.Categories-World-France.cshtml
Taxonomy.List.12.cshtml

While rendering the shape, those properties are available:

Model.Term
Model.Taxonomy
Model.List

The minimal requirement is to call @Display(Model.List) to render each content item associated to the currently displayed term.

Content Item Shape

When the list is displayed, each child shape will also have a set of alternate which can be used to be rendered based on the currently displayed term. Those available shapes are:

Taxonomy.Content.TaxonomySlug.cshtml
Taxonomy.Content.ContentType.TaxonomySlug.cshtml
Taxonomy.Content.TaxonomySlug-TermSlug.cshtml
Taxonomy.Content.ContentType.TaxonomySlug-TermSlug.cshtml
Taxonomy.List.ContentType-TermId.cshtml

Here are the generated ones for the same example as previously:

Taxonomy.Content.Categories.cshtml
Taxonomy.Content.BlogPost-Categories.cshtml
Taxonomy.Content.Categories-World.cshtml
Taxonomy.Content.BlogPost-Categories-World.cshtml
Taxonomy.Content.Categories-World-France.cshtml
Taxonomy.Content.BlogPost-Categories-World-France.cshtml
Taxonomy.Content.23.cshtml
Taxonomy.Content.BlogPost-23.cshtml

Practical Usage

In case you want to display a specific set of elements based on a term, it's convenient to create a menu item for each of those terms. For instance, in a News Website, the main menu displays the topics for the articles, like World, Business, Culture, Technology. Let's say that those elements are reprensented by terms in a taxonomy named Topics, then you might want to display the items for Technology with a specific template, and all the others with another template.

The solution is to create a file named Taxonomy.List.Topics.cshtml which will be used to display any Topic list of items, and another one named Taxonomy.List.Categories-Technology.cshtml, specific for the content items displayed when querying the content items associated to Technology.

Updated Wiki: Displaying content

sebastienros — Sun, 26 Dec 2010 16:56:02 GMT

!Shape Alternates

The whole displayed list has its own shape, named Taxonomy.List. The original one can be found under /Contrib.Taxonomies/Views/Items/Taxonomy.List.cshtml.
This shape exposes a few alternates like these ones:

Taxonomy.List.TaxonomySlug.cshtml
Taxonomy.List._TaxonomySlug-TermSlug.cshtml
Taxonomy.List._TermId.cshtml

Updated Wiki: Installation

sebastienros — Sun, 26 Dec 2010 16:51:43 GMT

Installation

Install Orchard

Install Orchard by following the instructions

Install Orchard Taxonomies

The simplest way to add this module to your Orchard installation is to use the Modules Gallery.
You can also download it as source code. Then you need to add it to the /Modules folder under your Orchard installation.

Installing from Azure deployment

To install a module to an Azure deployment, you need to bundle it inside an Azure package. See Orchard documentation for further details.

Updated Wiki: Introduction

sebastienros — Sun, 26 Sep 2010 16:04:54 GMT

Introduction

What is a Taxonomy

A taxonomy is a hierarchical set of terms used to classify content. Taxonomies differ from tags as they controlled, whereas tags can be freely defined. The Orchard Taxonomies module adds a way to manage taxonomies, and assign them to specific content types, thus allowing content classification and filtering.

Classify content

As an example, the screenshot below displays two movies. In Orchard a Movie would be defined as a Content Type, with a Name and a Description for instance. Then to classify them using Directors, Actors or Genre different taxonomies can be used.

HTTP://WWW.SCREENRUSH.CO.UK/

The Orchard Taxonomies module lets you configure how taxonomies should behave when used with a specific content type. You can for instance allow only one term to be selected, like Director, or multiple ones like Actors. You can also define hierarchical taxonomies, and only allow the most precise terms to be selected (the leaf term of the hierarchy).

Organize web pages

Orchard Taxonomies can also be used to organize the content of a website on the front pages. News papers’ websites are famous for this, like any other website based on article publishing. In the above example, articles are categorized using a publication taxonomy.

When an author creates a new article, he is able to select a main category, and optionally subsequent sub topics. The topics are defined as a hierarchical, controlled taxonomy. The menu is driven by the available categories, and when one topic is selected, the website filters all content related to this term, and displays them with predefined layout, focusing on the latest published one for instance, and displaying the others below.

HTTP://WWW.NYTIMES.COM/