Web Wizard

OpenOffice.org 2.0

spec rev. 1.7

Task ID(s)

Category	Specification Affects

Wizards

Abstract

This document will guide the developer through everything he needs to know when he is starting to program and design the completely new Web Wizard.

This specification contains all information about the current situation of the Web Wizard in OpenOffice and shows the solutions for the future.

The new Web Wizard is described in all details in this document.

i-Team

Specification Owner	Ilko Hoepping	Ilko.Hoepping@sun.com
User Experience (UX)	Matthias Müller Prove	Mprove@sun.com
Development (DEV)	Ron Piterman	Ron.piterman@sun.com
Quality Assurance (QA)	Hasan Ilter	Hasan.Ilter@sun.com
Documentation (DOC)	Uwe Fischer	Uwe.fischer@sun.com

Specification Reviews

Version	Reviewer	Comment
Reviewed by UX 08/15/03	Matthias Müller-Prove	several comments inline
08/18/03	MMP	Commenting...
<Date>	MMP	
UI String Review March 19, 2004	Elizabeth Matthis	completed
Reviewed by DEV <Date>		
Reviewed by QA <Date>		
Reviewed by DOC March 4, 2004	UFI	added comments after first review
UX 1.7		
DEV 1.7	RP	
QA 1.7		
DOC 1.7		

Document History

Version	Author	Comment
Draft 17.07.2003	IH	First draft
07/30/03	IH	Detailed specs
08/01/03	IH	Scribbles and Ron's edits added
08/05/03	IH	Web Wizard UI picture added
08/07/03	IH	Technical details first draft
08/08/03	IH/RP	Technical details corrections
08/10/03	IH	Some little corrections
08/13/03	IH	Changed the order of the steps and edited some texts.
08/14/03	IH	Edited some technical details
08/15/03	IH/RP	Steps reduced to six. Screenshots of the different steps added
08/20/03	IH	Inserted corrections and notes from MMP, edited some texts and added new technical dependencies and descriptions of some steps
08/21/03	IH	New screenshots inserted and new texts added in the programming details of the steps
08/26/03	IH	Changes according to DL and our team
08/29/03	IH	Latest screenshots inserted
09/05/03	IH	Methods of different previews changed
09/30/03	IH	Added a new step and new screenshots
10/29/03	IH	Latest review
11/17/03	IH	Modified according to the comment of MMP and RP
01/21/04	IH	added the latest tweaks in UI and Usage
03/03/04	RP	Added english resource strings
03/03/04	IH	Added german translation of resource strings
17/03/04	EM	Made changes to strings in preliminary string review
18/03/04	RP	Updated spec to include new dialog designs and string changes
	EM	Made final string changes
06/18/04	MMP	corrected URL for this spec
Final <Date>		
07/19/04	RP	Added Appendix Changed Screenshots Changed Strings
08/02/04	MMP	reference to File Menu. “Web Wizard...” menu item is defined there.
08/13/04	RP	Removed yellow markings. Added resource 151 (cooridinated with EM)

Contents

Glossary	1

References	1

1	Motivation (Current Situation in OpenOffice.org 1.1)	1

2	Goals	1

2.1	How does this feature meet the requirements	1

2.2	How does this feature improve the program architecture	1

3	Dependencies	2

3.1	Technical Dependencies / Requirements	2

4	Detailed Specification	2

4.1	Menu Integration	2

4.2	Six Steps Overview	2

4.3	Technical details of the steps (including programming and UI details)	4

Starting the Wizard – FTP Proxies check	4

Step 1: Introduction	4

Step 2: Choosing files	7

Step 3: Apply layout	11

5	Step 4: Customize layout	12

Step 5: Apply styles	14

General	15

About styles	16

Selecting new icon set:	17

Step 6: General information	17

Step 7: Customize/Save, Generate and Publish	20

Header texts for the different steps:	25

11.2	Error Conditions	28

5	Future Tasks	29

6	Notes	29

7	References	29

12	Appendix A : Revision	30

12.1	Web Wizard	30

12.2	Summary und Decisions of ITeam Meeting	30

Participants (in order of arrival :-) )	30

This document:	30

Intrudocution	30

Issues	30

General:	30

When is the finish button enabled.	30

FTP Proxies warning	30

Load settings: To press or not to press (the load button) – that is the question.	31

Load settomgs: To load or not to load (the last settings automatically) ...	31

Export Listbox should be separated from Doc-Info (UI design step 2)	31

Add & remove buttons are to small. (Ui Design step 2)	31

Export formats (which should be available)	31

String length of title in step 4 (UI design step 4)	31

defaults for step 4.	32

design of step 5 (UI design)	32

Focus-rectangle in Icons Dialog	32

Creating a sub directory on local target on finish.	32

Step 7 – path textboxes not editable.	32

Step 7 – title label (“click...”) to long.	33

Dialog as Standalone/with background document.	33

General comment to narrow UI design.	33

Functions which are not specified in the specs.	33

Export target filename: original filename or entered title.	33

Additional Issues	33

20. Final Confirmation	33

Glossary

Term	Description
<Term 1>	

References

General Specification for UI Design of Wizards can be found on

http://specs.openoffice.org/ui_in_general/index.html

Motivation (Current Situation in OpenOffice.org 1.1)

The current Web Wizard in OOoo 1.1 is a very simple construction that assembles a template content and a template style to create a very simple HTML document.

The output of the current Web Wizard is almost unusable. Just one example, in the content area it uses forms with which you do not get a final result that really works.

The visual styles look dated. They represent the state of web design of the beginning and mid 90s.

