aboutsummaryrefslogtreecommitdiffstats
path: root/doc/Comanche.md
diff options
context:
space:
mode:
authorfriendica <info@friendica.com>2014-02-27 20:48:10 -0800
committerfriendica <info@friendica.com>2014-02-27 20:48:10 -0800
commit102521844b3d6f31d0d801b0d0c89241c2c621af (patch)
tree9e44dc68fdf76640a3f784b1ae872b960d73a413 /doc/Comanche.md
parentd2bc7c606a6585dc82127717acf2cfe60b45f987 (diff)
downloadvolse-hubzilla-102521844b3d6f31d0d801b0d0c89241c2c621af.tar.gz
volse-hubzilla-102521844b3d6f31d0d801b0d0c89241c2c621af.tar.bz2
volse-hubzilla-102521844b3d6f31d0d801b0d0c89241c2c621af.zip
put schemas in Comanche (this requires theme support (!))
Diffstat (limited to 'doc/Comanche.md')
-rw-r--r--doc/Comanche.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/Comanche.md b/doc/Comanche.md
index 8874e839a..2c3bb914a 100644
--- a/doc/Comanche.md
+++ b/doc/Comanche.md
@@ -6,7 +6,7 @@ Comanche is a markup language similar to bbcode with which to create elaborate a
Comanche primarily chooses what content will appear in various regions of the page. The various regions have names and these names can change depending on what layout template you choose.
-Currently there are two layout templates, unless your site provides additional layouts (TODO list all templates)
+Currently there are two layout templates, unless your site provides additional layouts.
default
@@ -42,6 +42,9 @@ To select a theme for your page, use the 'theme' tag.
This will select the theme named "apw". By default your channel's preferred theme will be used.
+ [theme=dark]redbasic[/theme]
+
+This will select the theme named "redbasic" and load the "dark" theme schema for this theme.
**Regions**
@@ -60,6 +63,11 @@ Your webpage creation tools allow you to create menus and blocks, in addition to
This places the menu called "mymenu" at this location on the page, which must be inside a region.
+ [menu=horizontal-menu]mymenu[/menu]
+
+This places the menu called "mymenu" at this location on the page, which must be inside a region. Additionally it adds the CSS class "horizontal-menu" to this menu. This *may* result in a menu that looks different than the default menu style, *if* the css for the current theme defines a "horizontal-menu" class.
+
+
[block]contributors[/block]
This places a block named "contributors" in this region.
@@ -92,6 +100,8 @@ The 'comment' tag is used to delimit comments. These comments will not appear on
**Complex Example**
+Please note that pasting this example into a layout page is not likely to do anything useful as the chosen names (layout, theme, regions, etc.) may not correspond to any existing webpage components.
+
[comment]use an existing page template which provides a banner region plus 3 columns beneath it[/comment]
[layout]3-column-with-header[/layout]