Documentation
Saint documentation comes in three parts:
- User Guide (HTML) (PDF): Site administration.
- Developer Guide (HTML) (PDF): Site creation.
- API Reference (HTML): Full PHPDoc reference to Saint classes and functions.
Saint User Guide
Table of Contents
1 Introduction
Thank you for using Saint Content Management System (st.cms). This guide will allow you to use your st.cms powered website to its full potential.
2 Saint Menu
The Saint menu is accessable from on any page in your website. By default it will appear near the top right hand corner of the page, but this may change with your site theme. This menu contains all the options we are going to use to edit the website.
3 Site Settings
General site settings can be accessed by hovering your mouse over the Saint admin overlay and clicking the “Settings” button in the menu which appears. Here you may edit settings such as global default keywords, description and title, the location of the blog and shop, and categories which can be used throughout the site (for pages, blog posts, shop items, and more).
4 Label Text
Text on a Saint powered website is displayed through editable labels. All editing in st.cms is started by clicking the Saint logo displayed in the top right corner. This will enable red underlines or outlines on all editable text. Click on a piece of text to begin the editing process. The Saint label editor is a rich text editing environment which includes basic features such as text styling, lists, and links. When you save a label Saint stores the changes internally. You may access these revisions through the toolbar select box which starts listing the “Current” revision.
5 Blocks
After clicking the Saint logo as described in the above section, any editable content blocks will be outlined in red. Click the “Edit” button in the top right of one of these blocks to open the editing screen. There are two types of blocks: Fixed layout and open layout.
The fixed layout blocks will appear on your screen with options in the right hand column and content in the left column. In this case you may click any individual items in the block to modify them or change the settings as you wish. Click the "Save" button to save block settings.
The open layout blocks will appear on your screen in a "What You See Is What You Get" (WYSIWYG) editor. You may edit this content freely as you wish using the tools available. Click the "Save" button to save your changes. For further information on this WYSIWYG editor you can check www.tinymce.com.
5.1 Repeating Blocks
Some blocks in a Saint website are considered "repeating" blocks. An example of this is the blog, in which the posts are repeating blocks. After clicking the Saint logo to start editing you can click the "Add New" button in the top right corner of any repeating block. This may appear as "Add New Blog Post," "Add New Calendar Event" or something else depending on your site's design. From then on you will edit this block as outlined above.
6 Images
Images on a Saint page can be changed through the user interface. After clicking "Edit This Page" as described above, any editable images will be highlighted with a red border. If you click the image it will open the Saint file manager with options to edit the image information such as title, description, tags, and categories. Click "Use This File" to save changes and continue to use this image, or click "Choose New File" to view a list of available images. Click on an image to select it, then click "Use This File" to save your changes.
7 Shop
Products in the Saint shop are repeating blocks. As such the methods to add, remove and edit them are the ones outlined above for modifying blocks. Notice will be sent to the site administrator's e-mail address when an order is received.
7.1 Virtual Products
Virtual products are those with a related file on the server. This file will be sent to users who purchase the product. In order to create a virtual product first upload the file to the “restricted” directory on the server. Then, enter the filename in the products “File” setting. Finally, save the file.
7.2 Discounts
Sale prices may be applied to shop products as a flat amount or a percentage. These discounts may be applied to all products, specific categories, or specific products. To manage discounts click the “Shop” menu option in the Saint admin overlay. This will open the shop manager. Then, click the “Discounts” option in the shop manager menu. You will see a listing of current discounts and an option to add a new discount. Discounts, like products, are editable blocks. Click on a discount or on the add new button to open the block edit screen. The discount type may be “flat” or “percent”.
If the filters section is left blank the discount will apply to all products; otherwise it applies only to products which match at least one of the entered filters. Options may be entered in the form of key:value;key:value; etc. The key may be either “id” or “cat”, matching either a product ID or a category ID. Multiple IDs of either or both types may be entered.
8 Files
To open the Saint file manager click on “Files” in the Saint admin overlay. Here you may edit file related information such as categories, keywords, title, and description. Click on a file to edit it or narrow down your search using the form displayed on the right side. Click “Save” when you have completed your changes.
8.1 Searching for Files
With the file manager open in the right hand column of the screen you will see a form with fields for title, keywords, description, and categories. Enter the information you wish to search for into the form fields and select the categories you wish to include, then click "Search" to filter the files. Click "Reset" at any time to remove the filters.
8.2 Galleries
Galleries are managed using the file category system. To add/remove images from a gallery, add/remove the image from the associated category.
8.3 Slideshows
To manage slideshows, use the same process as outlined in the "Manage Galleries" step above. Slideshows, like galleries, are governed by categories.
8.4 Uploading Files
To upload, start by opening the Saint menu and clicking on "Files". This will open the file manager. Now click the "Upload Files" button located in the top bar of the right side column. Click "Select Files" and choose the files you wish to upload. Then, click "Upload Now" and wait for it to complete.
9 Pages
Saint pages are simply identifiers matched to a layout. This means you can have multiple pages matching the same template but with different data.
9.1 Adding Pages
To add a new page, open the Saint menu and click "Add New Page". In the name section, enter the title of the page. In the identifier section, add a URL-friendly unique code by which to access the page. An example of this is "home" or "contact". Now, select the layout you wish to use. If you are unsure of this you may try different layouts and see the result (consult your web designer for precise details about the available layouts). Next, enter the meta keywords and description that will appear to search engines. Optionally, you may select categories to group pages together.
9.2 Editing Page Data
Click the "Edit This Page" button in the Saint menu. This will open the page information box on the left hand side of the screen. Enter the new data you wish to use in the form box, then click "Save".