The current Web Wizard can not be extended by simply editing the styles – so we have to find a new concept.

Goals

The OOo user without any internet know-how should be able to assemble many different OOo documents to a web site and to put this site onto the internet. The different documents have to be organized with a simple content page and navigation. The Wizard should not create any kind of content but the content pages and navigation areas by themselves. The templates used for the Wizard have to be very simple and clean.

The user should be able to choose the format (HTML, flash, svg, jpg ...) for saving the different OOo documents in web format. If the user does not want this to do the wizard should have mechanism to choose the formats – for this we need a simple auto detection for document content.

The wizard creates a content page for the web site out of the headline or page/slide titles of the different OOo documents. The style of the content page and all other pages of the web site is build with the help of simple style templates. The user should be able to create his own style templates.

If the wizard has been used for creating the first web site all the settings can be saved and used as a kind of magic hat for further usage of the wizard. We will use this concept for other wizards also. You can read more about this concept in the general specification for the new wizards.

The wizard gives the user the possibility to preview the web site in a web browser and then give the user the features to put the content onto the internet.

How does this feature meet the requirements

The OOo user expects OOo to help him with publishing and maintaining his own documents in the internet.

How does this feature improve the program architecture

The OOo architecture will be improved through the possibilities of the wizard to put the content into the internet and keep it up-to-date.

Dependencies

Technical Dependencies / Requirements

The feature of putting the content into the internet depends on OpenOffice.org's possibilities to communicate via FTP or other protocols (e.g. WebDAV) with servers in the internet. It also depends on OOo's features of converting OOo documents to the different formats used in the web.

The main and general components for programming the basic features of all our wizards will be developed separately from this project.

You can find everything about this in:

http://specs.openoffice.org/ui_in_general/index.html

To generate the needed tree view we need this component to be accessible on the API by Java. At this moment this is not possible. We have to find someone who will create the necessary services.

For the export of some kinds of documents we need new export methods that have to be programmed for this wizard: e.g. the export of impress documents to HTML is under some circumstances problematic because it only generates pictures of the content, we need a totally new method here, combining HTML text and pictures.

The saving in different archive formats needs this possibility to be accessible within OOo.

Detailed Specification

Menu Integration

The Web Wizard can be found in File->Wizards->Web Wizard. Please see [File Menu] for string table.

Six Steps Overview

The Wizard has six different steps. They are:

first step: introduction

second step: collecting and sorting/structuring files

third step: apply layout

fourth step: customize layout

fifth step: apply styles

sixth step: setting general web site info

seventh step: customize/save and publish

General description of the steps

First Step:

In the first step the user will get an introduction what the Web Wizard will do for him.
The user should know what he can expect from the wizard and he also should know what
the wizard cannot do for him.

Second Step:

In the second step the user will collect his different OOo files and then sort his documents and give them a structure for publishing them on his web site.

The user will have the option to set the export formats for his different documents. If he will not choose anything here the wizard will use the default settings for that specific kinds of documents.

Third Step:

In the third step the user will choose between different layouts (e.g. with or without Framesets) and he can set the positioning and size of the navigation on his web site.

Fourth Step:

In the fourth step you will be able to further customize the layout.

Fifth Step:

In this step the user will choose styles (contain Backgrounds, Colors, Images, Fonts ...) for his web site. He selects from preset styles that should be very simple and clean.

Sixth Step:

In this step the user will be able to input general info and settings for his web site. The information to put in here could be: Date, Names, Site Title, Content Info, Copyright ...

Seventh Step: The user will get a summary of all his input in the wizard and here the user must be able to customize some saving settings for his different documents. In this step he also has the option to preview some content of his web site in any of his browsers.

In this last step the user will be able to save all the settings he made in the wizard, generate the web pages, and publish it per FTP onto the internet or save it on the harddisk.

Technical details of the steps (including programming and UI details)

Step 1: Introduction

In the right pane of this step there should be text about what this wizard does.

What will this wizard do for you?

The Web Wizard will help you to publish your documents on the internet.

It will convert your documents so that they can be viewed by a web browser, and it will generate table of content pages that will link to your web-published-documents. You also will be able to choose and customize the design and style of your pages.

The wizard will help you to maintain your documents on the web, keep them up-to-date and occasionally add new documents or remove documents. The Web Wizard will give you the option to save your web-publishing-settings. This will help you to easily update your site later.

If the user wants to use his own saved Web Wizard setting there is a button to load his own saved settings in this step.

The first step shows the introduction to this wizard for the user.

General

The saved settings will all be stored in the Web Wizard area in OOo section of the registry . The user will not have control over this data. He can only save, load or delete saved sessions.

Loading a session might take some time (depending on the number of documents to publish in it - since every document must be “validated”: the wizard makes sure each document exists, and reads some general document properties like title, author ect.) Therefore, when loading a session, a status dialog pops up, indicating the progress. See Screenshot 2 Step 1 : Load session status dialog

When deleting a session, a warning dialog comes up and asks for confirmation.

Screenshot 1 Step 1 : Introduction

Screenshot 2 Step 1 : Load session status dialog

