nodeattr.go

/*
Copyright 2014 The Perkeep Authors

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 nodeattr contains constants for permanode attribute names.
//
// For all date values in RFC 3339 format, Perkeep additionally
// treats the special timezone offset -00:01 (one minute west of UTC)
// as meaning that the local time was known, but the location or
// timezone was not. Usually this is from EXIF files.
package nodeattr // import "perkeep.org/pkg/schema/nodeattr"

const (
	// Type is the Perkeep permanode type ("camliNodeType").
	// Importer-specific ones are of the form "domain.com:objecttype".
	// Well-defined ones are documented in doc/schema/claims/attributes.txt.
	Type = "camliNodeType"

	// CamliContent is "camliContent", the blobref of the permanode's content.
	// For files or images, the camliContent is fileref (the blobref of
	// the "file" schema blob).
	CamliContent = "camliContent"

	// CamliContentImage is "camliContentImage", for when CamliContent is
	// already set to the blobref of a non-image.
	CamliContentImage = "camliContentImage"

	// DateCreated is http://schema.org/dateCreated in RFC 3339
	// format.
	DateCreated = "dateCreated"

	// StartDate is http://schema.org/startDate, the start date
	// and time of the event or item, in RFC 3339 format.
	StartDate = "startDate"

	// DateModified is http://schema.org/dateModified, in RFC 3339
	// format.
	DateModified = "dateModified"

	// DatePublished is http://schema.org/datePublished in RFC
	// 3339 format.
	DatePublished = "datePublished"

	// TODO(mpl): ask Brad what he wants. The original DueDate from the .py code (which is not in schema.org), or that.

	// PaymentDueDate is http://schema.org/paymentDueDate in RFC
	// 3339 format.
	PaymentDueDate = "paymentDueDate"

	// Title is http://schema.org/title
	Title = "title"

	// Description is http://schema.org/description
	// Value is plain text, no HTML, newlines are newlines.
	Description = "description"

	// Content is "content", used e.g. for the content of a tweet.
	// TODO: define this more
	Content = "content"

	// URL is the item's original or origin URL.
	URL = "url"

	// LocationText is free-flowing text definition of a location or place, such
	// as a city name, or a full postal address.
	LocationText = "locationText"

	Altitude  = "altitude"
	Latitude  = "latitude"
	Longitude = "longitude"

	// StreetAddress is http://schema.org/streetAddress
	StreetAddress = "streetAddress"

	// AddressLocality is http://schema.org/addressLocality
	// City, town, village, etc. name, plus any additional locality
	// information, such as suburb name. Not as restricted as
	// the UK postal meaning.
	AddressLocality = "addressLocality"

	// PostalCode is http://schema.org/postalCode
	PostalCode = "postalCode"

	// AddressRegion is http://schema.org/addressRegion
	// Region, or state name.
	AddressRegion = "addressRegion"

	// AddressCountry is http://schema.org/addressCountry
	AddressCountry = "addressCountry"

	// GivenName is http://schema.org/givenName
	GivenName = "givenName"

	// FamilyName is http://schema.org/familyName
	FamilyName = "familyName"

	// CamliPathOrderColon is the prefix "camliPathOrder:".
	// The attribute key should be followed by a uint64. The attribute value
	// is an existing value of a camliPath element.
	// CamliPathOrder optionally sorts sets already using "camliPath:foo" keys.
	// The integers do not need to be contiguous, nor 0- (or 1-) based.
	CamliPathOrderColon = "camliPathOrder:"

	// DefaultVisibility is "camliDefVis", which affects the default
	// visibility of the concerned permanode in the web UI.
	DefaultVisibility = "camliDefVis"

	// Version is http://schema.org/version
	Version = "version"

	// Starred is a boolean indicating a user "starred" or marked something as a favorite.
	Starred = "starred"

	// Folder is a string representing a logical collection of files grouped together
	Folder = "folder"
)