aboutsummaryrefslogtreecommitdiff
path: root/mod/sitepages/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'mod/sitepages/README.txt')
-rw-r--r--mod/sitepages/README.txt50
1 files changed, 0 insertions, 50 deletions
diff --git a/mod/sitepages/README.txt b/mod/sitepages/README.txt
deleted file mode 100644
index 2c15bdd74..000000000
--- a/mod/sitepages/README.txt
+++ /dev/null
@@ -1,50 +0,0 @@
-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.