hugo/hugolib/node.go

155 lines
3.3 KiB
Go
Raw Normal View History

// Copyright © 2013-14 Steve Francia <spf@spf13.com>.
2013-07-04 15:32:55 +00:00
//
// Licensed under the Simple Public License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://opensource.org/licenses/Simple-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package hugolib
import (
2015-03-18 10:30:23 +00:00
"github.com/spf13/hugo/helpers"
2014-01-29 22:50:31 +00:00
"html/template"
"sync"
2014-01-29 22:50:31 +00:00
"time"
2013-07-04 15:32:55 +00:00
)
type Node struct {
2014-01-29 22:50:31 +00:00
RSSLink template.HTML
2014-05-28 23:11:54 +00:00
Site *SiteInfo
2014-01-29 22:50:31 +00:00
// layout string
Data map[string]interface{}
Title string
Description string
Keywords []string
Params map[string]interface{}
2014-01-29 22:50:31 +00:00
Date time.Time
2014-05-06 10:50:23 +00:00
Sitemap Sitemap
URLPath
paginator *pager
paginatorInit sync.Once
scratch *Scratch
}
func (n *Node) Now() time.Time {
return time.Now()
}
func (n *Node) HasMenuCurrent(menuID string, inme *MenuEntry) bool {
if inme.HasChildren() {
me := MenuEntry{Name: n.Title, URL: n.URL}
for _, child := range inme.Children {
if me.IsSameResource(child) {
return true
}
}
}
return false
}
func (n *Node) IsMenuCurrent(menuID string, inme *MenuEntry) bool {
me := MenuEntry{Name: n.Title, URL: n.URL}
if !me.IsSameResource(inme) {
return false
}
// this resource may be included in several menus
// search for it to make sure that it is in the menu with the given menuId
if menu, ok := (*n.Site.Menus)[menuID]; ok {
for _, menuEntry := range *menu {
if menuEntry.IsSameResource(inme) {
return true
}
descendantFound := n.isSameAsDescendantMenu(inme, menuEntry)
if descendantFound {
return descendantFound
}
}
}
return false
}
2015-01-19 01:40:34 +00:00
func (n *Node) Hugo() *HugoInfo {
return hugoInfo
2015-01-19 01:40:34 +00:00
}
func (n *Node) isSameAsDescendantMenu(inme *MenuEntry, parent *MenuEntry) bool {
if parent.HasChildren() {
for _, child := range parent.Children {
if child.IsSameResource(inme) {
return true
}
descendantFound := n.isSameAsDescendantMenu(inme, child)
if descendantFound {
return descendantFound
}
}
}
return false
}
func (n *Node) RSSlink() template.HTML {
2014-01-29 22:50:31 +00:00
return n.RSSLink
}
func (n *Node) IsNode() bool {
return true
}
func (n *Node) IsPage() bool {
return !n.IsNode()
}
Provide (relative) reference funcs & shortcodes. - `.Ref` and `.RelRef` take a reference (the logical filename for a page, including extension and/or a document fragment ID) and return a permalink (or relative permalink) to the referenced document. - If the reference is a page name (such as `about.md`), the page will be discovered and the permalink will be returned: `/about/` - If the reference is a page name with a fragment (such as `about.md#who`), the page will be discovered and used to add the `page.UniqueID()` to the resulting fragment and permalink: `/about/#who:deadbeef`. - If the reference is a fragment and `.*Ref` has been called from a `Node` or `SiteInfo`, it will be returned as is: `#who`. - If the reference is a fragment and `.*Ref` has been called from a `Page`, it will be returned with the page’s unique ID: `#who:deadbeef`. - `.*Ref` can be called from either `Node`, `SiteInfo` (e.g., `Node.Site`), `Page` objects, or `ShortcodeWithPage` objects in templates. - `.*Ref` cannot be used in content, so two shortcodes have been created to provide the functionality to content: `ref` and `relref`. These are intended to be used within markup, like `[Who]({{% ref about.md#who %}})` or `<a href="{{% ref about.md#who %}}">Who</a>`. - There are also `ref` and `relref` template functions (used to create the shortcodes) that expect a `Page` or `Node` object and the reference string (e.g., `{{ relref . "about.md" }}` or `{{ "about.md" | ref . }}`). It actually looks for `.*Ref` as defined on `Node` or `Page` objects. - Shortcode handling had to use a *differently unique* wrapper in `createShortcodePlaceholder` because of the way that the `ref` and `relref` are intended to be used in content.
2014-11-24 06:15:34 +00:00
func (n *Node) Ref(ref string) (string, error) {
return n.Site.Ref(ref, nil)
}
func (n *Node) RelRef(ref string) (string, error) {
return n.Site.RelRef(ref, nil)
}
type URLPath struct {
URL string
2014-01-29 22:50:31 +00:00
Permalink template.HTML
Slug string
Section string
2013-07-04 15:32:55 +00:00
}
// Url is deprecated. Will be removed in 0.15.
func (n *Node) Url() string {
helpers.Deprecated("Node", ".Url", ".URL")
return n.URL
}
2015-03-18 10:30:23 +00:00
// UrlPath is deprecated. Will be removed in 0.15.
func (n *Node) UrlPath() URLPath {
helpers.Deprecated("Node", ".UrlPath", ".URLPath")
return n.URLPath
}
// Url is deprecated. Will be removed in 0.15.
func (up URLPath) Url() string {
helpers.Deprecated("URLPath", ".Url", ".URL")
return up.URL
}
// Scratch returns the writable context associated with this Node.
func (n *Node) Scratch() *Scratch {
if n.scratch == nil {
n.scratch = newScratch()
}
return n.scratch
}