## Screem GUI Reference Manual

2000
Matthew Colyer

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found here.

Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps.

This is version 0.2 of theScreem manual.

## Introduction

Screem is a program for editing, uploading and managing websites. Screem is currently under active development at Sourceforge.

This manual is soley intended for giving brief discriptions of the windows, menus and wizards of Screem. If you are looking for a more in depth information please refer to the Screem Users Manual.

## Windows

### Main Window

The main window of Screem houses many important items, such as the tag tree, the file list and the editing notepad. It also has a wealth of buttons and menus. Like any gnome compliant application you can tear off any of the menus. You can also tear off the button panels and place them where you want them. The screem main window is highly configurable and it if you spend the time to learn all of it's neat functions it can pay off in the long run.

#### Main Window

Screem's main window

File tree

The file tree is only used when working on a site, rather than an individual page. It allows you to open pages in the editor, or view other file types with the external application specified for that mime type.

Support is also there for copying, moving, and renaming files. With some HTML editors if you have a group of files in a project and you move or rename one of them then you need to manually go through and update all the links to that file in all your other documents. Not with SCREEM. This is automatically done for you, going through the entire site. The updating of the links in a page that has been moved is not currently implemented.

A right click anywhere on the file tree will popup a menu, allowing you to:

- Create a new page (with the page wizard)

- Create a blank page

- Delete the file/directory that was right clicked on

- Rename the file/directory that was right clicked on

- Open the file that was right clicked on

- Refresh the file tree

Tag Tree

The tag tree is a method used by Screem to give access to commonly used tags. The program is distributed with an full HTML 4.0 branch in the tree. Also if you have Bluefish (a GTK based HTML editor) installed then Screem will build branches of the tag tree out of the PHP3, RXML, and SSI functions that are provided with it.

The tag tree itself is just an xml file, stored in `$prefix/lib/screem/screem.tagtree`. There is currently no graphical editor for the tag tree at the moment so if you want to change the main one then you will need to load the file into the editor and edit it by hand.

