aboutsummaryrefslogtreecommitdiff
path: root/mod/sitepages/README.txt
blob: 2c15bdd7456e87955317a7920d4929b746d214bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Site pages - Quickly generate static pages and customize the front page, CSS, and
HTML metatags.

CONTENTS:
	1.  Overview
	2.  Using ECML on the front pages
	2.1  [loginbox]
	2.2  [sitestats]
	2.3  [userlist]


1.  OVERVIEW

	Site Pages provides a simple way to create static content for About, Terms,
	and Privacy pages, and also allows simple modifications of the logged in
	and logged out views, as well as CSS and meta description and tags for SEO.


2.  USING ECML ON THE FRONT PAGES

	Site Pages supports ECML on the front page and provides the following
	ECML keywords:

	[loginbox] -- A login box.  Required on the logged out front page.
	[sitestats] -- Simple site statistics.
	[userlist] -- A list of users.

	To learn more about ECML, click the ECML icon below the input fields.


2.1  [loginbox]
	The Login Box keyword displays a box to let users log in.  This view
	is required on the logged out front page.


2.2  [sitestats]
	The Site Stats keyword doesn't do anything yet.


2.3  [userlist]
	The User List keyword displays a list of users and takes the following
	optional arguments (*default if not passed):

	list_type=*new|online|random -- Show new users, users active in the
		last 10 minutes, or a random selection.

	only_with_avatars=*true|false -- Only show users who have uploaded an
		avatar

	limit=*10 -- Show this many users.