aboutsummaryrefslogtreecommitdiffstats
path: root/doc/webpage-element-import.md
diff options
context:
space:
mode:
authorAndrew Manning <tamanning@zoho.com>2016-07-31 10:20:03 -0400
committerAndrew Manning <tamanning@zoho.com>2016-07-31 10:20:03 -0400
commit99afd0a449cde502b32c30d5b6170c6b87b85edc (patch)
treea6e4b55e1eb695242165256808e47bed51a9df78 /doc/webpage-element-import.md
parent42b718b3e0fcd44c734a3faf385b29d05c614fe3 (diff)
downloadvolse-hubzilla-99afd0a449cde502b32c30d5b6170c6b87b85edc.tar.gz
volse-hubzilla-99afd0a449cde502b32c30d5b6170c6b87b85edc.tar.bz2
volse-hubzilla-99afd0a449cde502b32c30d5b6170c6b87b85edc.zip
Added help content for webpages app. Corrected apparent bug with capitalized Webpages.md
Diffstat (limited to 'doc/webpage-element-import.md')
-rw-r--r--doc/webpage-element-import.md94
1 files changed, 94 insertions, 0 deletions
diff --git a/doc/webpage-element-import.md b/doc/webpage-element-import.md
new file mode 100644
index 000000000..4330227c2
--- /dev/null
+++ b/doc/webpage-element-import.md
@@ -0,0 +1,94 @@
+## <a href="#webpage-element-import"></a>Webpage element import
+
+There are two methods of importing webpage elements: uploading a zip file or
+referencing a local cloud files folder. Both methods require that the webpage
+elements are specified using a specific folder structure. The import tool makes
+it possible to import all the elements necessary to construct an entire website
+or set of websites. The goal is to accommodate external development of webpages
+as well as tools to simplify and automate deployment on a hub.
+
+### Folder structure
+Element definitions must be stored in the repo root under folders called
+
+ /pages/
+ /blocks/
+ /layouts/
+
+
+Each element of these types must be defined in an individual subfolder using two files: one JSON-formatted file for the metadata and one plain text file for the element content.
+
+### Page elements
+Page element metadata is specified in a JSON-formatted file called `page.json` with the following properties:
+
+ * title
+ * pagelink
+ * mimetype
+ * layout
+ * contentfile
+
+**Example**
+
+Files:
+
+ /pages/my-page/page.json
+ /pages/my-page/my-page.bbcode
+
+Content of `page.json`:
+
+ {
+ "title": "My Page",
+ "pagelink": "mypage",
+ "mimetype": "text/bbcode",
+ "layout": "my-layout",
+ "contentfile": "my-page.bbcode"
+ }
+
+
+### Layout elements
+Layout element metadata is specified in a JSON-formatted file called `layout.json` with the following properties:
+
+ * name
+ * description
+ * contentfile
+
+**Example**
+
+Files:
+
+ /layouts/my-layout/layout.json
+ /layouts/my-layout/my-layout.bbcode
+
+Content of `layout.json`:
+
+ {
+ "name": "my-layout",
+ "description": "Layout for my project page",
+ "contentfile": "my-layout.bbcode"
+ }
+
+
+### Block elements
+Block element metadata is specified in a JSON-formatted file called `block.json` with the following properties:
+
+ * name
+ * title
+ * mimetype
+ * contentfile
+
+**Example**
+
+Files:
+
+ /blocks/my-block/block.json
+ /blocks/my-block/my-block.html
+
+Content of `block.json`:
+
+
+ {
+ "name": "my-block",
+ "title": "",
+ "mimetype": "text/html",
+ "contentfile": "my-block.html"
+ }
+ \ No newline at end of file