aboutsummaryrefslogtreecommitdiffstats
path: root/doc/webpages.bb
diff options
context:
space:
mode:
authorMario Vavti <mario@mariovavti.com>2015-06-04 22:27:55 +0200
committerMario Vavti <mario@mariovavti.com>2015-06-04 22:27:55 +0200
commit33a122aaa8013cded8ce97615169f5c07fb762af (patch)
tree66b1751a93272b9cb7f6ac66c922932cbaa6702f /doc/webpages.bb
parent6e336d680d556594028df8cd611b6411cecf847f (diff)
downloadvolse-hubzilla-33a122aaa8013cded8ce97615169f5c07fb762af.tar.gz
volse-hubzilla-33a122aaa8013cded8ce97615169f5c07fb762af.tar.bz2
volse-hubzilla-33a122aaa8013cded8ce97615169f5c07fb762af.zip
some doco on webpage blocks
Diffstat (limited to 'doc/webpages.bb')
-rw-r--r--doc/webpages.bb80
1 files changed, 78 insertions, 2 deletions
diff --git a/doc/webpages.bb b/doc/webpages.bb
index 780bde45c..040ad0c5c 100644
--- a/doc/webpages.bb
+++ b/doc/webpages.bb
@@ -2,13 +2,89 @@
Red enables users to create static webpages. To activate this feature, enable the web pages feature in your Additional Features section.
-Once enabled, a new tab will appear on your channel page labelled &quot;Webpages&quot;. Clicking this link will take you to the webpage editor. Here you can create a post using either BBCode or the rich text editor.
-
+Once enabled, a new tab will appear on your channel page labelled &quot;Webpages&quot;. Clicking this link will take you to the webpage editor.
Pages will be accessible at mydomain/page/username/pagelinktitle
The &quot;page link title&quot; box allows a user to specify the &quot;pagelinktitle&quot; of this URL. If no page link title is set, we will set one for you automatically, using the message ID of the item.
Beneath the page creation box, a list of existing pages will appear with an &quot;edit&quot; link. Clicking this will take you to an editor, similar to that of the post editor, where you can make changes to your webpages.
+
+[b]Using Blocks[/b]
+
+Blocks can be parts of webpages. The basic HTML of a block looks like this
+[code]
+ <div>
+ Block Content
+ </div>
+
+[/code]
+
+If a block has text/html content type it can also contain menu elements. Sample content of
+[code]
+ <p>HTML block content</p>
+ [menu]menuname[/menu]
+
+[/code]
+will produce HTML like this
+[code]
+ <div>
+ <p>HTML block content</p>
+ <div>
+ <ul>
+ <li><a href="#">Link 1</a></li>
+ <li><a href="#">Link 2</a></li>
+ <li><a href="#">Link 3</a></li>
+ </ul>
+ </div>
+ </div>
+
+[/code]
+
+Via the $content macro a block can also contain the actual webpage content. For this create a block with only
+[code]
+ $content
+
+[/code]as content.
+
+To make a block appear in the webpage it must be defined in the page layout inside a region.
+[code]
+ [region=aside]
+ [block]blockname[/block]
+ [/region]
+
+[/code]
+
+The block appearance can be manipulated in the page layout.
+
+Custom classes can be assigned
+[code]
+ [region=aside]
+ [block=myclass]blockname[/block]
+ [/region]
+
+[/code]
+will produce this HTML
+[code]
+ <div class="myclass">
+ Block Content
+ </div>
+
+[/code]
+
+Via the wrap variable a block can be stripped off its wrapping <div></div> tag
+[code]
+ [region=aside]
+ [block][var=wrap]none[/var]blockname[/block]
+ [/region]
+
+[/code]
+will produce this HTML
+[code]
+ Block Content
+
+[/code]
+
+
#include doc/macros/main_footer.bb;