#	control	English	German	Comment
1	Label	Web Wizard	Web-Assistent	
2	Label	This Web Wizard is to aid you in publishing documents on the Internet.\n\nIt will convert the documents so that they can be viewed by a web browser. In addition, it will generate a Table of Contents page with links for easy access to the documents. The Web Wizard will also allow you to customize the design and layout of your web site.\n\nYou will be able to keep the documents you have published on the web up-to-date and add or remove documents at any time.	Der Web-Assistent hilft Ihnen Dokumente im Internet zu publizieren. \n\nIhre Dokumente werden so konvertiert, dass sie in einem Internet-Browser angezeigt werden können. Weiterhin wird ein Inhaltsverzeichnis erstellt, das Verknüpfungen auf Ihre einzelnen Dokumente enthält und einen einfachen Zugriff auf diese ermöglicht.\n\nDer Web-Assistent gibt Ihnen weiterhin die Möglichkeit, das Layout und Design der Webseite zu ändern.\n\nSie werden jederzeit in der Lage sein, die Dokumente, die Sie im Internet veröffentlicht haben, zu pflegen und auf Stand zu halten sowie Dokumente hinzuzufügen oder zu entfernen.	Note: the \n\n marks a double paragraph break, and should not have a space after it.
4	Button	~Delete	~Löschen	
5	Label	Introduction	Einleitung	
36	Label	~Choose Web Wizard settings	Wählen Sie die ~Einstellungen für den Web-Assistenten aus	Title of the list box
118	DialogTitle	Loading web wizard settings...	Einstellungen werden geladen...	Title of the status dialog
122	Roadmap	Introduction	Einleitung	
123	Roadmap	Documents	Dokumente	
124	Roadmap	Main layout	Hauptlayout	
125	Roadmap	Layout details	Layoutdetails	
126	Roadmap	Style	Formatvorlage	
127	Roadmap	Web site information	Informationen zur Webseite	
128	Roadmap	Preview	Vorschau	
130	Message	The selected settings will be deleted.\n\nDo you really want to delete these settings?	Die ausgewählten Einstellungen werden gelöscht.\n\nMöchten Sie diese Einstellungen wirklich löschen?	
142	Listbox	<default>	<standard>	

Step 2: Choosing files

In this step the user will choose the files he wishes to publish in his web site.

He can add and remove files and he can sort his documents in the hierarchy.

The user will be able to sort his document.

The user can edit the properties of the different documents in this step. The document properties the user selects in the next step will be shown in the table of contents pages.

One of those properties are the export to web options.
Different export options of OOo documents to internet formats:

Writer -> HTML / PDF / original

Impress -> HTML with images / PDF / Flash / Original

Calc -> HTML / PDF / Original

Draw -> HTML (images) / PDF / Flash / Original

The user will be able to select his different files and switch between different saving and formatting options.

The user will also have the possibility to select the options for the saving formats (e.g. Quality of JPEG Export).

Screenshot 3 Step 2: Collecting and customizing documents (Note: The listbox under “Documents” will be a Tree View and not a Listbox)

Screenshot 4 Add Documents status dialog

#	control	English	German	Comment
6	Label	Select the documents you want to publish	Wählen Sie die Dokumente aus, die Sie veröffentlichen wollen	
8	Label	Document information	Dokumentinformation	
9	Label	~Title:	~Titel:	
10	Label	~Summary:	~Zusammenfassung:	
11	Label	Au~thor:	Au~tor:	
12	Label	~Export to file format:	~Exportieren im Dateiformat:	
37	Label	Web site content	Webseite-Inhalt	
38	Button	~Add...	~Hinzufügen...	
39	Button	Remo~ve	Entfer~nen	
92	OpenDialogFilter	%PRODNAME documents	%PRODNAME-Dokumente	Add dialog; Translators! This variable will be replaced at runtime by either StarOffice or StarSuite. Do not change the variable!
93	OpenDialogFilter	Microsoft Office documents	Microsoft Office-Dokumente	Add dialog
94	OpenDialogFilter	Graphics files	Grafikdateien	Add dialog
95	OpenDialogFilter	All files	Alle Dateien	Add Dialog
120	Label	Validating documents...	Dokumente überprüfen...	Add documents status dialog

Configuration strings

control	English	German	Comment
Listbox	Original file formal	Original-Dateiformat	
Listbox	HTML	HTML	
Listbox	PDF - Print optimized	PDF - Optimiert für Druck	Matches the term used in PDF options dialog
Listbox	PDF - Press optimized	PDF - Optimiert für Druckvorstufe	Matches the term used in PDF options dialog
Listbox	Flash	Flash	

General

In this step the user selects the documents he wishes to publish.

The wizard makes it possible to publish ANY type of documents. If the user chooses a file which the wizard cannot convert to a web format (e.g. EXE, MP3, ect.) the wizard will publish the file in original format.

The wizard uses a concept of table of content pages. There are two possible scenarios:

There is only one table of content page. In this case, the table of content page will have a hierarchical structure, like the tree the user creates in this step.

There are more than one table of content pages. In this case, table of content pages will be flat, containing both links to documents, and links to sub pages.

Adding Files

The user can click the “Add Files” button to add files. A “File Open” dialog appears, in that the user can choose multiple files.

The files are always added after the selected item in the list/tree. It is possible to do a multiselection of files.

Removing documents

To delete a document, the user has to click the “remove” button. Files will be removed without a prompt (since we do not “delete” the files, but mereley remove them from the list).

Changing the order of the documents.

By choosing a document, and then clicking the up and down buttons, the user can change the order of the documents.

Document Properties

When the user selects a document in the list view, the document properties appear in the right pane of the dialog: “Title”, “Description”, “Author” and “Destination Format” (to which the document in the export will be converted to).

The wizard takes this properties if possible from the OOo document. The user can change this properties. The changes will not apply to the documents but to the wizard settings only.

Destination format

The destination formats are: HTML, PDF, Flash, GIF, JPG, PNG and Original. Not all Formats are available for all types of documents.