As well as reading the tree from the above location (and the Bluefish function files in `$HOME/.bluefish` Screem will also scan `$HOME/.screem` for any . tagtree files. If you have any in there then they will be added to the tag tree upon launching Screem. Again these files will have to be edited by hand, the format can be found by looking at the main distributed tree file

Clicking on an entry in the tag tree will insert the tag (or function) that is specified. If the text has opening and closing tags then the cursor will be inserted between them ready for you to type. If however you have highlighted some text then the tags will be placed around that text

Editing Notepad

For more information check the getting started section.

For each file currently open there are three panels. The first panel contains the text field with the file loaded up so that you can edit it. The second panel contains a preview window for the curent file. The last panel contains a link view of the current page. At the moment this panel is currently unfinished

### Entity Window

#### Entity Window

Entity window

The Entity window provides easy access to all sorts of symbols defined as entitys so that they can be display in HTML. You must have atleast one page open in order to use the Entity window. To use it just pick the entity you want and click insert.

Screem does have auto entity insertion built in. To configure it click here. To learn more about it click here.

### Find Window

#### Find Window

Find Window

The find and replace window finds your regular expression arguments in the current file or the whole project. Once it finds you expression it can replace it. To create a search you just fill out the required fields and check the options you want to use. As the find goes through all your files it lists them in a table so that you can see all affected files.

### Todo Window

#### Todo Window

Todo Window

The todo window displays all the tasks currently listed in the project file. That way when inspiration hits or your one of those poeple that need a check list it's right there for you. You must have a project currently open to use this window.To add a task click the add button and enter the correct information. To edit a task you click on the task. When you have completed a task you can remove it by clicking the completed button.

### Print Preview Window

#### Frame Wizard

Print Preview Wizard

With the print preview window you can examine the output before you print it to make sure nothing is wrong and the margins are fine. You can zoom in and out and go to the next page, the last page, the previous page or the first page. You can also zoom to fit the window. You must be currently editing a page in order for the print preview to work.

You must compile Screem with GtkHtml in order to print rendered HTML.

### Spell Check Wizard

#### Spell Check Wizard

Spell Check Wizard

The spell check is the standard GNOME spelling widget. It goes through and ignores HTML and finds misspelled words and prompts you for action.

## Menus

### Menus

The menu bar, located at the top of the Main Window, provides the following commands:

File

  - New

    - New Site... Launches the Site Wizard to create a site.

    - New Page... Launches the Page Wizard.

    - New Blank Page... Creates a blank page.

    - New Site Template Launches the Site Template Wizard.

  - CTRL+O Open Site... Opens a Screem project file and launches the project.

  - CTRL+S Save Site... Saves the Site definition. NOT THE CURRENT FILE.

  - Save Site As...

  - Close Site...

  - Recent Sites Lists the four most currently edited projects.

  - Open Page...

  - Save Page...

  - Save Page As...

  - Close Page...

  - Recent Pages Lists the four most currently edited pages.

  - Print

  - CTRL+Q Quit

Edit

  - CTRL+Z Undo Undos the last action performed by the user.

  - CTRL+R Redo Undos the undos performed by the user.

  - CTRL+X Cut

  - CTRL+C Copy

  - CTRL+V Paste

  - Clear Deletes selected text.

  - Select All

  - F6 Find ... Preforms searches on all the files in your project.

  - SHIFT+F6 Find Again Repeats the last searched peformed

  - F7 Replace ... Preforms replaces in all the files in your project.

  - Goto Line Goes to the specified line

  - Uppercase tags Changes all tags and tag attributes to upper case tags in the document

  - lowercase tags Changes all tags and tag attributes to lower case tags in the document

  - Convert to XHTML Screem attempts to convert the currently open page to XHTML

  - Select Current Context Selects all the text between the last tag opening to the matching closing tag.

Insert

  - Table Launches theTable wizard.

  - SSI directive Launches theSSI wizard.

  - Link Launches theLink wizard.

  - Image Launches theImage wizard.

  - Frames Launches the Frame wizard.

  - Form Launches Form wizard.

  - Entity Launches theEntity Table.

  - Colour Launches the Color wizard.

CVS

  - Checkout Site ????

  - Update Site ????

  - Update Page ????

  - Import Site ????

  - Commit Site ????

  - Commit Page ????

Tools

  - Upload Launches the Upload wizard

  - CaSSIUS Launches the CSS wizard.

  - Site Template Launches the Site Template Wizard.

Settings

  - Site ... Launches a window that contains site specific information. Such as template files, base directory and upload information.

  - Preferences ... Allows customization of Screem.

Help

  - About shows basic information about Screem, such as author's name and version number.

  - Tip of the day displays the tip of the day dialog, which contains useful tips on using Screem.

## Buttons

### File Buttons

#### File Buttons

File Buttons

- First button - Launches the Site Wizard.

- Second button - Opens a file.

- Third button - Saves the file.

### Copy Buttons

#### Copy Buttons

Copy Buttons

- First button - Cuts.

- Second button - Copies.

- Third button - Pastes.

### Misc. Buttons

#### Misc. Buttons

Misc. Buttons

- First button - Prints.

- Second button - Launches the print preview window.[link it up]

- Third button - Launches the find and replace. [link it up]

- Fourth button - Launches the external browser.

- Fifth button - Launches todo list.[link it up]

- Sixth button - Launches the spell checker.[link it up]

### Tag Lookup

#### Tag Lookup

Tag Lookup

- Selection Field - Choose a tag to look up information on.

- Button - Incorrectly implemented.

### Wizard Buttons

#### Wizard Buttons

Wizard Buttons

- First button - Launches the color browser.

- Second button - Launches the css wizard.

- Third button - Launches the image gallery wiard.

- Fourth button - Launches the image wizard.

- Fifth button - Launches the link wizard.

- Sixth button - Launches the email wizard.

- Seventh button - Launches the table wizard.

- Eighth button - Launches the upload wizard.[link it up]

### Quick Buttons

#### Quick Buttons

Quick Buttons

- First Button - Inserts bold tags.

- Second Button - Inserts italic tags.

- Third Button - Inserts underline tags.

- Fourth Button - Inserts a bulleted list tag.

- Fifth Button - Inserts a numbered list tag.

- Sixth Button - Inserts a decrease indentation tag.

- Seventh Button - Inserts a increase indentation tag.

- Eigth Button - Inserts a left justifed paragraph.

- Ninth Button - Inserts a center justifed paragraph.

- Tenth Button - Inserts a right justifed paragraph.

- Eleventh Button - Inserts a justifed paragraph.

### External Buttons

#### External Viewer Buttons

External Viewer Buttons

- First Button - Launches first configured external browser with the current page.

- Second Button - Launches second configured external browser with the current page.

- Third Button - Launches third configured external browser with the current page.

Note the screenshot might not be the same as your configuration. To configure these buttons click here.

### Form Buttons

#### Form Buttons

Form Buttons

- First Button - Launches form wizard.

- Second Button - Inserts a text area tag.

- Third Button - Inserts an input box tag.

- Foruth Button - Inserts a file input box tag.

- Fifth Button - Inserts a form button tag.

- Sixth Button - Inserts a checkbox tag.

- Fifth Button - Inserts a radio button tag.

- Sixth Button - Inserts a selection list tag.

### Font Buttons

#### Font Buttons

Font Buttons

Not Implemented!

### Table Buttons

#### Table Buttons

Table Buttons

Not Implemented!

## Wizards

### Upload Wizard

#### Frame Wizard

Upload Wizard

For more information concerning the upload wizard click here.

### Gallery Wizard

#### Gallery Wizard

Screem site wizard

The Gallery Wizard can be used to create image galleries from a given directory of images. It allows you to specify how many images per row, and how many rows to have per page. If the number of images in the directory is greater than the number of rows times the number of columns then another page will be created, and links between the two pages will be inserted.

All the images will have thumbnails created which will be links to the full size image. Currently the resulting files will be in the same directory as the images. This plugin can be used without having a site or page open.

### Image wizard

#### Image Wizard

Screem site wizard

The Image Wizard, as you would expect, is to help with inserting images into your HTML pages and as such provides the following features. You must have atleast one page open to use the Image Wizard.

- Preview image in the wizard so you can see what you will be inserting

- Shows initial image dimensions and size

- Auto creation of a thumbnail image if requested (of the size specified by the width/height entries)

- Width and Height number entries so you can calculate a new image size you want to use.

- The ability to copy the image to the pages location (if you are inserting an image from outside your site (or pages) directory

### CSS Wizard

#### CSS Wizard

CSS wizard

The CSS Wizard is a very powerful wizard. For all those who don't know what CSS is, CSS stands for Cascading Style Sheet. A CSS definition can be in it's own file or it can be inline with the rest of the HTML. With CSS you can define a stylesheet for your site. You can change your entire site's look and feel with CSS!

Enough about what CSS is. In order to start using the wizard you must right click and select new style. Then give this style a name so that you can call it in your HTML. Once you have created a style you can use the tabbed notebook on the right to select what attributes you want. You can have as many styles as you want, with as many attributes as you want. At the moment you can not load the CSS files into the wizard to change them so if you want to change the CSS you have to do it by hand.

WARNING: Before you get frustrated with why the style doesn't look the way you want it. The FULL CSS standard is not supported by any browser at the moment. So some of the attributes may not work.

### Email Wizard

#### Email Wizard

Email wizard

The email wizard sends the page currently being edited to the email address specified. If you want to send a friend or a co-worker the HTML page you are working on you can use this wizard. You don't have copy and paste the HTML to another program to send the page in an email. You can just open the wizard and it will do it for you. In order to use this wizard you must have at least one page open. Select the page and click the email wizard button located on the wizard button menu. Once you have the wizard open it is fairly straightforward, you fill out the correct fields and click send email.

### Form Wizard

#### Form Wizard

Form Wizard

The Form Wizard creates HTML forms. You must have atleast one page open in order to use the Form Wizard. To use the Form Wizard just fill out the nessary text boxes and click ok.

### Link Wizard

#### Link Wizard

Link Wizard

The Link Wizard creates HTML link tags. You must have atleast one page open in order to use the Form Wizard. To use the Link Wizard just fill out the nessary text boxes, choose the correct type of link and click ok.

### New Page Wizard

#### New Page Wizard

New Page Wizard

The New Page Wizard creates an skeleton HTML page. The second page prompts for nessary information such as file location as well as non-nessary information such as title and author. It also asks if you want to use a template. If you want to use a template check the chekbox and click the browse button to find the template. On the next page you can set the base colors for the page (such as background color and link colors). After that you have your skeleton page.

### SSI Wizard

#### SSI Wizard

SSI Wizard

The Server Side Include Wizard creates server side includes. Fill out the textboxes in the specific group you need and click apply for that group. When you are done click the close button in the lower right.

Note: In order for Server Side Includes to work your server must support them!

### Table Wizard

#### Table Wizard

Table Wizard

The Table Wizard creates HTML tables. Fill out the textboxes you need and when you are done click the ok button in the lower left.

### Site Template Wizard

#### Site Template Wizard

Site Template Wizard

The Site Template Wizard creates a file and directory structure saved into a Screem specific file. Screem can use this file along with page templates to create a large site skeleton very quickly. When you open up the wizard you see a wizard similar to the CSS wizard. Click on the new file icon to create a new site structure then fill in the information on the right and click add when ready. If you want to create subfiles or subdirectories click on the parent directory under which you want the child and click add. When you have completed the site structure be sure to save it. If you want to make changes to a file you can use the open button to load and make changes as usual.

### Color Wizard

#### Color Wizard

Color Wizard

The Color Wizard is a simple color dialog. You go ahead and move the color cursor to where you want. You can also manually enter the RGB values through sliders or textboxes. When you click okay the wizard produces a quoted hex value that you can use in HTML.

### Frame Wizard

#### Frame Wizard

Frame Wizard

Does this actually work?