Class Nanoc::Router
In: lib/nanoc/base/router.rb
Parent: Plugin

A Nanoc::Router is an abstract superclass that determines the paths of page and asset representations, both the path on the disk (relative to the site‘s output directory) and the path as it appears on the web site.

Methods

disk_path_for   new   path_for_asset_rep   path_for_page_rep   web_path_for  

Public Class methods

new(site)

Creates a new router for the given site.

Public Instance methods

disk_path_for(obj)

Returns the disk path for the given page or asset representation, i.e. the page or asset‘s custom path or routed path relative to the output directory.

path_for_asset_rep(asset_rep)

Returns the routed path for the given asset representation, including the filename and the extension. It should start with a slash, and should be relative to the web root (i.e. should not include any references to the output directory). There is no need to let this method handle custom paths.

Subclasses must implement this method.

path_for_page_rep(page_rep)

Returns the routed path for the given page representation, including the filename and the extension. It should start with a slash, and should be relative to the web root (i.e. should not include any references to the output directory). There is no need to let this method handle custom paths.

Subclasses must implement this method.

web_path_for(obj)

Returns the web path for the given page or asset representation, i.e. the page or asset rep‘s custom path or routed path with index filenames stripped.

[Validate]