Dependent on the document, the wizard will try to choose the format which best suits.

In general, Writer documents will be converted to HTML or PDF. Draw documents to PDF, GIF or JPG. Calc Documents to HTML or PDF. Impress documents to PDF, Flash or a combination of HTML and JPGs/GIFs.

Step 3: Apply layout

In this step the user will apply the layout for his web site.

The layout of the page defines the layout of the table of content pages and the placement of the navigation and other elements.

We will let the user choose between different default template layouts. There will be layouts with and without framesets and in different states of complexity.

General

A list of layout icons visualizes the available layouts.

When the user clicks a layout icon, a verbal description of the layout appears underneath the graphics.

About Layouts

The list of layouts will not be “user extendable”. the user can not create his own layouts.

In order to create the table of content pages we should use XSLT which is a kind of XML templates language. This will help us to create new layouts or change existing layouts, without the need of “programming”, but through creating new “Templates”, thus expanding the abilities of the wizard.

If we find out that need to create a new “DHTML menus layout” or to create a layout using JavaScript for whatever reason there is, we are able to easily achieve that also by just writing a new template.

Screenshot 5 Step 3: Setting the layout (Note: The graphics used in this screenshots are not original, they are only used for the specification)

#	control	English	German	Comment
40	Label	Choose a layout for the table of contents of your web site	Wählen Sie ein Layout für das Inhaltsverzeichnis Ihrer Webseite	
48	Label	~Layouts:	~Layouts:	

Configuration strings

control	English	German	Comment
Imagelist	Table with 3 columns	Tabelle mit 3 Spalten	
Imagelist	Table with 2 columns	Tabelle mit 2 Spalten	
Imagelist	Simple	Einfach	
Imagelist	Diagonal	Diagonal	
Imagelist	Zigzag	Zickzack	
Imagelist	HTML frameset, left	HTML-Frameset, links	
Imagelist	HTML frameset, right	HTML-Frameset, rechts	
Imagelist	HTML frameset, top	HTML-Frameset, oben	
Imagelist	HTML frameset, bottom	HTML-Frameset, unten	

Step 4: Customize layout

The user will also be able to select which of the different properties of his documents should be shown on the table of content pages.

When the user clicks the “next” button in this step the preview of the top level table of content page will be rendered in the background. This is needed for the preview of the layout and for the preview of the different styles in the next step.

Screenshot 6 Step 4: Customize the layout

In this dialog the user can choose which properties of the documents should be displayed in the table of contents areas. The default properties will be : Title, Description, Author, File Format icon, Creation Date, Size in KB. The user can also set the optimal layout size.

EM->IH/RP: please get rid of the dividing line because it is not consistent design to have no line next to the top directive, but a line next to the bottom directive. (For consistency)

#	control	English	German	Comment
50	CheckBox	~Description	~Beschreibung	
51	CheckBox	~Author	~Autor	
52	CheckBox	Cr~eation date	~Erstellungsdatum	
53	CheckBox	~Last change date	Datum der letzten ~Änderung	
54	CheckBox	~File name	~Dateiname	
55	CheckBox	File forma~t	Datei~format	
56	CheckBox	File format ~icon	Dateiformatsymbol	
57	CheckBox	N~o. of pages	N~r. der Seiten	
58	CheckBox	~Size in KB	~Größe in KB	
60	Label	Customize the selected layout	Anpassen des selektierten Layouts	
61	Label	Include the following information for each document in the table of contents:	Aufnehmen der folgenden Elemente in das Inhaltsverzeichnisses eines Dokumentes:	
62	Label	Optimize the layout for screen resolution:	Layout optimieren für Bildschirmauflösung:	EM->RP/IH: NO TRAILING SPACES ALLOWED anywhere, please make sure none are used in the resource file.
64	GroupButton	~640x480	~640x480	
65	GroupButton	~800x600	~800x600	
66	GroupButton	~1024x768	~1024x768	

Step 5: Apply styles

In this step the user can choose the styles for his web site.The styles (colors and images) will be technically organized in CSS files for the user accessible through a combobox.

Each style will consist of :

background color

background images

font / font sizes

link color / visited link color / active link color

graphics for the navigation images: bullet/back/forward/top/home/email

A preview field will display the actual choosen graphics combination.

There will be CSS files that define this all.

In the background page (behind the wizard dialog) the user will see a preview of the actual top level table of content page. If the user changes some of the styles this preview will be updated on the fly.

Screenshot 7 Step 5: Setting the style

#	control	English	German	Comment
41	Label	Select a style for the table of contents page	Wählen Sie eine Formatvorlage für die Seite mit dem Inhaltsverzeichnis	
42	Label	~Style:	~Formatvorlage:	
136	Label	Background Image:	Hintergrundgrafik:	
137	Label	Icon set:	Symbolsatz:	
138	Label	The icon set is used for presentations in HTML format.	Der Symbolsatz wird für Präsentationen im HTML Format verwendet.	
140	Button	Choose...	Auswählen...	background
141	Button	Choose...	Auswählen...	iconset
144	Textbox	<no background image>	<keine Hintergrundgrafik>	
145	Textbox	<no icon set>	<kein Symbolsatz>	

Configuration Strings

