summaryrefslogtreecommitdiffstats
path: root/media/mediaType.go
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-03-05 18:23:00 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-03-27 15:43:56 +0200
commitd3d2c63dd98ea2339ae31501f04346cfb93be6c6 (patch)
treefbb689f5b8f11095fa5fdc5a017538527b5d2dc5 /media/mediaType.go
parentc4989c39f1b29b82475fd350d91af7b5c2c19bf5 (diff)
output: Add output type
Diffstat (limited to 'media/mediaType.go')
-rw-r--r--media/mediaType.go66
1 files changed, 66 insertions, 0 deletions
diff --git a/media/mediaType.go b/media/mediaType.go
new file mode 100644
index 000000000..4663a274d
--- /dev/null
+++ b/media/mediaType.go
@@ -0,0 +1,66 @@
+// Copyright 2017-present 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 media
+
+import (
+ "fmt"
+)
+
+type Types []Type
+
+// A media type (also known as MIME type and content type) is a two-part identifier for
+// file formats and format contents transmitted on the Internet.
+// For Hugo's use case, we use the top-level type name / subtype name + suffix.
+// One example would be image/jpeg+jpg
+// If suffix is not provided, the sub type will be used.
+// See // https://en.wikipedia.org/wiki/Media_type
+type Type struct {
+ Type string // i.e. text
+ SubType string // i.e. html
+ Suffix string // i.e html
+}
+
+// Key return a key used to identify this media type. Hugo will register a set of
+// default media types. These can be overridden by the user in the configuration,
+// by defining a media type with the same Key.
+func (m Type) Key() string {
+ return fmt.Sprintf("%s/%s", m.Type, m.SubType)
+}
+
+func (m Type) String() string {
+ if m.Suffix != "" {
+ return fmt.Sprintf("%s/%s+%s", m.Type, m.SubType, m.Suffix)
+ }
+ return fmt.Sprintf("%s/%s", m.Type, m.SubType)
+}
+
+var (
+ HTMLType = Type{"text", "html", "html"}
+ RSSType = Type{"application", "rss", "xml"}
+)
+
+// DefaultMediaTypes holds a default set of media types by Hugo.
+// These can be ovverriden, and more added if needed, in the Hugo configuration file.
+// The final media type set set will also be added as extensions to mime so
+// they will be recognised by the built-in server in Hugo.
+// TODO(bep) output remove
+var DefaultMediaTypes = Types{
+ HTMLType,
+ RSSType,
+
+ // TODO(bep) output
+}
+
+// TODO(bep) output mime.AddExtensionType
+// TODO(bep) text/template vs html/template