diff options
| -rw-r--r-- | doc/context/en/webpages/help.html | 8 | ||||
| -rw-r--r-- | doc/webpage-element-import.md | 94 | ||||
| -rw-r--r-- | doc/webpages.bb | 3 | ||||
| -rw-r--r-- | doc/webpages.md (renamed from doc/Webpages.md) | 1 |
4 files changed, 106 insertions, 0 deletions
diff --git a/doc/context/en/webpages/help.html b/doc/context/en/webpages/help.html new file mode 100644 index 000000000..af57ee88a --- /dev/null +++ b/doc/context/en/webpages/help.html @@ -0,0 +1,8 @@ +<dl class="dl-horizontal"> + <dt>General</dt> + <dd>You can create modular, identity-aware websites composed of shareable elements. </dd> + <dt>Pages</dt> + <dd>This page lists your "pages", which are assigned URLs where people can visit your site. The structure of pages are typically described by an associated <b>layout</b>, and their content is constructed from a collection of <b>blocks</b>.</dd> + <dt><a href='#' onclick='contextualHelpFocus("#website-import-tools", 1); return false;' title="Click to highlight element...">Website import tool</a></dt> + <dd>The website import tool allows you import multiple webpage elements (pages, layouts, blocks) either from an uploaded zip file or from an existing cloud files folder. <a target="_blank" href="help/webpages">Read more...</a></dd> +</dl>
\ No newline at end of file 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 diff --git a/doc/webpages.bb b/doc/webpages.bb index 6b3a800cb..2b909dc63 100644 --- a/doc/webpages.bb +++ b/doc/webpages.bb @@ -9,6 +9,9 @@ The "page link title" box allows a user to specify the "pagelinkt Beneath the page creation box, a list of existing pages will appear with an "edit" link. Clicking this will take you to an editor, similar to that of the post editor, where you can make changes to your webpages.
+See also:
+
+[zrl=[baseurl]/help/webpage-element-import]Webpage element import tool[/zrl]
[b]Using Blocks[/b]
diff --git a/doc/Webpages.md b/doc/webpages.md index 801a9a3a0..05c16f2bb 100644 --- a/doc/Webpages.md +++ b/doc/webpages.md @@ -13,4 +13,5 @@ Beneath the page creation box, a list of existing pages will appear with an "edi If you are the admin of a site, you can specify a channel whose webpages we will use at key points around the site. Presently, the only place this is implemented is the home page. If you specify the channel "admin" and then the channel called "admin" creates a webpage called "home", we will display it's content on your websites home page. We expect this functionality to be extended to other areas in future. +#include doc/webpage-element-import.md; #include doc/macros/main_footer.bb; |