control	English	German	Comment
Listbox	Beige	Beige	
Listbox	Bright	Hell	
Listbox	Bright Blue	Hellblau	
Listbox	Gray	Grau	
Listbox	Blue	Blau	
Listbox	Contrast	Kontrast	
Listbox	Blue & Black	Schwarz & Blau	
Listbox	Dark Red	Dunkelrot	
Listbox	Light Gray	Hellgrau	
Listbox	Forest	Wald	
Listbox	Orange & Blue	Orange & Blau	
Listbox	Marine	Marine	
Listbox	Orange	Orange	
Listbox	Ice Blue	Eisblau	
Listbox	Water	Wasser	
Listbox	Blue & Gray	Blau & Grau	
Listbox	Red	Rot	
Listbox	Colorful	Farbenfroh	
Listbox	Green & Red	Grün & Rot	
Listbox	Violet	Lila	
Listbox	Green	Grün	

General

In this step the user will set the style of the web site. On the top the user can choose between different default style templates. The style is the definition of colors, fonts, background images and navigation graphics.

About styles

The styles will be a combination of css and an icon set used for the navigation on the pages.

The different templates the user can select will define the colors, fonts, background images and icon sets.

List of color combinations: (foreground/background and images)

Blue/White – Orange

Green/White – Dark-Green

Bright Red/Red – Red

Violet/White – Violet

Grey/Black – Grey

Violet/Orange – Orange

Green/White – Red

Black/Green – Green

Beige/Green/T. - Green/T.

Mint/Dark Green – Grey

Blue/Yellow – Red

Blue/White – Blue

The template styles itself have to be defined in CSS templates.

Selecting new background image:

Screenshot 8 Background dialog

#	control	English	German	Comment
71	Label	%START..%END/%TOTAL	%START..%END/%TOTAL	1..12/101
98	DialogTitle	Background images	Hintergrundbilder	
99	Label	Choose a background image:	Wählen Sie ein Hintergrundbild:	
102	Button	Other...	~Andere...	
103	Button	None	~Keine	

Note:

On the bottom of the ImageList, the filenames of the images are displayed.

Selecting new icon set:

Screenshot 9 Icons Dialog

#	control	English	German	Comment
100	DialogTitle	Icon sets	Symbolsätze	
101	Label	Choose an icon set:	Wählen Sie einen Symbolsatz:	

Configuration Strings

control	English	German	Comment
ImageList	Round, 3D, blue & gray	3D, rund, blau & grau	
ImageList	Round, 3D, blue & green	3D, rund, blau & grün	
ImageList	Cubic, 3D, orange & blue	3D, Würfel, orange & blau	
ImageList	Round, flat, black & gray	Flach, rund, schwarz & grau	

Step 6: General information

In this step the user can enter general information about his web site there should be text input fields for:

Creation Date / Update Date,

Creator Name / Site Title,

Favicon(file field)

Content Info / Keywords / Copyright notice / Email address

The wizard will put these input into the HTML header section of the web site. The default values for this fields will be taken out of the document properties or the user data of the OOo program.

The site will also include the author and updated info as text on the site.

Defaults:

The Title will be by default “My $PRODNAME Documents”

The Keywords: “OpenOffice”, User's name (taken from OOo user settings).

Created Date, Updated Date will be set automatically.

Revisit is default set to 7 days.

Email will be taken from OOo user settings.

Copyright notice:©2003 all right reserved to “User's firstname User's lastname”

Year: will be the current year .The user's first and last name will be taken from OOo user settings.

Screenshot 10 Step 6: General Information

#	control	English	German	Comment
13	Label	Enter general information for your web site	Geben Sie allgemeine Informationen über Ihre Webseite ein	
14	Label	Title:	~Titel:	
16	Label	Description:	~Beschreibung:	
18	Label	Created:	Erstellt am:	
20	Label	E-mail:	~E-Mail:	
21	Label	Copyright notice:	Co~pyright-Hinweis:	
22	Label	Modified:	Geändert am:	
139	Label	Meta data	Metadaten	

Step 7: Customize/Save, Generate and Publish

In this step the user will get a summary of his input. He will see all his selected documents in list or hierarchical view.

A “preview” button will enable the user to preview one(!) document or the TOC in his standard web browser. We will not display more than one document because we want a quick preview.

In this last step the user will save and publish his web site. So we need text input fields for his FTP settings (server, directory, name, password) and a checkbox and a file save dialog box for saving the web site on the harddisk. In the bottom of the right pane of this step the user will have the possibility to save all his Web Wizard settings for later usage.

Screenshot 11 Step 7: Customize/Save/Publish

#	control	English	German	Comment
24	Button	~Preview	~Vorschau	
25	Label	Where do you want to publish your web site?	Wo wollen Sie ihre Webseite veröffentlichen?	
26	Label	Publish the new web site:	Neue Webseite veröffentlichen:	
27	CheckBox	To a ~local folder	In einen ~lokalen Ordner	
28	Button	...	...	
29	CheckBox	To a ~web server via FTP	Auf einen ~Webserver per FTP	
31	Button	~Configure...	~Einstellen...	
32	CheckBox	To a ZIP ~archive	In ein ~ZIP-Archiv	
33	Button	...	...	
34	CheckBox	~Save settings (recommended)	~Einstellungen speichern (empfohlen)	
35	Label	Save ~as:	Speichern ~als:	
59	Label	Click 'Preview' to see a preview in your default browser:	Klicken Sie auf 'Vorschau', um eine Vorschau des Inhaltverzeichnises in Ihrem Standard-Browser zu sehen:	
96	OpenDialogFilter	~ZIP archive files	~ZIP-Archiv Dateien	
121	Filename	MyArchive	MeineArchive	default filename for zip files
135	Textbox	Web Wizard Settings	Web Wizard Einstellungen	The default name for a saved session

Screenshot 12 Step 7: Save/Publish – with FTP disabled

