Beginners Guide
Friday, July 23rd, 2004

Introduction
This document is aimed at people new to the software and explains a little bit about it and some basic usage.

First of all you should always read the installation instructions relating to the release you download - this will always cover basic installation procedure and is enough to get you up and running.

Overview of Software

The software was originally designed as a very simple tool for blogging with Lotus Notes/Domino (back in December 2002), but as more and more features have been added it is now a full blown content management and publishing tool.

Its design aim was to create a tool which could be configured to the nth degree by an end user without the need to change any of the underlying notes design. Therefore people could create web sites using their own wysiwyg tools and if an underlying change was made in the design it wouldn't affect their changes.

Another design aim was to output standards compliant html - so everything the "DX Engine" pumps out is fully compliant - there is also an XHTML option in the configuration document so the output from the engine follows that specification.

The way the software provides this functionality is by using "Templates" and "DXTags". Templates are html documents which contain DXTags and are available for everything that can be configured - from the look and feel of your main screen, your web documents, lists of documents, adding comments etc etc.

If a block of html is used frequently in your site - like a page header then "Template Blocks" can be created so they only have to be edited in one place - there is a seperate document on these.

DXTags are predefined 'markers' where the system will merge set information (for example The Domino Blog Toolkit | ProjectDX.org will insert the title of your website into your html document - and this title comes from the title field within the configuration document). Another example is < $DXRecentSubjects$> - this will insert a list of all the recent documents created within your database.

There are a full list of available "DXTags" within then help documentation. The template that you have downloaded comes fully configured and with all the templates and DXtags that you need to get going.

Templates can be located under the Templates section within the navigation bar. You can select which template you want to use for each person within the configuration document under the Templates Tab.

Image:Beginners Guide

Image:Beginners Guide

All system settings are held within a single "Configuration Document" - this can be located within the navigation bar - under Configuration and then Site Configuration. There will be a full document on all settings found in here.

Image:Beginners Guide

Creating a User Profile

This is covered in the installation guide but I will mention it again here. Within content documents fields like author and location can be autopopulated if a user profile exists for you - this will save time when creating new documents.

If you want to use the "Location" field (ie where you created the content - ie Home/England, Work or Leicester/England etc) within documents then you need to create some location records via the Locations view in the configuration section (see above image). Click "Add Location" to create a new one - the document is a single field so should be easy to create.

To create a User Profile you will need to goto the configuration section and select the "User Profiles" view (see above image) - Click "Add User Profile".

Your name and Notes Name should auto-populate (if you are adding a profile for someone else then you can edit these - the software allows for team/group blogging/publishing etc). The email/website address etc fields are not mandatory but are picked up and used if you respond to comments/discussion within your Notes Client.

Again the default location field is not mandatory but if you select a default location then this is picked up when you create content.

We shall ignore the advanced tab for now as I will cover this in another document - but it allows you to set different "skins" etc for different people when they access the site.

Creating Content

