diff options
author | haturatu <taro@eyes4you.org> | 2025-02-22 23:20:55 +0900 |
---|---|---|
committer | haturatu <taro@eyes4you.org> | 2025-02-22 23:20:55 +0900 |
commit | 9345907a5c1737c6c2c1f8eba52a568035b08493 (patch) | |
tree | 50f0c68436e4eba8e7a72cf9876a577d0c4c6340 /docs/build/Interfaces | |
parent | a9cdbc4e7fbdd14922ef5c96cc7a285b153bf947 (diff) |
fix: all hange s\/github.com\/ponzu-cms/github.com\/haturatu\/g
Diffstat (limited to 'docs/build/Interfaces')
-rw-r--r-- | docs/build/Interfaces/API/index.html | 14 | ||||
-rw-r--r-- | docs/build/Interfaces/Editor/index.html | 10 | ||||
-rw-r--r-- | docs/build/Interfaces/Format/index.html | 8 | ||||
-rw-r--r-- | docs/build/Interfaces/Item/index.html | 20 | ||||
-rw-r--r-- | docs/build/Interfaces/Search/index.html | 8 |
5 files changed, 30 insertions, 30 deletions
diff --git a/docs/build/Interfaces/API/index.html b/docs/build/Interfaces/API/index.html index 448562d..e341500 100644 --- a/docs/build/Interfaces/API/index.html +++ b/docs/build/Interfaces/API/index.html @@ -120,7 +120,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -167,7 +167,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -1011,7 +1011,7 @@ This provides Ponzu developers with full control over the request/response life-cycle.</p> <hr /> <h2 id="interfaces">Interfaces<a class="headerlink" href="#interfaces" title="Permanent link">¶</a></h2> -<h3 id="apicreateable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Createable">api.Createable</a><a class="headerlink" href="#apicreateable" title="Permanent link">¶</a></h3> +<h3 id="apicreateable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/api#Createable">api.Createable</a><a class="headerlink" href="#apicreateable" title="Permanent link">¶</a></h3> <p>Externalable enables 3rd-party clients (outside the CMS) to send content via a <code>multipart/form-data</code> encoded <code>POST</code> request to a specific endpoint: <code>/api/content/create?type=<Type></code>. When <code>api.Createable</code> is implemented, content @@ -1036,7 +1036,7 @@ the "Pending" section altogether and become "Public" immediately. </p> <hr /> -<h3 id="apiupdateable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Updateable">api.Updateable</a><a class="headerlink" href="#apiupdateable" title="Permanent link">¶</a></h3> +<h3 id="apiupdateable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/api#Updateable">api.Updateable</a><a class="headerlink" href="#apiupdateable" title="Permanent link">¶</a></h3> <p>Updateable enables 3rd-party clients (outside the CMS) to update existing content via a <code>multipart/form-data</code> encoded <code>POST</code> request to a specific endpoint: <code>/api/content/update?type=<Type>&id=<id></code>. Request validation should be employed @@ -1056,7 +1056,7 @@ otherwise any client could change data in your database.</p> <hr /> -<h3 id="apideleteable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Deleteable">api.Deleteable</a><a class="headerlink" href="#apideleteable" title="Permanent link">¶</a></h3> +<h3 id="apideleteable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/api#Deleteable">api.Deleteable</a><a class="headerlink" href="#apideleteable" title="Permanent link">¶</a></h3> <p>Updateable enables 3rd-party clients (outside the CMS) to delete existing content via a <code>multipart/form-data</code> encoded <code>POST</code> request to a specific endpoint: <code>/api/content/delete?type=<Type>&id=<id></code>. Request validation should be employed @@ -1076,7 +1076,7 @@ otherwise any client could delete data from your database.</p> <hr /> -<h3 id="apitrustable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Trustable">api.Trustable</a><a class="headerlink" href="#apitrustable" title="Permanent link">¶</a></h3> +<h3 id="apitrustable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/api#Trustable">api.Trustable</a><a class="headerlink" href="#apitrustable" title="Permanent link">¶</a></h3> <p>Trustable provides a way for submitted content (via <code>api.Createable</code>) to bypass the <code>editor.Mergeable</code> 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 @@ -1160,7 +1160,7 @@ altogether.</p> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> - <a href="https://github.com/ponzu-cms" class="md-footer-social__link fa fa-github"></a> + <a href="https://github.com/haturatu" class="md-footer-social__link fa fa-github"></a> <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a> diff --git a/docs/build/Interfaces/Editor/index.html b/docs/build/Interfaces/Editor/index.html index c6b25f7..51d1d9a 100644 --- a/docs/build/Interfaces/Editor/index.html +++ b/docs/build/Interfaces/Editor/index.html @@ -120,7 +120,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -167,7 +167,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -913,7 +913,7 @@ extend the system's functionality and determine how content editors are rendered within the CMS.</p> <hr /> <h2 id="interfaces">Interfaces<a class="headerlink" href="#interfaces" title="Permanent link">¶</a></h2> -<h3 id="editoreditable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/management/editor#Editable">editor.Editable</a><a class="headerlink" href="#editoreditable" title="Permanent link">¶</a></h3> +<h3 id="editoreditable"><a href="https://godoc.org/github.com/haturatu/ponzu/management/editor#Editable">editor.Editable</a><a class="headerlink" href="#editoreditable" title="Permanent link">¶</a></h3> <p>Editable determines what <code>[]bytes</code> are rendered inside the editor page. Use Edtiable on anything inside your CMS that you want to provide configuration, editable fields, or any HTML/markup to display to an end-user.</p> @@ -953,7 +953,7 @@ the Ponzu CLI <a href="../../CLI/Usage"><code>generate</code> command</a>.</p> <p>Although it is common to use the <code>editor.Form</code> and <code>editor.Fields</code> to structure your content editor inside <code>MarshalEditor()</code>, the method signature defines that its return value needs only to be <code>[]byte, error</code>. Keep in mind that you can return a <code>[]byte</code> of any raw HTML or other markup to be rendered in the editor view.</p> </div> <hr /> -<h3 id="editormergeable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/management/editor#Mergeable">editor.Mergeable</a><a class="headerlink" href="#editormergeable" title="Permanent link">¶</a></h3> +<h3 id="editormergeable"><a href="https://godoc.org/github.com/haturatu/ponzu/management/editor#Mergeable">editor.Mergeable</a><a class="headerlink" href="#editormergeable" title="Permanent link">¶</a></h3> <p>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.</p> <h5 id="method-set_1">Method Set<a class="headerlink" href="#method-set_1" title="Permanent link">¶</a></h5> <div class="codehilite"><pre><span></span><span class="kd">type</span> <span class="nx">Mergeable</span> <span class="kd">interface</span> <span class="p">{</span> @@ -1033,7 +1033,7 @@ the Ponzu CLI <a href="../../CLI/Usage"><code>generate</code> command</a>.</p> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> - <a href="https://github.com/ponzu-cms" class="md-footer-social__link fa fa-github"></a> + <a href="https://github.com/haturatu" class="md-footer-social__link fa fa-github"></a> <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a> diff --git a/docs/build/Interfaces/Format/index.html b/docs/build/Interfaces/Format/index.html index d85bd14..a21fab5 100644 --- a/docs/build/Interfaces/Format/index.html +++ b/docs/build/Interfaces/Format/index.html @@ -120,7 +120,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -167,7 +167,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -859,7 +859,7 @@ determine how content data should be converted and formatted for exporting via the Admin interface.</p> <hr /> <h2 id="interfaces">Interfaces<a class="headerlink" href="#interfaces" title="Permanent link">¶</a></h2> -<h3 id="formatcsvformattable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/management/format#CSVFormattable">format.CSVFormattable</a><a class="headerlink" href="#formatcsvformattable" title="Permanent link">¶</a></h3> +<h3 id="formatcsvformattable"><a href="https://godoc.org/github.com/haturatu/ponzu/management/format#CSVFormattable">format.CSVFormattable</a><a class="headerlink" href="#formatcsvformattable" title="Permanent link">¶</a></h3> <p>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 button will be present beneath the "New" button per Content type. </p> @@ -960,7 +960,7 @@ columns. Keep in mind that all of item.Item's fields are available here as well. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> - <a href="https://github.com/ponzu-cms" class="md-footer-social__link fa fa-github"></a> + <a href="https://github.com/haturatu" class="md-footer-social__link fa fa-github"></a> <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a> diff --git a/docs/build/Interfaces/Item/index.html b/docs/build/Interfaces/Item/index.html index dd6bd99..d3834c7 100644 --- a/docs/build/Interfaces/Item/index.html +++ b/docs/build/Interfaces/Item/index.html @@ -120,7 +120,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -167,7 +167,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -1519,7 +1519,7 @@ the functionality of the content in your system and how it interacts with other components inside and outside of Ponzu. </p> <hr /> <h2 id="interfaces">Interfaces<a class="headerlink" href="#interfaces" title="Permanent link">¶</a></h2> -<h3 id="itempushable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Pushable">item.Pushable</a><a class="headerlink" href="#itempushable" title="Permanent link">¶</a></h3> +<h3 id="itempushable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/item#Pushable">item.Pushable</a><a class="headerlink" href="#itempushable" title="Permanent link">¶</a></h3> <p>Pushable, if <a href="https://http2.github.io/http2-spec/#PushResources">HTTP/2 Server Push</a> 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 @@ -1556,7 +1556,7 @@ for the field names <strong>must</strong> be URL paths, and cannot be from anoth <hr /> -<h3 id="itemhideable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Hideable">item.Hideable</a><a class="headerlink" href="#itemhideable" title="Permanent link">¶</a></h3> +<h3 id="itemhideable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/item#Hideable">item.Hideable</a><a class="headerlink" href="#itemhideable" title="Permanent link">¶</a></h3> <p>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 <code>Hide</code> method, the only method in Hideable, takes an <code>http.ResponseWriter, *http.Request</code> @@ -1578,7 +1578,7 @@ content in specific cases.</p> <hr /> -<h3 id="itemomittable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Omittable">item.Omittable</a><a class="headerlink" href="#itemomittable" title="Permanent link">¶</a></h3> +<h3 id="itemomittable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/item#Omittable">item.Omittable</a><a class="headerlink" href="#itemomittable" title="Permanent link">¶</a></h3> <p>Omittable tells a content API handler to keep certain fields from being exposed through the JSON response. It's single method, <code>Omit</code> takes no arguments and returns a <code>[]string</code> which must be made up of the JSON struct tags for the type @@ -1609,7 +1609,7 @@ containing fields to be omitted and an error value.</p> <hr /> -<h3 id="itemhookable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Hookable">item.Hookable</a><a class="headerlink" href="#itemhookable" title="Permanent link">¶</a></h3> +<h3 id="itemhookable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/item#Hookable">item.Hookable</a><a class="headerlink" href="#itemhookable" title="Permanent link">¶</a></h3> <p>Hookable provides lifecycle hooks into the http handlers which manage Save, Delete, Approve, and Reject routines. All methods in its set take an <code>http.ResponseWriter, *http.Request</code> and return an <code>error</code>.</p> @@ -1895,7 +1895,7 @@ The same logic applies to all of these interface methods that return an error - <strong>the error defines the behavior</strong>.</p> </div> <hr /> -<h3 id="itemidentifiable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Identifiable">item.Identifiable</a><a class="headerlink" href="#itemidentifiable" title="Permanent link">¶</a></h3> +<h3 id="itemidentifiable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/item#Identifiable">item.Identifiable</a><a class="headerlink" href="#itemidentifiable" title="Permanent link">¶</a></h3> <p>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 <code>String</code> method is used to set a meaningful display name for an Item. <code>String</code> 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.</p> @@ -1933,7 +1933,7 @@ the CMS, and to customize slugs.</p> <hr /> -<h3 id="itemsluggable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Sluggable">item.Sluggable</a><a class="headerlink" href="#itemsluggable" title="Permanent link">¶</a></h3> +<h3 id="itemsluggable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/item#Sluggable">item.Sluggable</a><a class="headerlink" href="#itemsluggable" title="Permanent link">¶</a></h3> <p>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 <code>SetSlug</code> method with your own. It is not recommended to override <code>SetSlug</code>, but rather the <code>String</code> method on your content struct, which will have a similar, more predictable effect. Sluggable is implemented by Item by default.</p> @@ -1963,7 +1963,7 @@ Content item slug, but try first to override the <code>String()</code> method fo <hr /> -<h3 id="itemsortable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Sortable">item.Sortable</a><a class="headerlink" href="#itemsortable" title="Permanent link">¶</a></h3> +<h3 id="itemsortable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/item#Sortable">item.Sortable</a><a class="headerlink" href="#itemsortable" title="Permanent link">¶</a></h3> <p>Sortable enables items to be sorted by time, as per the sort.Interface interface. Sortable is implemented by Item by default.</p> <h5 id="method-set_6">Method Set<a class="headerlink" href="#method-set_6" title="Permanent link">¶</a></h5> <div class="codehilite"><pre><span></span><span class="kd">type</span> <span class="nx">Sortable</span> <span class="kd">interface</span> <span class="p">{</span> @@ -2051,7 +2051,7 @@ is undefined.</p> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> - <a href="https://github.com/ponzu-cms" class="md-footer-social__link fa fa-github"></a> + <a href="https://github.com/haturatu" class="md-footer-social__link fa fa-github"></a> <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a> diff --git a/docs/build/Interfaces/Search/index.html b/docs/build/Interfaces/Search/index.html index 1c328c7..8ed7a14 100644 --- a/docs/build/Interfaces/Search/index.html +++ b/docs/build/Interfaces/Search/index.html @@ -120,7 +120,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -167,7 +167,7 @@ - <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + <a href="https://github.com/haturatu/ponzu" title="Go to repository" class="md-source" data-md-source="github"> <div class="md-source__icon"> <svg viewBox="0 0 24 24" width="24" height="24"> @@ -856,7 +856,7 @@ <p>Ponzu provides a set of interfaces from the <code>system/search</code> package to enable and customize full-text search access to content in your system. <strong>Search is not enabled by default</strong>, and must be enabled per Content type individually.</p> <h2 id="interfaces">Interfaces<a class="headerlink" href="#interfaces" title="Permanent link">¶</a></h2> -<h3 id="searchsearchable"><a href="https://godoc.org/github.com/ponzu-cms/ponzu/system/search#Searchable">search.Searchable</a><a class="headerlink" href="#searchsearchable" title="Permanent link">¶</a></h3> +<h3 id="searchsearchable"><a href="https://godoc.org/github.com/haturatu/ponzu/system/search#Searchable">search.Searchable</a><a class="headerlink" href="#searchsearchable" title="Permanent link">¶</a></h3> <p>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.</p> <div class="admonition warning"> <p>Search is <strong>disabled</strong> for all Content items by default. Each Content item that should be indexed and searchable must implement the <code>search.Searchable</code> interface.</p> @@ -957,7 +957,7 @@ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> - <a href="https://github.com/ponzu-cms" class="md-footer-social__link fa fa-github"></a> + <a href="https://github.com/haturatu" class="md-footer-social__link fa fa-github"></a> <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a> |