#	control	English	German	Comment
24	Warning label	Publishing via FTP Proxy is not supported.	Veröffentlichen via einen FTP Proxy wird nicht unterstützt.	

General

In this last step the user can: preview a document, specify the destination directory/FTP Server or ZIP file and specify the name of his settings for later update/change.

Preview

If the user presses the preview button he will get a preview of his actual TOC page in the standard browser of his system. This is used to give the user the possibility to have a preview in the browser additional to the preview he has in the background page of the wizard.

Destination: Local Directory

- selected by default

Default Directory: a sub directory of OOo documents directory.
e.g.: “s.o. Documents directory>/webpublish1/”

By clicking the browse button the user can choose the directory.

Destination: Archive file

If the user checks this an archive file in the choosen format will be created. Available formats are:
.zip, .gzip and .war ( for .war files we will generate also the WEB-INF/web.xml).

Default name will be webpublish1.zip in the OOo documents directory.

Destination: FTP

- not selected by default

When the user checks this option, the configure button is enabled. By clicking the button, an FTP dialog is opened, where the user can connect with his settings to an FTP server. After connecting, and choosing a directory, the user closes the dialog. The FTP Path then appears in the previously disabled textbox.

Screenshot 13 FTP configuration dialog

#	control	English	German
0	DialogTitle	FTP Connection	FTP-Verbindung
1	Label	~User name:	~Benutzername:
2	Label	~Password:	~Kennwort:
3	Button	Connect	Verbinden
4	Label	1. Enter FTP connection information.	1. Geben Sie FTP-Verbindungsinformation ein.
5	Label	~Server name or IP address:	~Servername oder IP Adresse:
6	Label	2. Connect to the server.	2. Stellen Sie eine Verbindung zum Server her.
7	Label	3. ~Choose a remote directory (optional).	3. ~Wählen Sie ein Verzeichnis auf dem Server aus (optional).
8	Button	...	...
9	Label	Connection status is unknown	Verbindungsstatus ist unbekannt
10	Label	Connection was established successfully	Verbindung wurde erfolgreich hergestellt
11	Label	Username or password is wrong	Benutzername oder Kennwort ist falsch
12	Label	Could not resolve server name	Servername kann nicht aufgelöst werden
13	Label	You do not have sufficient user rights	Sie haben keine ausreichende Zugangsrechte.
14	Label	Cannot connect to server	Server nicht erreichbar
15	Label	Unexpected error	Unerwarteter Fehler
16	Label	FTP publishing directory	FTP-Veröffentlichungsverzeichnis
17	Label	This is not an FTP folder	Dies ist kein FTP-Ordner
18	Label	Connecting...	Die Verbindung wird hergestellt...

The “Test” button ist disabled until Server Name/IP, username and password are set.

When a connection to the given server is successfully established, the “choose directory” and “OK” buttons are enabled.

Save Settings for later update

- checked by default

A default “settings-name” will be generated in the form of “webpublished1”

See also Step 1.

Create

When the user clicks finish, a status bar appears. This will keep the user informed about what the wizard does, and let him estimate how much time it will take.

Before generating any files the wizard will store the settings, and make custom choices like background and style variations available for the future.

Then the wizard will generate and convert the files to a temporary directory.

It will copy the files from there to the local destination directory, to the FTP server, and/or ZIP them.

Screenshot 14 Status dialog: Create(1)

Screenshot 15 Status dialog: Create (2)

#	control	English	German	Comment
70	dialog title	Generating Your Web Site	Ihre Webseite wird erzeugt	
79	Label	Exporting documents...	Dokumente werden exportiert...	
80	Label	Preparing export...	Export word vorbereitet...	
81	Label	Copying layout files...	Layout Dateien werden kopiert...	
82	Label	Preparing table of contents generation...	Inhaltsverzeichnis-Erzeugung wird vorbereitet...	
83	Label	Generating table of contents...	Das Inhaltsverzeichnis wird generiert...	
84	Label	Initializing...	Initialisieren...	
86	Label	Preparing to publish...	Veröffentlichung vorbereiten...	
87	Label	Publishing to local directory...	In lokales Verzeichnis veröffentlichen...	
88	Label	Publishing to FTP destination...	Veröffentlichen per FTP...	
89	Label	Publishing to a ZIP archive...	In ein ZIP-Archiv veröffentlichen...	
90	Label	Finishing...	Fertig stellen...	

Header texts for the different steps:

Step1: "Introduction"

Step2: "Which documents do you want to publish on the web?"

Step3: "What layout do you prefer?"

Step4: "Customize the selected layout"

Step5: "Which style do you want for your pages?"

Step6: "What is the general info for your site?"

Step7: "Where do you want to publish your site?"

<String Lists>

<Required - Dialogs providing strings which have to be translated, have to be accompanied by a table containing the strings used in the image (English or German or both) Strings have to include mnemonics and the item for which the string is used. Mnemonics have to be visualized by a ~ - symbol in front of the letter which has to be displayed mnemonic.>

String list

