search

hyde / docs

Hyde documentation
http://hyde.github.io
31 stars 13 forks source link

What properties does a resource have? A node? #3

Open alanhogan opened 13 years ago

alanhogan commented 13 years ago

What properties does a resource have? A node?

navilan commented 13 years ago

Hi,

You can look at this for more detail. But I will summarize what I think are the important ones here:

Resource

source: The file object. url: The expected target url full_url: url prefixed with the site base url mentioned in site.yaml meta: Holds all the meta data - inherited from parent node or site and the ones in the page header

Node

source: The folder object. url: The expected target url full_url: url prefixed with the site base url mentioned in site.yaml meta: Holds all the meta data - inherited from the site and the ones mentioned in meta.yaml in the folder

Methods

walk - Walks child nodes walk_resources - Walks contained resources recusively

Content Node (site.content)

Apart from the standard Node methods this also has the following lookup methods:

resource_from_relative_path, resource_from_relative_deploy_path, resource_from_path - Lookup a resource object based on path, path relative to content, relative to deploy folder, or full source path respectively.

Similar methods for Node.

Apart from these, these may also have additional properties added by individual plugins. For example, the grouper, tagger and sorter add the walk methods to the Node object.