Fusedoc Generator Navigation and Page design

 

1.     Navigation Tree. 1

2.     Page Design.. 3

2.1.      Main Page (<fusedoc>) 3

2.1.1.        Summary. 3

2.1.2.        Attribute Control Mapping.. 3

2.1.3.        Other UI Controls. 3

2.1.4.        Prototype.. 3

2.2.      Properties Page (<properties>) 3

2.2.1.        Summary. 3

2.2.2.        Attribute Control Mapping.. 3

2.2.3.        Other UI Controls. 3

2.2.4.        Prototype.. 4

2.2.5.        History Tab (<history>) 4

2.2.5.1.     Summary. 4

2.2.5.2.     Attribute Control Mapping.. 4

2.2.5.3.     Prototype.. 4

2.2.6.        Add/Edit History Dialog.. 5

2.2.6.1.     Summary. 5

2.2.6.2.     Attribute Control Mapping.. 5

2.2.6.3.     Prototype.. 5

2.2.7.        Properties Tab (<property>) 7

2.2.7.1.     Summary. 7

2.2.7.2.     Attribute Control Mapping.. 7

2.2.7.3.     Prototype.. 7

2.2.8.        Add/Edit Property Dialog.. 7

2.2.8.1.     Summary. 7

2.2.8.2.     Attribute Control Mapping.. 7

2.2.8.3.     Prototype.. 8

2.2.9.        Notes Tab (<note>) 9

2.2.9.1.     Summary. 9

2.2.9.2.     Attribute Control Mapping.. 9

2.2.9.3.     Prototype.. 9

2.2.10.      Add/Edit Note Dialog.. 9

2.2.10.1.       Summary. 10

2.2.10.2.       Attribute Control Mapping.. 10

2.2.10.3.       Prototype.. 10

 

 

1.   Navigation Tree

 


2.   Page Design

 

2.1.    Main Page (<fusedoc>)

 

2.1.1.     Summary

This page will allow the user to edit the attributes of the main <fusedoc> element

 

 

2.1.2.     Attribute Control Mapping

 

Attribute

Control Type

Notes

fuse

text box

The value for this attribute should be auto-generated based on the name of the current file.

version

text box

 

language

text box

 

 

 

 

2.1.3.     Other UI Controls

 

This page has no extra UI Controls

 

2.1.4.     Prototype

 

 

 

2.2.    Properties Page (<properties>)

 

2.2.1.     Summary

This page will display a tabbed container which has 3 tabs that allow for creating/editing <history>, <property>, and <note> elements

 

2.2.2.     Attribute Control Mapping

 

No attributes will be directly set on this page

 

 

2.2.3.     Other UI Controls

 

Description

Control Type

Notes

Properties tabs

Tabbed container

Container for the Histor, Properties, and Notes tabs

 

 

2.2.4.     Prototype

 

 

 

 

2.2.5.     History Tab (<history>)

 

2.2.5.1.  Summary

Will display a list of all existing <history> elements and allow the user to add new elements, edit existing elements, or remove existing elements

 

 

2.2.5.2.  Attribute Control Mapping

 

Attribute

Control Type

Notes

<history> element list

table view

Contains the following columns:

  1. Type
  2. Date
  3. Author
  4. Role
  5. Email

description text display

multi-line text box

Read-Only display of the history description

New button

push button

Opens the “New <history>” dialog

Edit button

push button

Opens the edit dialog for the curently selected element in the list. Should be disabled if no element is selected

Remove button

push button

Removes the currently selected element in the list. Should be disabled if no element is selected

 

 

2.2.5.3.  Prototype

 

 

 

 

2.2.6.     Add/Edit History Dialog

 

2.2.6.1.  Summary

Will allow the user to add or edit a <history> element

 

 

2.2.6.2.  Attribute Control Mapping

 

Attribute

Control Type

Notes

type

dropdown

Choices:

  1. create
  2. update

date

calendar control

Should default to the current date

author

text box

 

role

text box

 

email

text box

 

description

multi-line text box

 

OK button

push button

Posts the changes and closes the dialog

Cancel button

push button

Cancels the add or edit operation and closes the dialog

 

 

 

 

2.2.6.3.  Prototype

 


2.2.7.     Properties Tab (<property>)

 

2.2.7.1.  Summary

Will display a list of all existing <property> elements and allow the user to add new elements, edit existing elements, or remove existing elements

 

 

2.2.7.2.  Attribute Control Mapping

 

Attribute

Control Type

Notes

<property> element list

table view

Contains the following columns:

  1. name
  2. value

New button

push button

Opens the “New <history>” dialog

Edit button

push button

Opens the edit dialog for the curently selected element in the list. Should be disabled if no element is selected

Remove button

push button

Removes the currently selected element in the list. Should be disabled if no element is selected

 

 

 

 

2.2.7.3.  Prototype

 

 

 

 

 

 

2.2.8.     Add/Edit Property Dialog

 

2.2.8.1.  Summary

Will allow the user to add or edit a <property> element

 

 

2.2.8.2.  Attribute Control Mapping

 

Attribute

Control Type

Notes

name

text box

 

value

text box

 

OK button

push button

Posts the changes and closes the dialog

Cancel button

push button

Cancels the add or edit operation and closes the dialog

 

 

2.2.8.3.  Prototype

 

 


2.2.9.     Notes Tab (<note>)

 

2.2.9.1.  Summary

Will display a list of all existing <note> elements and allow the user to add new elements, edit existing elements, or remove existing elements

 

 

2.2.9.2.  Attribute Control Mapping

 

Attribute

Control Type

Notes

<note> element list

table view

Contains the following columns:

  1. Author
  2. Date

note text display

multi-line text box

Read-Only display of the note text

New button

push button

Opens the “New <history>” dialog

Edit button

push button

Opens the edit dialog for the curently selected element in the list. Should be disabled if no element is selected

Remove button

push button

Removes the currently selected element in the list. Should be disabled if no element is selected

 

 

2.2.9.3.  Prototype

 

 

 

 

2.2.10. Add/Edit Note Dialog

 

2.2.10.1.         Summary

Will allow the user to add or edit a <note> element

 

 

2.2.10.2.         Attribute Control Mapping

 

Attribute

Control Type

Notes

author

text box

 

date

calendar control

Should default to the current date

note

multi-line text box

 

OK button

push button

Posts the changes and closes the dialog

Cancel button

push button

Cancels the add or edit operation and closes the dialog

 

 

 

 

2.2.10.3.         Prototype