#	control	English	German	Comment
72	DirectoryName	myWebsite	meineWebseite	Used as subdirectory to publish the local web site
73	message	FTP target '%FILENAME' is a file.	Das FTP Ziel '%FILENAME' ist eine Datei.	Error message when chosing an ftp directory.
74	message	The local target '%FILENAME' is a file.	Das lokale Ziel '%FILENAME' ist eine Datei.	
75	message	The ZIP target '%FILENAME' already exists. Do you want to overwrite the existing target?	Das ZIP-Ziel '%FILENAME' existiert bereits. Möchten Sie es Überschreiben?	
76	message	The FTP target directory '%FILENAME' is not empty. Some files will be overwriten. Continue?	Das FTP-Zielverzeichnis '%FILENAME' ist nicht leer. Einige Dateien werden überschrieben. Möchten Sie fortfahren?	
77	message	The local target directory '%FILENAME' is not empty. Some files will be overwriten. Continue?	Das lokale Verzeichnis '%FILENAME' ist nicht leer. Einige Dateien werden überschrieben. Möchten Sie fortfahren?	
78	message	Settings already exist under the given name. Do you want to overwrite the existing settings?	Einstellungen mit diesem Namen existieren bereits. Möchten Sie diese Überschreiben?	
104	message	Your web site was generated successfully to: %FILENAME	Ihre Webseite wurde in %FILENAME erfolgreich erstellt	
105	message	One or more errors occurred when generating the web site.	Einer oder mehrere Fehler traten beim Generieren der Webseite auf.	
106	message	An error occurred while generating the table of contents page(s).	Ein Fehler ist beim Erzeugen des Inhaltsverzeichnises aufgetreten.	
107	message	An error occurred while copying the layout files.	Ein Fehler ist beim Kopieren der Layoutdateien aufgetreten.	
108	message	An error occurred while gathering document information for '%FILENAME'.	Ein Fehler ist beim Zusammenstellen der Dokumentinfo für '%FILENAME' aufgetreten.	
109	message	An error occurred while exporting the document '%FILENAME'.	Ein Fehler ist beim Exportieren des Dokumentes '%FILENAME' aufgetreten.	
110	message	An error occurred while creating a directory for exporting '%FILENAME'.	Ein Fehler ist beim Erzeugen des Exportverzeichnisses '%FILENAME' aufgetreten.	
111	message	A security error acoccurred while exporting the document '%FILENAME'.	Eine Sicherheitsverletzung ist beim Exportieren des Dokuments '%FILENAME' aufgetreten.	
112	message	An input/output error occurred while exporting the document '%FILENAME'.	Ein/Ausgabe-Fehler ist beim Exportieren des Dokuments '%FILENAME' aufgetreten.	
113	message	An error occurred while copying media files to the temporary directory.	Ein Fehler ist beim Kopieren der Dateien ins temporäre Verzeichnis aufgetreten.	
114	message	The web site could not be copied to the following destination: %URL	Ein Fehler ist beim Kopieren der Webseite an folgende Stelle aufgetreten: %URL	
115	message	An unexpected error occurred: %ERROR	Ein unerwarteter Fehler ist aufgetreten: %ERROR	
116	message	An unexpected error occurred while validating the file: '%FILENAME'	Ein unerwarteter Fehler ist beim Überprüfen folgender Datei aufgetreten: '%FILENAME'	
117	message	'%FILENAME' is a folder.	'%FILENAME' ist ein Ordner.	
119	message	An unexpected error occurred.	Ein unerwarteter Fehler ist aufgetreten.	
131	web siteweb siteweb site	%NUMBER pages	%NUMBER Seiten	
132	web siteweb siteweb site	%NUMBER slides	%NUMBER Folien	
151	web siteweb siteweb site	Size: %NUMBERKB	Größe: %NUMBERKB	%NUMBER will be replaced with a number. Please Note the “KB” is a literal and will not be replace resulting in something like: “Size: 5KB”
133	web siteweb site	Created: %DATE	Erstellt am: %DATE	
134	web siteweb site	Last modified: %DATE	Letzte Änderung: %DATE	
146	Message	The FTP directory '%FILENAME' could not be created.	Das FTP Verzeichnis '%FILENAME' konnte nicht erstellt werden.	
147	Message	The FTP directory '%FILENAME' does not exist. \nCreate directory?	Das FTP Verzeichnis '%FILENAME' existiert nicht. \nSoll das Verzeichnis erstellt werden?	
148	Message	The Zip file '%FILENAME' can not be created: a directory exists with the same name.	Die Zip Datei '%FILENAME' kann nicht erstellt werden: Ein Verzeichnis mit gleichen Namen existiert bereit.	
149	Message	The local directory '%FILENAME' can not be created. \nPlease check your write-permissions.	Das lokale verzeichnis '%FILENAME' kann nicht erstellt werden.\nÜberprüffen Sie bitte Ihre Schreibrechte.	
150	Message	The local directory '%FILENAME' does not exist. \nCreate directory?	Das lokale Verzeichnis '%FILENAME' existiert nicht. Soll das Verzeichnis erstellt werden?	

Tab Order

<Required. It makes sense to describe or visualize the tabbing order. The description of the tab order has to contain which control has the initial focus.>

Key Board Shortcuts

<Required - Key Board shortcuts used in dialogs have to be listed in a table with a small description.>

Help Ids

ID	Control	Comment
1	Listbox	Saved Sessions
2	Button	Load Session
3	Button	Delete Session
6	Listbox	Documents
7	Button	Add document(s)
8	Button	Remove Document
9	Button	Move Document Up
10	Button	Move Document down
11	Textbox	Document Title
12	Textbox	Document Description
13	Textbox	Document Author
14	Listbox	Document export format

Error Conditions

Error Handling in Web Wizard:
When the user clicks “finish” a status dialog pops up, and a process begins, in which:

temp dir is created

files are exported to the temp dir

TOC pages are created

files are copied – to local, ftp and/or zip destination(s).

temp dir is deleted.

Error in (1) will abort the process. All other errors will be logged and reported in the style: “5 errors occurred:” and then a list of every error which occurred.

