mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
112c3c5c04
- `.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.
120 lines
2.6 KiB
Go
120 lines
2.6 KiB
Go
// Copyright © 2013-14 Steve Francia <spf@spf13.com>.
|
|
//
|
|
// 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 (
|
|
"html/template"
|
|
"time"
|
|
)
|
|
|
|
type Node struct {
|
|
RSSLink template.HTML
|
|
Site *SiteInfo
|
|
// layout string
|
|
Data map[string]interface{}
|
|
Title string
|
|
Description string
|
|
Keywords []string
|
|
Params map[string]interface{}
|
|
Date time.Time
|
|
Sitemap Sitemap
|
|
UrlPath
|
|
}
|
|
|
|
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: string(n.Permalink)}
|
|
|
|
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: string(n.Permalink)}
|
|
|
|
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
|
|
}
|
|
|
|
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 {
|
|
return n.RSSLink
|
|
}
|
|
|
|
func (n *Node) IsNode() bool {
|
|
return true
|
|
}
|
|
|
|
func (n *Node) IsPage() bool {
|
|
return !n.IsNode()
|
|
}
|
|
|
|
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
|
|
Permalink template.HTML
|
|
Slug string
|
|
Section string
|
|
}
|