To add content to your database there is a "Create New Entry" button within all the Content views (the views at the top of the navigator - ie "Recent Content".

Clicking on this button will open up a new document screen which you can create Rich Text content using your notes client - add direct html if you wish - import images using your notes client etc. You can also categorise content, secure content, set content expiry/publish dates etc etc - further documentation will be available on all these subjects.

By default all content is created in "Draft" mode - when you want to publish your content you will need to set the status to "Published". There is a selection box to do this on the top right of the screen.

Image:Beginners Guide

The creation time/date is set automatically but you can change it if you wish. Should you wish the document to be automatically published at a future date then set the creation date/time to that point and set the document status to "Held" and when you save the system will do the rest automatically.

The page name field is generally not needed unless you want to specify your own page name (this is the name the system uses as part of the url) as it is automatically generated. There are options in the configuration document to have this set automatically from your subjet field - there will be a seperate document on this.

The subject field needs filling in together with any content you wish to add within the rich text field.

Image:Beginners Guide

The Author and Location fields will populate automatically if you have set up a user profile as mentioned above.

Other non essential settings in this document are:
  • Categorisation tab where you can categorise your content (2 Levels) and secure your content etc.
  • Text/html tab where you can just type in straight html and the inbuilt parser will not touch it.
  • Short Description Tab - this content is autogenerated from your main content and is used by the RSS output for people with feed readers as a brief description of your content. This description can be edited by you and there is a lock option to stop the system overwriting it when you save.
  • Miscellaneous Tab - here you can set things like alternate stylesheets/document templates and document expiry dates.
  • Discussion Tab - a list of all the discussion for this content - whether it be from a browser or Notes Client.

Once you are happy with your content - save/close the document and the system will publish it and automatically update its latest lists etc.

This document is only intended as a brief introduction and there are other documents taking each section into more detail - however anything which is unclear or you want more information on post them here so other people can see the questions and responses.

View Comments/Trackbacks

Location: Leicester, UK

Beginners Guide (Vitor Pereira 06/08/2004 23:02:11)
Beginners Guide (Steve Castledine 08/08/2004 20:16:24)
Beginners Guide (Steve Castledine 08/08/2004 20:17:01)
Welcome back (Mike Werner 09/08/2004 09:00:37)
Welcome back (Steve Castledine 09/08/2004 09:12:24)
Local ? (Mike Werner 09/08/2004 11:15:02)
Local ? (Steve Castledine 09/08/2004 11:59:13)
Beginners Guide (Vitor Pereira 23/08/2004 10:45:27)
Beginners Guide (Steve Castledine 23/08/2004 10:53:49)
Beginners Guide (Jakes 26/08/2004 20:30:37)
Beginners Guide (Steve Castledine 29/08/2004 14:31:10)
Beginners Guide (Raymond Hoogerdijk 14/09/2004 20:42:25)
Beginners Guide (Steve Castledine 14/09/2004 22:36:16)
Beginners Guide (Raymond Hoogerdijk 15/09/2004 17:43:24)
Beginners Guide (Steve Castledine 15/09/2004 18:34:07)
Beginners Guide (Emmanuel Patricio 22/11/2004 08:49:35)
Beginners Guide (Emmanuel Patricio 22/11/2004 08:54:03)
Beginners Guide (Leonardo Burci 22/11/2004 11:23:37)
Beginners Guide (Steve Castledine 22/11/2004 15:33:56)
Beginners Guide (Steve Castledine 22/11/2004 15:34:48)
Beginners Guide (Uwe Brahm 29/11/2004 09:13:20)
Beginners Guide (Steve Castledine 29/11/2004 11:44:06)
Beginners Guide (Jack Ratcliff 22/12/2004 19:19:16)
Beginners Guide (Leonardo Burci 22/12/2004 19:31:29)
Beginners Guide (Steve Castledine 22/12/2004 20:41:25)
Beginners Guide (Jack Ratcliff 24/12/2004 00:31:34)
Beginners Guide (Steve Castledine 24/12/2004 15:39:40)
Beginners Guide (Jack Ratcliff 24/12/2004 17:18:16)
Beginners Guide (Steve Castledine 24/12/2004 17:26:33)
Beginners Guide (Andrew Kelly 17/01/2005 07:16:01)
Beginners Guide (Steve Castledine 17/01/2005 19:16:47)
Beginners Guide (Matt Turany 23/02/2005 05:33:12)
Beginners Guide (Steve Castledine 23/02/2005 17:34:06)
Beginners Guide (Matt Turany 24/02/2005 07:35:47)
Beginners Guide (Steve Castledine 24/02/2005 16:13:16)
Beginners Guide (Steve Castledine 24/02/2005 16:13:42)
Beginners Guide (Steve Castledine 24/02/2005 16:14:59)
Beginners Guide ( 24/02/2005 17:58:25)
Beginners Guide ( 24/02/2005 17:58:39)
Beginners Guide (Steve Castledine 25/02/2005 14:56:02)
Beginners Guide (Steven Rieger 30/03/2005 03:51:36)
Beginners Guide (Dave Much 07/11/2005 17:41:23)
Beginners Guide (Steve Castledine 07/11/2005 21:34:24)
Beginners Guide (Dave Much 10/11/2005 15:42:00)
Beginners Guide (Steve Castledine 11/11/2005 12:43:40)
Beginners Guide (Adrian Hudson 12/11/2005 21:20:41)
Beginners Guide (Steve Castledine 14/11/2005 12:24:18)



Powered by ProjectDX Live Content Engine