From 93ae7b3c229962d28b46ffc7b1890fa72f82c264 Mon Sep 17 00:00:00 2001 From: onefang Date: Mon, 26 Aug 2019 03:45:12 +1000 Subject: Document the web pages. --- doc/web_pages.html | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/doc/web_pages.html b/doc/web_pages.html index ceae37f..4ea5aa3 100644 --- a/doc/web_pages.html +++ b/doc/web_pages.html @@ -3,6 +3,42 @@ + +

In the examples/web directory there are several example web pages. In +the default configuration, these web pages are presented to viewers as +the various web pages that the viewer can display, as might be listed in +the viewers grid manager. They will be available at +http://example.com:8002/web/, or what ever you configured BaseHostname +and PublicPort to be.

+ +

These web pages are just basic, you can customise them to suit your +grid. There are also a few PNG images that you can replace.

+ +

about.html

The web page grid managers will show as "web site".

help.html

The web page grid managers will show as "support URL".

loginpage.html

This is the web page shown in viewers when they pick your grid to log onto.

password_help.html

Viewers will often include this link, usually on the lower right, for helping with passwords.

register.html

Viewers will often include this link, usually on the lower right, for registering new accounts.

stats.html

This is basic stats for your grid, not for viewers. You could register this with stats collection web sites.

SledjHamr.png

The background image used in loginpage.html

SledjHamrIcon.png

A medium sized icon.

SledjHamrIconSmall.png

A small icon suitable for the web sites favicon.

Variables.

In each of these pages you can insert variables that will get replaced with current data using -

+<!--#echo var="variable_name" -->
+

The stats.html file should contain examples and descritpions of all of these variables.

-- cgit v1.1