Site.Authors in internal templates

pksunkara · September 27, 2016, 3:40pm

Hello,

How do I set this?

gohugoio/hugo/blob/4a79fa0c33f364cd753c022e0f741403985699b2/tpl/template_embedded.go

// Copyright 2015 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache 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://www.apache.org/licenses/LICENSE-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 tpl

type Tmpl struct {
	Name string
	Data string
}

This file has been truncated. show original

Where is that authors coming from? I would appreciate if I can see an example where this is being used. Facebook templates similarly uses this .Site.Authors

digitalcraftsman · September 27, 2016, 3:47pm

At least since the last version of Hugo (v0.16) the code base contains a first attempt to implement the author feature. The current approach allows you to define a single author in the config file. However, this setup will be removed due to it’s limitations. In the future you’ll be able to define multiple author profiles in their own files.

You can find the current implementation below. If you search on GitHub in the Hugo repository with “author” as query you’ll find all places were the current implementation is used (including your template).

You can follow the future development in the corresponding issues. You should also keep an eye on milestone v0.18.

github.com

gohugoio/hugo/blob/4a79fa0c33f364cd753c022e0f741403985699b2/hugolib/author.go

// Copyright 2015 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache 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://www.apache.org/licenses/LICENSE-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

// AuthorList is a list of all authors and their metadata.
type AuthorList map[string]Author

// Author contains details about the author of a page.
type Author struct {

This file has been truncated. show original

pksunkara · September 27, 2016, 3:53pm

So, basically the specific internal templates parts will not work until v0.18, right?

digitalcraftsman · September 27, 2016, 4:15pm

They should work even with the current version. You can add a author section to your config file with the fields of the struct that I linked above.

[author]
displayName = "James Bond"
shortBio = "Agent at the MI6"

Hugo will make those data available trough the .Site.Author variable in the templates.

With the search will also find the place where the author struct is embedded into the pages.

pksunkara · September 27, 2016, 4:34pm

They won’t work in the current version. If you look closely at the code I linked above, it’s Authors, not Author.

digitalcraftsman · September 27, 2016, 4:42pm

.Site.Authors is actually a template function.

pksunkara · September 27, 2016, 7:32pm

Nope. .Authors is the linked template function. .Site.Authors doesn’t exist.

digitalcraftsman · September 28, 2016, 12:18pm

My fault. You’re right. .Authors is the correct way to access it.

juh2 · October 25, 2016, 10:23am

So

[authors]
twitter = "foo"

in config.toml won’t work in 0.17?

And

[author]
twitter = "foo"

also doesn’t work?

How to set it in the metadata field of a content file?

Topic		Replies	Views
.Site.Author Usage? support	16	6905	March 20, 2021
How to configure and use .Site.Author support	10	5553	July 16, 2016
How do I setup the "authors" key in the config file for "twitter:creator" and "article:author" meta tags? support	2	880	April 1, 2021
Opengraph template help	2	629	April 29, 2021
ELI5: Author Field support	2	1128	January 4, 2016

Site.Authors in internal templates

Related topics