Future Tasks

Integration and support of Webdav in the last step

more complex style selector

tree view in the step where the structure of the site is defined.

Notes

References

[File Menu]	http://specs.openoffice.org/appwide/menus/FileMenu.sxw

Appendix A : Revision

Web Wizard

Summary und Decisions of ITeam Meeting

Meeting took place on Wed. 7th July, in Rons Office.

Participants (in order of arrival :-) )

Ron Piterman

Matthias Müller Prove

Uwe Fischer

Hasan Ilter

This document:

Date: Thu. 8th July, 2004

Author: Ron Piterman.

Revisions:

MMP added Num 20 and made general corrections.

HI added: Sorting of Style list box (last item on num 10)

Intrudocution

This document is a completion of the Web Wizard Specifications.

The changes specified in this document will be implemented by Ron Piterman, as specified here.

Following are the decisions of the Iteam from the mensioned meeting.

Issues

General:

The dialog width will be enlarged by 20 units, to enable enlarging the “add”and “remove” buttons on the 2ed step without damaging the overall look of the wizard.

When is the finish button enabled.

The output directory will be removed from the default settings. In result, the finish button will be disabled:

First time activation: Until the user chooses an output path (last step)

Next time: when the user loads a session: after loading a session (under certain restrictions) the finish button will be enabled.

If the user does not load a session: like first time.

FTP Proxies warning

The original (current) warning which pops up in activation will be removed..

Two messages will replace this message:

On the first screen, with an exclamtion mark icon (because, if the user wants to use ftp, he should know emediatly that it does not function)

On the last screen instead of the FTP text box and button. (only when FTP is disabled) – This is not confirm to the general GUI Guidelines, but is the only agreeable choice we have.

Load settings: To press or not to press (the load button) – that is the question.

Load settomgs: To load or not to load (the last settings automatically) ...

The last settings will not load automatically.

The “load” button will be removed.

Instead, the selected settings will be loaded upon pressing the “next” button on the first step.

When the wizard opens, the last saved settings will be automatically selected, so pressing “next” without doing anything will load the last saved settings.

If the user did not save the settings in his last session, <none> will be selected – so an the “empty” (defualt) settings will be used.

The first entry in the saved settings list box (step 1) will be “<none>” -

If the user chooses “<none>”, the default (empty) settings will be used.

The load-settings-status-dialog title will be changed to “Loading Web Wizard Settings”

Export Listbox should be separated from Doc-Info (UI design step 2)

The export list will be moved to the top of the dialog.

The “Documents:” label will be removed, so the Documents list box and the export list box will be on the same height.

A bigger distance will be used to the document information.

The document information label will also separate between the “export” list and the document info.

Add & remove buttons are to small. (Ui Design step 2)

The buttons width will be enlarged from 40 to 50 units.

See General above.

Export formats (which should be available)

Not discussed

String length of title in step 4 (UI design step 4)

Since the dialog is enlarged, this solves the problem.

Label will also be changed to :

“Include the following information in the table of content”

(it was “Include the following information for each document in the table of content”)

The separtor lines will be removed from this step and the label height will enable 2 lines of text.

defaults for step 4.

The ITeam did not agree on this one.

The defaults will be Description, Fileformat-Icon, Creation date and size in KB.

Note: Size in KB is only used available in Binary formats like PDF and Flash.

Default for screen size will be 800x600

design of step 5 (UI design)

The proposed design was accepted:

Since the Icon set is only used in presentations, a Label will be added below the Icons “row” (not contained in the screenshot above), which explains it.

The explanation text:

“The icon set is used for presentations in HTML format.”

The text boxes will contain the background filename only (not full path) and the iconset name.

The default style will be “Water”.

The Style list box will be alphabetically sorted.

Focus-rectangle in Icons Dialog

At the moment will not be fixed due to complexity and development effort.

Creating a sub directory on local target on finish.

Step 7 – path textboxes not editable.

The finish action will be changed.

No Subdirectory will be created – the web page will be generated to the selected directory.

Files will not be deleted from this folder (also in FTP). Existing files with same names as the generated ones will be overwritten.

The ZIP and Local path textboxes will be editable.

A Warning will be issued if an output directory was chosen which does not exist (like the one when choosing an installation folder).

A Warning will be issued if the output directory is not empty, warning that some files might be overwriten.

Step 7 – title label (“click...”) to long.

See “General” above.

Line separators will be also removed from this step.

Dialog as Standalone/with background document.

Not discussed

General comment to narrow UI design.

See “General” above.

Functions which are not specified in the specs.

Not discussed

Export target filename: original filename or entered title.

Current state is approved by the Iteam: Files will be exported using the original filenames and not the given titles.

Additional Issues

Step 6 will be changed as following:

After the “Title” label and text box will come another title: “Meta Data”.

The meta data will include in this order:

Description, email, copyright, creation date, last modification date.

The following fields will be removed:

Fav icon, Keyword, revisit after,

20. Final Confirmation

The final notification alert informs the user about the locations (ein paragraph for each published target) of the created files. Path information will be part of the message.

<Required - Dialogs providing strings which have to be translated, have to be accompanied by a table containing the strings used in the image (English or German or both) Strings have to include mnemonics and the item for which the string is used. Mnemonics have to be visualized by a ~ - symbol in front of the letter which has to be displayed mnemonic.>

<Specification WebWizard>

Page 2

http://specs.openoffice.org/installation/wizards/WebWizardSpec.sxw

Ilko Hoepping

2003-06-25T10:10:30

Elizabeth Matthis