From 9345907a5c1737c6c2c1f8eba52a568035b08493 Mon Sep 17 00:00:00 2001 From: haturatu Date: Sat, 22 Feb 2025 23:20:55 +0900 Subject: fix: all hange s\/github.com\/ponzu-cms/github.com\/haturatu\/g --- docs/build/Interfaces/API/index.html | 14 +++++++------- docs/build/Interfaces/Editor/index.html | 10 +++++----- docs/build/Interfaces/Format/index.html | 8 ++++---- docs/build/Interfaces/Item/index.html | 20 ++++++++++---------- docs/build/Interfaces/Search/index.html | 8 ++++---- 5 files changed, 30 insertions(+), 30 deletions(-) (limited to 'docs/build/Interfaces') 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 @@ - +
@@ -167,7 +167,7 @@ - +
@@ -1011,7 +1011,7 @@ This provides Ponzu developers with full control over the request/response life-cycle.

Interfaces

-

api.Createable

+

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 @@ -1036,7 +1036,7 @@ the "Pending" section altogether and become "Public" immediately.

-

api.Updateable

+

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 @@ -1056,7 +1056,7 @@ otherwise any client could change data in your database.

-

api.Deleteable

+

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 @@ -1076,7 +1076,7 @@ otherwise any client could delete data from your database.

-

api.Trustable

+

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 @@ -1160,7 +1160,7 @@ altogether.

- + 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 @@ - +
@@ -167,7 +167,7 @@ - +
@@ -913,7 +913,7 @@ extend the system's functionality and determine how content editors are rendered within the CMS.

Interfaces

-

editor.Editable

+

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 fields, or any HTML/markup to display to an end-user.

@@ -953,7 +953,7 @@ the Ponzu CLI generate command.

Although it is common to use the editor.Form and editor.Fields to structure your content editor inside MarshalEditor(), the method signature defines that its return value needs only to be []byte, error. Keep in mind that you can return a []byte of any raw HTML or other markup to be rendered in the editor view.

-

editor.Mergeable

+

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.

Method Set
type Mergeable interface {
@@ -1033,7 +1033,7 @@ the Ponzu CLI generate command.

     
     
     
-      
+      
     
       
     
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 @@
   
 
 
-  
+  
     
       

         
@@ -167,7 +167,7 @@
   
 
 
-  
+  
     
       

         
@@ -859,7 +859,7 @@ determine how content data should be converted and formatted for exporting via
 the Admin interface.

 

 
Interfaces

-
format.CSVFormattable

+
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
 button will be present beneath the "New" button per Content type. 

@@ -960,7 +960,7 @@ columns. Keep in mind that all of item.Item's fields are available here as well.
     
     
     
-      
+      
     
       
     
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 @@
   
 
 
-  
+  
     
       

         
@@ -167,7 +167,7 @@
   
 
 
-  
+  
     
       

         
@@ -1519,7 +1519,7 @@ the functionality of the content in your system and how it interacts with other
 components inside and outside of Ponzu. 

 

 
Interfaces

-
item.Pushable

+
item.Pushable

 
Pushable, if HTTP/2 Server Push 
 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 must be URL paths, and cannot be from anoth
 
 
 

-
item.Hideable

+
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 
@@ -1578,7 +1578,7 @@ content in specific cases.

 
 
 

-
item.Omittable

+
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 
@@ -1609,7 +1609,7 @@ containing fields to be omitted and an error value.

 
 
 

-
item.Hookable

+
item.Hookable

 
Hookable provides lifecycle hooks into the http handlers which manage Save, Delete,
 Approve, and Reject routines. All methods in its set take an 
 http.ResponseWriter, *http.Request and return an error.

@@ -1895,7 +1895,7 @@ The same logic applies to all of these interface methods that return an error
 - the error defines the behavior.

 

 

-
item.Identifiable

+
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.

@@ -1933,7 +1933,7 @@ the CMS, and to customize slugs.

 
 
 

-
item.Sluggable

+
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.

@@ -1963,7 +1963,7 @@ Content item slug, but try first to override the String() method fo
 
 
 

-
item.Sortable

+
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

 
type Sortable interface {
@@ -2051,7 +2051,7 @@ is undefined.

     
     
     
-      
+      
     
       
     
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 @@
   
 
 
-  
+  
     
       

         
@@ -167,7 +167,7 @@
   
 
 
-  
+  
     
       

         
@@ -856,7 +856,7 @@
                 
                 
Ponzu provides a set of interfaces from the system/search package to enable and customize full-text search access to content in your system. Search is not enabled by default, and must be enabled per Content type individually.

 
Interfaces

-
search.Searchable

+
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.

 

 
Search is disabled for all Content items by default. Each Content item that should be indexed and searchable must implement the search.Searchable interface.

@@ -957,7 +957,7 @@
     
     
     
-      
+      
     
       
     
-- 
cgit v1.2.3