$Id: screens.txt,v 1.2 2002/08/20 09:47:35 howama Exp $

This is intended to give an idea of the screens which will appear in the gui.
It is likely to be altered a lot before the final program release.

This is not complete. 
I have much more to add. Please email me if you require any of the information.
Mark Howard
mh@ ...
http://www.tildemh.com


More Information:
Please see the windows version of index generator for an idea of the screens
to be used. Also, see the early attempt at a gui using kylix (available in
this source).


Tree Structure
--------------

1) If there is no project loaded
+--+ Index Generator - Welcome 
|  |
|  +--+ Load Project / Create New project
| 
+--+ Misc Options 
   |
   +--+ Preferences
   |
   +--+ Scheduling
   |
   +--+ About / Credits


2) If a project is loaded and themes are being used

+--+ Index Generator - Welcome
|  |
|  +--+ Project Statistics / Save / Close / Revert
|  |
|  +--+ Index Type
|  |
|  +--+ Theme Chooser
|  |  |
|  |  +--+ Theme Preview
|  |
|  +--+ Folder List         } File list could be chosen as alterative to this
|  |  |									branch
|  |  |
|  |  +--+ Include Filters  }
|  |  |                     }  Optional
|  |  +--+ Exclude Filters  }
|  | 
|  +--+ Output Location / Start Processing
|  |  |
|  |  +--+ Progress
|  |
|  +--+ Statistics 
|     |
|     +--+ HTML Preview
|     |
|     +--+ Source Preview
|
+--+ Misc Options
...


3) Alternative for Theme Branch (Sitemap type)

+--+ Sitemap Setup
|
+--+ Start code
|
+--+ links
...
TODO: write the rest of these.
(Most of them are the same simple panel with text entry box and some descriptive
text.)


4) Alternative for Theme Branch (Ordered list type)

TODO: This is similar to the sitemap. See program version 2.4 for an example.
email me for more.

Detailed Panel Description
--------------------------

This section will give a detailed description of each panel.

[	
  In many places, this says text should be placed. The wording still has to be
  decided for much of it. Please use constants for all text strings to make
  translations easier.
]

[
  Please remember that this is cross platform code. Use only standard java
  routines, especially for file handling.
]

[
  Hints.
  I would like to create program hints, as seen in Index Generator v2.4. These
  are like popup hints seen in many applications, except they are longer and
  are displayed in a convenient location on the UI (in the bottom left corner).
  These are not essential for the first version, but we should consider how
  they are to be implemented and ensure we do not make this too difficult with
  the other code.
]

Welcome Screen:
top 20%: large border, then a coloured area with background #6CA6D2. A png
image in the leftmost position of this.
To the right, the words Index Generator in large, royal blue. Followed by a
link to http://www.tildemh.com/sw/idgen 
Underneath, a large paragraph of text regarding this being open source
software. (Still to be confirmed)

Load Project:
Top 1/3 - text about projects
middle  left - 
Load button - Bring up file dialog. Default directory is either that of item
at top of recent file menu, or user's home directory.
Underneath, New button, for creating a new project.
Middle right - recent file list.
This is a list of recent files, displaying the project name. (The code for
this is all part of the gui.) The most recently opened project appears at the
top. Double clicking on a project will load it. single clicking will bring up
details in the area below.
Bottom: details of selected item in recent files list.
Project name
File Name
Date Created
Date Last generated 
(These are all from the project settings)
Near the right of this area is a Load button, to load the selected project

Project Loaded:
Gives statistics of current project (similar to end of last screen, but more
verbose)
Near the top: bold text saying *Modified, if it has been modified (This should
be stored in the project configuration)
At the bottom: 3 buttons: Save, Save as, Close


Index Type
Radio Buttons, each followed by large area for text explanation
'Sitemap Type'
	A sitemap links to every page indexed in a hierarchical file system
	manner. This included the popular 'foldertree' dynamic index.
'Ordered List Type'
	An ordered list is a plain list of all the file details, orderd by one
	of many features. This is often used for A-Z indices and clever search
	scripts. 

Theme Chooser
A large button for Advanced settings.
To be decided

Theme preview
To be decided. May be part of theme chooser

--------------------------------------------
Standard settings Screen:
top: 4 lines of explanitary text
middle: Text edit area
bottom: two coloumn table for placeholders and descriptions.
e.g. <!--#Filename-->   | This is for the filename, excluding path details.
Clicking on on of them will copy the placeholder into the current location in
the text edit area. 

Sitemap Settings

Ordered List settings

Folders
Filters
File List

Output Location / Start
Progress
Complete / Statistics
Source preview
Browser preview

Preferences
Scheduler
License
Contributors







