2023-01-04 12:24:36 -05:00
|
|
|
// Copyright 2023 The Hugo Authors. All rights reserved.
|
2016-08-07 16:01:55 -04:00
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
|
2022-12-30 03:20:58 -05:00
|
|
|
// Package langs contains the language related types and function.
|
Add support for theme composition and inheritance
This commit adds support for theme composition and inheritance in Hugo.
With this, it helps thinking about a theme as a set of ordered components:
```toml
theme = ["my-shortcodes", "base-theme", "hyde"]
```
The theme definition example above in `config.toml` creates a theme with the 3 components with presedence from left to right.
So, Hugo will, for any given file, data entry etc., look first in the project, and then in `my-shortcode`, `base-theme` and lastly `hyde`.
Hugo uses two different algorithms to merge the filesystems, depending on the file type:
* For `i18n` and `data` files, Hugo merges deeply using the translation id and data key inside the files.
* For `static`, `layouts` (templates) and `archetypes` files, these are merged on file level. So the left-most file will be chosen.
The name used in the `theme` definition above must match a folder in `/your-site/themes`, e.g. `/your-site/themes/my-shortcodes`. There are plans to improve on this and get a URL scheme so this can be resolved automatically.
Also note that a component that is part of a theme can have its own configuration file, e.g. `config.toml`. There are currently some restrictions to what a theme component can configure:
* `params` (global and per language)
* `menu` (global and per language)
* `outputformats` and `mediatypes`
The same rules apply here: The left-most param/menu etc. with the same ID will win. There are some hidden and experimental namespace support in the above, which we will work to improve in the future, but theme authors are encouraged to create their own namespaces to avoid naming conflicts.
A final note: Themes/components can also have a `theme` definition in their `config.toml` and similar, which is the "inheritance" part of this commit's title. This is currently not supported by the Hugo theme site. We will have to wait for some "auto dependency" feature to be implemented for that to happen, but this can be a powerful feature if you want to create your own theme-variant based on others.
Fixes #4460
Fixes #4450
2018-03-01 09:01:25 -05:00
|
|
|
package langs
|
2016-08-07 16:01:55 -04:00
|
|
|
|
|
|
|
import (
|
2022-05-02 10:07:52 -04:00
|
|
|
"fmt"
|
2019-12-10 13:56:44 -05:00
|
|
|
"sync"
|
2021-07-27 07:45:05 -04:00
|
|
|
"time"
|
2016-08-07 16:01:55 -04:00
|
|
|
|
2022-04-10 14:30:52 -04:00
|
|
|
"golang.org/x/text/collate"
|
|
|
|
"golang.org/x/text/language"
|
|
|
|
|
2022-04-05 03:57:58 -04:00
|
|
|
"github.com/gohugoio/hugo/common/htime"
|
2023-05-17 03:59:57 -04:00
|
|
|
"github.com/gohugoio/hugo/common/maps"
|
2022-03-17 17:03:27 -04:00
|
|
|
"github.com/gohugoio/locales"
|
|
|
|
translators "github.com/gohugoio/localescompressed"
|
2016-08-07 16:01:55 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
type Language struct {
|
2023-01-04 12:24:36 -05:00
|
|
|
// The language code, e.g. "en" or "no".
|
|
|
|
// This is currently only settable as the key in the language map in the config.
|
|
|
|
Lang string
|
2018-01-30 11:51:18 -05:00
|
|
|
|
2023-01-04 12:24:36 -05:00
|
|
|
// Fields from the language config.
|
|
|
|
LanguageConfig
|
2021-07-26 12:28:57 -04:00
|
|
|
|
2021-07-27 07:45:05 -04:00
|
|
|
// Used for date formatting etc. We don't want these exported to the
|
2021-07-26 12:28:57 -04:00
|
|
|
// templates.
|
2022-04-05 03:57:58 -04:00
|
|
|
translator locales.Translator
|
|
|
|
timeFormatter htime.TimeFormatter
|
2022-04-10 14:30:52 -04:00
|
|
|
tag language.Tag
|
|
|
|
collator *Collator
|
|
|
|
location *time.Location
|
2023-05-17 03:59:57 -04:00
|
|
|
|
|
|
|
// This is just an alias of Site.Params.
|
|
|
|
params maps.Params
|
2016-08-08 07:55:18 -04:00
|
|
|
}
|
|
|
|
|
2017-08-02 08:25:05 -04:00
|
|
|
// NewLanguage creates a new language.
|
2023-01-04 12:24:36 -05:00
|
|
|
func NewLanguage(lang, defaultContentLanguage, timeZone string, languageConfig LanguageConfig) (*Language, error) {
|
2021-07-28 06:28:52 -04:00
|
|
|
translator := translators.GetTranslator(lang)
|
2021-07-26 12:28:57 -04:00
|
|
|
if translator == nil {
|
2023-01-04 12:24:36 -05:00
|
|
|
translator = translators.GetTranslator(defaultContentLanguage)
|
2021-07-26 12:28:57 -04:00
|
|
|
if translator == nil {
|
2021-07-28 06:28:52 -04:00
|
|
|
translator = translators.GetTranslator("en")
|
2021-07-26 12:28:57 -04:00
|
|
|
}
|
|
|
|
}
|
2018-03-21 12:21:46 -04:00
|
|
|
|
2022-04-10 14:30:52 -04:00
|
|
|
var coll *Collator
|
|
|
|
tag, err := language.Parse(lang)
|
|
|
|
if err == nil {
|
|
|
|
coll = &Collator{
|
|
|
|
c: collate.New(tag),
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
coll = &Collator{
|
|
|
|
c: collate.New(language.English),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-07-26 12:28:57 -04:00
|
|
|
l := &Language{
|
2023-01-04 12:24:36 -05:00
|
|
|
Lang: lang,
|
|
|
|
LanguageConfig: languageConfig,
|
|
|
|
translator: translator,
|
|
|
|
timeFormatter: htime.NewTimeFormatter(translator),
|
|
|
|
tag: tag,
|
|
|
|
collator: coll,
|
2021-07-26 12:28:57 -04:00
|
|
|
}
|
2021-08-01 05:50:12 -04:00
|
|
|
|
2023-01-04 12:24:36 -05:00
|
|
|
return l, l.loadLocation(timeZone)
|
2023-05-17 03:59:57 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// This is injected from hugolib to avoid cirular dependencies.
|
|
|
|
var DeprecationFunc = func(item, alternative string, err bool) {}
|
|
|
|
|
|
|
|
const paramsDeprecationWarning = `.Language.Params is deprecated and will be removed in a future release. Use site.Params instead.
|
|
|
|
|
|
|
|
Also, for all but custom parameters, you need to use the built in Hugo variables, e.g. site.Title, site.LanguageCode; site.Language.Params.Title will not work.
|
2021-08-01 05:50:12 -04:00
|
|
|
|
2023-05-17 03:59:57 -04:00
|
|
|
See https://gohugo.io/content-management/multilingual/#changes-in-hugo-01120
|
|
|
|
|
|
|
|
`
|
|
|
|
|
|
|
|
// Params returns the language params.
|
|
|
|
// Note that this is the same as the Site.Params, but we keep it here for legacy reasons.
|
|
|
|
// Deprecated: Use the site.Params instead.
|
|
|
|
func (l *Language) Params() maps.Params {
|
|
|
|
DeprecationFunc(".Language.Params", paramsDeprecationWarning, false)
|
|
|
|
return l.params
|
2016-08-07 16:01:55 -04:00
|
|
|
}
|
|
|
|
|
2023-01-04 12:24:36 -05:00
|
|
|
func (l *Language) loadLocation(tzStr string) error {
|
|
|
|
location, err := time.LoadLocation(tzStr)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("invalid timeZone for language %q: %w", l.Lang, err)
|
2016-08-07 16:01:55 -04:00
|
|
|
}
|
2023-01-04 12:24:36 -05:00
|
|
|
l.location = location
|
2016-08-07 16:01:55 -04:00
|
|
|
|
2023-01-04 12:24:36 -05:00
|
|
|
return nil
|
2016-08-07 16:01:55 -04:00
|
|
|
}
|
|
|
|
|
2017-08-02 08:25:05 -04:00
|
|
|
// Languages is a sortable list of languages.
|
2016-08-07 16:01:55 -04:00
|
|
|
type Languages []*Language
|
|
|
|
|
Add Hugo Modules
This commit implements Hugo Modules.
This is a broad subject, but some keywords include:
* A new `module` configuration section where you can import almost anything. You can configure both your own file mounts nd the file mounts of the modules you import. This is the new recommended way of configuring what you earlier put in `configDir`, `staticDir` etc. And it also allows you to mount folders in non-Hugo-projects, e.g. the `SCSS` folder in the Bootstrap GitHub project.
* A module consists of a set of mounts to the standard 7 component types in Hugo: `static`, `content`, `layouts`, `data`, `assets`, `i18n`, and `archetypes`. Yes, Theme Components can now include content, which should be very useful, especially in bigger multilingual projects.
* Modules not in your local file cache will be downloaded automatically and even "hot replaced" while the server is running.
* Hugo Modules supports and encourages semver versioned modules, and uses the minimal version selection algorithm to resolve versions.
* A new set of CLI commands are provided to manage all of this: `hugo mod init`, `hugo mod get`, `hugo mod graph`, `hugo mod tidy`, and `hugo mod vendor`.
All of the above is backed by Go Modules.
Fixes #5973
Fixes #5996
Fixes #6010
Fixes #5911
Fixes #5940
Fixes #6074
Fixes #6082
Fixes #6092
2019-05-03 03:16:58 -04:00
|
|
|
func (l Languages) AsSet() map[string]bool {
|
|
|
|
m := make(map[string]bool)
|
|
|
|
for _, lang := range l {
|
|
|
|
m[lang.Lang] = true
|
|
|
|
}
|
|
|
|
|
|
|
|
return m
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l Languages) AsOrdinalSet() map[string]int {
|
|
|
|
m := make(map[string]int)
|
|
|
|
for i, lang := range l {
|
|
|
|
m[lang.Lang] = i
|
|
|
|
}
|
|
|
|
|
|
|
|
return m
|
|
|
|
}
|
|
|
|
|
2021-07-26 12:28:57 -04:00
|
|
|
// Internal access to unexported Language fields.
|
|
|
|
// This construct is to prevent them from leaking to the templates.
|
|
|
|
|
2023-05-17 03:59:57 -04:00
|
|
|
func SetParams(l *Language, params maps.Params) {
|
|
|
|
l.params = params
|
|
|
|
}
|
|
|
|
|
2022-04-05 03:57:58 -04:00
|
|
|
func GetTimeFormatter(l *Language) htime.TimeFormatter {
|
|
|
|
return l.timeFormatter
|
|
|
|
}
|
|
|
|
|
2021-07-26 12:28:57 -04:00
|
|
|
func GetTranslator(l *Language) locales.Translator {
|
|
|
|
return l.translator
|
|
|
|
}
|
2021-07-27 07:45:05 -04:00
|
|
|
|
|
|
|
func GetLocation(l *Language) *time.Location {
|
2021-08-01 05:50:12 -04:00
|
|
|
return l.location
|
|
|
|
}
|
|
|
|
|
2022-04-10 14:30:52 -04:00
|
|
|
func GetCollator(l *Language) *Collator {
|
|
|
|
return l.collator
|
|
|
|
}
|
|
|
|
|
|
|
|
type Collator struct {
|
|
|
|
sync.Mutex
|
|
|
|
c *collate.Collator
|
|
|
|
}
|
|
|
|
|
|
|
|
// CompareStrings compares a and b.
|
|
|
|
// It returns -1 if a < b, 1 if a > b and 0 if a == b.
|
|
|
|
// Note that the Collator is not thread safe, so you may want
|
2023-02-18 15:47:35 -05:00
|
|
|
// to acquire a lock on it before calling this method.
|
2022-04-10 14:30:52 -04:00
|
|
|
func (c *Collator) CompareStrings(a, b string) int {
|
|
|
|
return c.c.CompareString(a, b)
|
|
|
|
}
|