diff options
Diffstat (limited to 'docs/src/Interfaces')
| -rw-r--r-- | docs/src/Interfaces/API.md | 8 | ||||
| -rw-r--r-- | docs/src/Interfaces/Editor.md | 4 | ||||
| -rw-r--r-- | docs/src/Interfaces/Format.md | 2 | ||||
| -rw-r--r-- | docs/src/Interfaces/Item.md | 14 | ||||
| -rw-r--r-- | docs/src/Interfaces/Search.md | 2 |
5 files changed, 15 insertions, 15 deletions
diff --git a/docs/src/Interfaces/API.md b/docs/src/Interfaces/API.md index 1d9ab82..c2ff055 100644 --- a/docs/src/Interfaces/API.md +++ b/docs/src/Interfaces/API.md @@ -13,7 +13,7 @@ life-cycle. ## Interfaces -### [api.Createable](https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Createable) +### [api.Createable](https://godoc.org/github.com/haturatu/ponzu/system/api#Createable) Externalable enables 3rd-party clients (outside the CMS) to send content via a `multipart/form-data` encoded `POST` request to a specific endpoint: `/api/content/create?type=<Type>`. When `api.Createable` is implemented, content @@ -42,7 +42,7 @@ func (p *Post) Create(res http.ResponseWriter, req *http.Request) error { --- -### [api.Updateable](https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Updateable) +### [api.Updateable](https://godoc.org/github.com/haturatu/ponzu/system/api#Updateable) Updateable enables 3rd-party clients (outside the CMS) to update existing content via a `multipart/form-data` encoded `POST` request to a specific endpoint: `/api/content/update?type=<Type>&id=<id>`. Request validation should be employed @@ -65,7 +65,7 @@ func (p *Post) Update(res http.ResponseWriter, req *http.Request) error { --- -### [api.Deleteable](https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Deleteable) +### [api.Deleteable](https://godoc.org/github.com/haturatu/ponzu/system/api#Deleteable) Updateable enables 3rd-party clients (outside the CMS) to delete existing content via a `multipart/form-data` encoded `POST` request to a specific endpoint: `/api/content/delete?type=<Type>&id=<id>`. Request validation should be employed @@ -88,7 +88,7 @@ func (p *Post) Delete(res http.ResponseWriter, req *http.Request) error { --- -### [api.Trustable](https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Trustable) +### [api.Trustable](https://godoc.org/github.com/haturatu/ponzu/system/api#Trustable) Trustable provides a way for submitted content (via `api.Createable`) to bypass the `editor.Mergeable` step in which CMS end-users must manually click the "Approve" button in order for content to be put in the "Public" section and access diff --git a/docs/src/Interfaces/Editor.md b/docs/src/Interfaces/Editor.md index 63d3ceb..d1abf01 100644 --- a/docs/src/Interfaces/Editor.md +++ b/docs/src/Interfaces/Editor.md @@ -8,7 +8,7 @@ within the CMS. ## Interfaces -### [editor.Editable](https://godoc.org/github.com/ponzu-cms/ponzu/management/editor#Editable) +### [editor.Editable](https://godoc.org/github.com/haturatu/ponzu/management/editor#Editable) Editable determines what `[]bytes` are rendered inside the editor page. Use Edtiable on anything inside your CMS that you want to provide configuration, editable @@ -51,7 +51,7 @@ func (p *Post) MarshalEditor() ([]byte, error) { --- -### [editor.Mergeable](https://godoc.org/github.com/ponzu-cms/ponzu/management/editor#Mergeable) +### [editor.Mergeable](https://godoc.org/github.com/haturatu/ponzu/management/editor#Mergeable) Mergable enables a CMS end-user to merge the "Pending" content from an outside source into the "Public" section, and thus making it visible via the public content API. It also allows the end-user to reject content. "Approve" and "Reject" buttons will be visible on the edit page for content submitted. diff --git a/docs/src/Interfaces/Format.md b/docs/src/Interfaces/Format.md index 8a259d3..ad483a9 100644 --- a/docs/src/Interfaces/Format.md +++ b/docs/src/Interfaces/Format.md @@ -8,7 +8,7 @@ the Admin interface. ## Interfaces -### [format.CSVFormattable](https://godoc.org/github.com/ponzu-cms/ponzu/management/format#CSVFormattable) +### [format.CSVFormattable](https://godoc.org/github.com/haturatu/ponzu/management/format#CSVFormattable) CSVFormattable controls if an "Export" button is added to the contents view for a Content type in the CMS to export the data to CSV. If it is implemented, a diff --git a/docs/src/Interfaces/Item.md b/docs/src/Interfaces/Item.md index 9f805b8..454322d 100644 --- a/docs/src/Interfaces/Item.md +++ b/docs/src/Interfaces/Item.md @@ -8,7 +8,7 @@ components inside and outside of Ponzu. ## Interfaces -### [item.Pushable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Pushable) +### [item.Pushable](https://godoc.org/github.com/haturatu/ponzu/system/item#Pushable) Pushable, if [HTTP/2 Server Push](https://http2.github.io/http2-spec/#PushResources) is supported by the client, can tell a handler which resources it would like to have "pushed" preemptively to the client. This saves follow-on roundtrip requests @@ -48,7 +48,7 @@ func (p *Post) Push(res http.ResponseWriter, req *http.Request) ([]string, error --- -### [item.Hideable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Hideable) +### [item.Hideable](https://godoc.org/github.com/haturatu/ponzu/system/item#Hideable) Hideable tells an API handler that data of this type shouldn’t be exposed outside the system. Hideable types cannot be used as references (relations in Content types). The `Hide` method, the only method in Hideable, takes an `http.ResponseWriter, *http.Request` @@ -72,7 +72,7 @@ func (p *Post) Hide(res http.ResponseWriter, req *http.Request) error { --- -### [item.Omittable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Omittable) +### [item.Omittable](https://godoc.org/github.com/haturatu/ponzu/system/item#Omittable) Omittable tells a content API handler to keep certain fields from being exposed through the JSON response. It's single method, `Omit` takes no arguments and returns a `[]string` which must be made up of the JSON struct tags for the type @@ -105,7 +105,7 @@ func (p *Post) Omit(res http.ResponseWriter, req *http.Request) ([]string, error --- -### [item.Hookable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Hookable) +### [item.Hookable](https://godoc.org/github.com/haturatu/ponzu/system/item#Hookable) Hookable provides lifecycle hooks into the http handlers which manage Save, Delete, Approve, Reject routines, and API response routines. All methods in its set take an `http.ResponseWriter, *http.Request` and return an `error`. Hooks which relate to the API response, additionally take data of type `[]byte`, and may provide a return of the same type. @@ -441,7 +441,7 @@ Hookable is implemented by Item by default as no-ops which are expected to be ov --- -### [item.Identifiable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Identifiable) +### [item.Identifiable](https://godoc.org/github.com/haturatu/ponzu/system/item#Identifiable) Identifiable enables a struct to have its ID set/get. Typically this is done to set an ID to -1 indicating it is new for DB inserts, since by default a newly initialized struct would have an ID of 0, the int zero-value, and BoltDB's starting key per bucket is 0, thus overwriting the first record. Most notable, Identifiable’s `String` method is used to set a meaningful display name for an Item. `String` is called by default in the Admin dashboard to show the Items of certain types, and in the default creation of an Item’s slug. Identifiable is implemented by Item by default. @@ -481,7 +481,7 @@ func (i Item) String() string { ``` --- -### [item.Sluggable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Sluggable) +### [item.Sluggable](https://godoc.org/github.com/haturatu/ponzu/system/item#Sluggable) Sluggable makes a struct locatable by URL with it's own path. As an Item implementing Sluggable, slugs may overlap. If this is an issue, make your content struct (or one which embeds Item) implement Sluggable and it will override the slug created by Item's `SetSlug` method with your own. It is not recommended to override `SetSlug`, but rather the `String` method on your content struct, which will have a similar, more predictable effect. Sluggable is implemented by Item by default. @@ -514,7 +514,7 @@ func (i *Item) ItemSlug() string { --- -### [item.Sortable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Sortable) +### [item.Sortable](https://godoc.org/github.com/haturatu/ponzu/system/item#Sortable) Sortable enables items to be sorted by time, as per the sort.Interface interface. Sortable is implemented by Item by default. ##### Method Set diff --git a/docs/src/Interfaces/Search.md b/docs/src/Interfaces/Search.md index a7cd0d1..ca309eb 100644 --- a/docs/src/Interfaces/Search.md +++ b/docs/src/Interfaces/Search.md @@ -4,7 +4,7 @@ Ponzu provides a set of interfaces from the `system/search` package to enable an ## Interfaces -### [search.Searchable](https://godoc.org/github.com/ponzu-cms/ponzu/system/search#Searchable) +### [search.Searchable](https://godoc.org/github.com/haturatu/ponzu/system/search#Searchable) Searchable determines how content is indexed and whether the system should index the content when it is created and updated or be removed from the index when content is deleted. !!! warning "" |