DigitalRockArt Wiki
![[New window]](/wikidata/newwindow.png){kind=small}
RockArtInventory
|
Size: 12216
Comment:
|
← Revision 95 as of 2008-06-29 18:21:04 ⇥
Size: 15170
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| [[TableOfContents]] |
|
| Line 4: | Line 2: |
==== Overview ==== Notebooks allow users to ''collect'' images and cropped elements from any survey and optionally record comments and additional data related to the image or cropped element. Updates to a notebook may only be made by the notebook's owner. However, users may view and copy the notebooks of other users. Images and cropped elements within notebooks have the same features as images within other reports, including the opening of jumbo-sized images in new windows, display of element attributes when the mouse is paused over a cropped element, and hyperlinks to cluster and panel detail. Each user may have up to 100 notebooks and each notebook can have an unlimited number of entries. A new notebook is created by clicking the '''New''' button and optionally entering a name and defining data fields. The size of images and cropped elements and the number of images displayed per page are determined by the users settings in UserPreferences. (!) If you have a slow internet connection and have a low quality setting to improve response time, you may collect interesting images or cropped elements in your notebook, change your Image Preferences, and view your notebook images at higher quality (after waiting patiently for the downloads to complete), and then change your Image Preferences back to your normal setting. |
==== Objective ==== The '''Show Notebook''' function is a research tool allowing users to selectively collect images and cropped elements from any number of surveys as entries in a notebook or work area. The user may design the format of a notebook entry to include four types of data fields: headers, fields for text entry, check boxes for descriptive selection and calculations that use the text entry. Each user can have up to 100 notebooks; each notebook can have an unlimited number of entries. Notebooks can be used by a survey owner to create collections of elements that require updates. The '''Update Elements From Notebook''' function will use the notebook entries as a queue of elements to be processed. Changes made to images and cropped elements by a survey owner are reflected in notebook entries. For example, when a survey owner changes the attributes of an element, the changes will be reflected the next time the notebook is displayed. On rare occasions, notebook entries can be adversely affected by changes made to a survey. Should an image or cropped element be deleted by the owner of the survey, views of a notebook that included the deleted image or cropped element will see a text message describing the former contents. Should this occur, the notebook owner must delete the obsolete entry. If a new image or cropped element has been added by the owner of the survey, it is up to the notebook owner to find and add the revised image or element to the notebook. ==== Processing ==== Notebooks may be viewed, created, revised, copied, listed, sorted and downloaded from the '''Show Notebook''' function. If you do not have a notebook, clicking the '''Show Notebook''' function from the '''Main Menu''' displays the ''Create a New Notebook'' page. If you have a notebook, clicking the '''Show Notebook''' function displays the notebook last viewed or used. <<DraEject>> ==== Adding an Image or Cropped Element to Your Notebook ==== To add entries to your notebook, use any function that displays an image or cropped element. <<DraCenterImage(ScreenShots/Notebook-0A.PNG)>> <<DraEject>> Click on the ''Image ID'' or ''Element ID'' to open a new window with a notebook entry form. If a user has not defined a notebook, a default notebook will be automatically created. If a user has several notebooks, the last notebook viewed or used will be displayed and shown as the current selection in a drop down box. A different notebook may be used for the current entry by selecting the desired notebook from the drop down box. <<DraCenterImage(ScreenShots/Notebook-0B.PNG)>> Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions). To add the entry, complete the form and/or click the ''Submit'' button. The window will briefly display an acknowledgment message and then close, returning you to the working function. You may not add the same image or element to a notebook twice; the second attempt will update the prior entry. ==== Buttons ==== * ''Submit:'' add a new entry to the notebook and takes you to the function that displayed the image or cropped element. * ''Cancel:'' takes you to the function that displayed the image or cropped element. <<DraEject>> ==== Show a Notebook ==== The Show a Notebook page will display all of the entries of the selected or last notebook you viewed or used. <<DraCenterImage(ScreenShots/Notebook-1.PNG)>> Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions). The heading includes the number of entries in the notebook, the number of entries displayed on the current page and the sort sequence last chosen on the "Sort the Notebook" page. Any data fields in the notebook design, including headers, text fields, check boxes and calculations are displayed. Each image contains a ''Remove entry from notebook'' check box. To delete an entry from the notebook, click on an entry's ''Remove entry from notebook'' check box and then click on the ''Submit'' button. ==== Buttons ==== * ''Drop Down Box:'' displays a list of all the notebooks in your library. You may view any notebook by clicking on a notebook name. * ''Create:'' takes you to the Create a New Notebook page. * ''Revise:'' takes you to the Revise a Notebook page. * ''Copy:'' takes you to the Copy a Notebook page. * ''Delete Notebook:'' a warning page requesting an acknowledgment that you intended to delete the notebook being displayed. Clicking ''Delete Notebook'' a second time deletes the entire notebook. * ''All Notebooks:'' takes you to the Select a Notebook page. * ''Sort:'' takes you to the Sort the Notebook page. * ''Download:'' takes you to the Download page. * ''Submit:'' removes any checked entries from the notebook and updates the page to reflect any changes. * ''Remove All Entries:'' a warning message requesting an acknowledgment that you intend to remove all entries from the notebook is displayed. Clicking the ''Remove All Entries'' a second time removes all the entries from the notebook but retains the notebook design. * ''Menu:'' takes you to the Main Menu. <<DraEject>> ==== Create a New Notebook ==== The Create a New Notebook page is used to create a new notebook. "New Notebook" is displayed in the ''Notebook name:'' The Notebook name should be changed to indicate the use or contents of the notebook. The data fields to be used in the notebook should be entered in the ''Define each data field on a separate line:'' field. <<DraCenterImage(ScreenShots/Notebook-2A.PNG)>> <<DraCenterImage(ScreenShots/Notebook-2B.PNG)>> To create the notebook, click the ''Submit'' button. ==== Buttons ==== * ''Submit:'' creates a new notebook and takes you to the Show a Notebook page. * ''Cancel:'' takes you to the Show a Notebook page. * ''Menu:'' takes you to the Main Menu. <<DraEject>> ==== Revise a Notebook ==== The Revise a Notebook page is used to revise an old notebook. The selected notebook name is displayed in the ''Notebook name:'' field and the previously designed data fields of the notebook's format are displayed in the ''Define each data field on a separate line:'' field. You may change the notebook name and add, change or delete any data field. <<DraCenterImage(ScreenShots/Notebook-3A.PNG)>> <<DraCenterImage(ScreenShots/Notebook-3B.PNG)>> To revise the notebook, click the ''Submit'' button. ==== Buttons ==== * ''Submit:'' revises an old notebook and takes you to the Show a Notebook page. * ''Cancel:'' takes you to the Show a Notebook page. * ''Menu:'' takes you to the Main Menu. <<DraEject>> ==== Copy a Notebook ==== The Copy a Notebook page displays a copy of the current note book. The application generates a notebook name of "Copy of" appended with the former name of the notebook. The name may be changed. <<DraCenterImage(ScreenShots/Notebook-4.PNG)>> Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions). To copy the notebook, click the ''Submit'' button. ==== Buttons ==== * ''Submit:'' copies the notebook and takes you to the Show a Notebook page. * ''Cancel:'' takes you to the Show a Notebook or Show a User's Notebook page. <<DraEject>> ==== Delete a Notebook ==== The Delete a Notebook page displays a warning requesting an acknowledgment that you intend to delete the notebook. <<DraCenterImage(ScreenShots/Notebook-5.PNG)>> Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions). To delete the notebook, click ''Delete Notebook'' button a second time. ==== Buttons ==== * ''Delete Notebook:'' deletes the notebook takes you to the Show a Notebook page. * ''Cancel:'' takes you to the Show a Notebook page. * ''Menu:'' takes you to the Main Menu. <<DraEject>> ==== All Notebooks ==== The "All Notebooks" selection takes you to the "Select a Notebook" page. The ''Select a Notebook'' page displays a list of all the notebooks on the database. The user ID number enclosed by a pair of asterisk (*) characters is your id. Because Digital``Rock``Art is a shared resource, you may view and copy another user's notebook. <<DraCenterImage(ScreenShots/Notebook-6A.PNG)>> <<DraCenterImage(ScreenShots/Notebook-6C.PNG)>> <<DraCenterImage(ScreenShots/Notebook-6B.PNG)>> To view a notebook, click on a Notebook Name. The Show a Notebook page will be displayed if the notebook is yours or Show a User's Notebook will be displayed if the notebook is not yours. ==== Buttons ==== * ''Cancel:'' takes you to Show a Notebook or Show a User's Notebook page. * ''Menu:'' takes you to the Main Menu. <<DraEject>> ==== Show a User's Notebook ==== The Show a Notebook page will display all of the entries of the selected user's notebook. <<DraCenterImage(ScreenShots/Notebook-7.PNG)>> Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions). The heading includes the number of entries in the notebook, the number of entries displayed on the current page and the sort sequence last chosen on the "Sort the Notebook" page. ==== Buttons ==== * ''Copy:'' takes you to the Copy a Notebook page. * ''All Notebooks:'' takes you to the Select a Notebook page. * ''My Notebooks:'' takes you to Show a Notebook displaying a the last notebook viewed. * ''Download:'' takes you to the Download a Notebook page. * ''Menu:'' takes you to the Main Menu. <<DraEject>> <<Anchor(sortanotebook)>> ==== Sort a Notebook ==== The Sort a Notebook page display a list of the field names in the design of the notebook that may be used to sort the notebook entries. Clicking on a Field Name sorts the notebook entries on the selected field and takes you to Show a Notebook page. <<DraCenterImage(ScreenShots/Notebook-8.PNG)>> If there are no data fields defined, notebook entries will be sorted by the survey reference number, image category, cluster number, panel letter and element number. For sorting purposes, checked boxes have a lower value than unchecked boxes. All subsequent entries into the notebook will be sorted in the selected sequence. If the notebook design is revised, the sequence of the entries reverts to the default sequence. The default sort sequence is survey reference number, cluster number, panel letter, element number. ==== Buttons ==== * ''Cancel:'' takes you to Show a Notebook or Show a User's Notebook page. * ''Menu:'' takes you to the Main Menu. <<DraEject>> ==== Download a Notebook ==== The Download a Notebook allows data values entered into a notebook to be downloaded in CSV (Comma Separated Values) format. The CSV format is widely supported by spreadsheet programs such as Microsoft Excel, Microsoft Works, and Lotus 123. The Download a Notebook page displays the file name of the notebook to be downloaded. Right click the file name and choose the "Save Target as.." option to initiate a file dialog. <<DraCenterImage(ScreenShots/ShowNotebook-9.PNG)>> If you save the file to your hard drive and then open the saved file with a spreadsheet program such as Microsoft Excel, you can view the contents and perform additional analysis on your data. Close the window by clicking on the "X" in the upper right hand corner. <<DraEject>> |
| Line 13: | Line 186: |
Your first notebook is created for you automatically when you access the Show Notebook function or add your first image to your default notebook. The default notebook's name is ''No Name''. To change the notebook name or add additional data collection fields to all entries of a notebook, click the ''Design'' button. Clicking the ''New'' button will create an additional notebook and proceed to this same design page. attachment:ScreenShots/Notebook1.jpg After clicking the ''Design'' button you are presented with a a page showing a small text area with the current notebook name and a larger text area labeled ''Define each data field...'' To change the notebook name, just type in the new name and click the Submit button. To add additional fields for data collection to this notebook, you only need to define the label for the field and the type of field your wish to generate. There are four possible types of field definitions for your notebooks: * Checkbox - begins with a label and ends with an '''*''' * Text or numeric entry - begins with a label and ends with a '''#''' * Calculation - begins with a label, has an '''=''', ends with a algebraic calculation * Heading - has only a label or phrase used to delineate groups of data fields The example below establishes some additional detail to be gathered for anthropomorphic elements with sackhats. There will be 3 check boxes generated and two fields for text or numeric data entry where the length of the sackhat and the length of the body may be entered. The DRA application will calculate and display the resulting ratio per the formula entered. Note that because the length labels have embedded blanks, the blanks must be replaced by underscore '''_''' characters in the formula. The check boxes and numeric data will be highlighted with headings of ''Checkbox Attributes'' and ''Measurements''. /!\ If you use check boxes, be sure to group them under headings because unchecked boxes are not displayed on the Show``Notebook pages. attachment:ScreenShots/Notebook2.jpg Once the data design is complete, click the Submit button to save it. ==== Adding an Image or Cropped Element to Your Notebook ==== A new notebook entry begins by indicating that an image or cropped element is to be entered into the notebook. This is done by performing a ''slow-click'' or a ''drag-click'' operation. To perform a ''slow-click'', move the mouse pointer over any image, press the left mouse button, hold down for one second and release. A ''drag-click'' is performed by holding the mouse pointer near the target image, pressing the left mouse button, moving the mouse pointer over the image while holding the button down, and releasing the button. For simple notebooks with no defined data fields, the slow-click operation adds the image to the front of your notebook, the drag-click operation adds the image to the back. For notebooks with data fields defined, entries are always presented sorted by data values. /!\ Both of ''slow-click'' and ''drag-click'' operations are intended to work only on images displayed by ''research'' functions, and will not work on images displayed by most ''recording'' functions. "Adding" an image from within the ''Notebook'' function itself allows you to update the comment or data associated with the image. /!\ Notebook entries can be adversely affected by changes to a survey. Should an image or element be deleted by the owner of the survey, viewers of the notebook will see a text message describing the former contents. When a slow-click or drag-click operation is performed on an image, a small pop up window will appear. The pop-up window will contain the image or element to be added to your notebook, a drop down box containing a list of all your notebooks with the last-used notebook selected, a text area for a comment, optional data fields as previously defined, and ''Add'' and ''Cancel'' buttons. For example, the user could find all the anthropomorphic elements in the database by performing a SearchByAttributes. Any of the elements displayed as a result of the search may be individually added to the notebook by performing a ''slow-click'' or ''drag-click'' as discussed above. Doing either will open a new window. In the example below, comments and data have already been entered [[FootNote(For this example, the ratio of hat to body is deemed the important measure so the length measurements can be taken directly from the image)]]: attachment:ScreenShots/Notebook3.jpg When the ''Add'' button is clicked, the window will briefly display an acknowledgement message and then close automatically. If there are no data fields defined, the sequence of your notebook will be determined by the order of entry and whether the image or element was added by a slow-click or drag-click as described above. If there are data fields defined, the sequence of the notebook is determined by the value of the data fields. For check boxes, unchecked boxes have a lower value than checked boxes. ==== Sample Display of a Notebook ==== After several anthropomorphic elements with sackhats have been added, the contents of the notebook can be displayed by executing the Notebook function again. Note the calculated field is shown with a value of ''Error'' for the third element because no data values were entered (Not a sackhat was also checked). attachment:ScreenShots/Notebook4.jpg ==== Downloading Data from a Notebook ==== The data values entered into a notebook can be downloaded in CSV (Comma Separated Values) format. The CSV format is widely supported by spreadsheet programs such as Microsoft Excel, Microsoft Works, and Lotus 123. To download, click the ''Download'' button and another new window will open: attachment:ScreenShots/Notebook5.jpg To save the data to your hard drive, right-click the download button and choose ''Save as...'' to initiate a file dialog. Depending upon your browser setting, left-clicking may initiate the same file dialog or may open your default spreadsheet program within the browser window. If you save the file to your hard drive and then open the saved file with a spreadsheet program such as Microsoft Excel, you can view the contents or perform additional analysis. Note the leftmost columns are not visible below, these contain site, date, category, and cluster information. The panel letter and element number are shown below, and you can see the data has been sorted into sequence by the values beginning with column I. attachment:ScreenShots/Notebook6.jpg ==== Other Buttons ==== Other buttons on the Show Notebook page are described below without example screenshots. All Notebooks:: Displays a list of all notebooks without identifying the owner's name. All notebooks are public and you are free to peek at the notebooks of other users. A user ID number is displayed and your ID number appears enclosed by * characters. My Notebooks:: This button appears when you view someone else's notebook. Clicking this button changes the current notebook to the notebook you last used. New:: Creates a new notebook and opens the ''Design'' page so you can name the notebook and enter data fields if desired. Copy:: Creates a copy of the notebook you are currently viewing, either yours or someone else's. You may copy the notebooks of other users and build additional data on top of their work. Delete:: Presents a warning page requesting an acknowledgement that you intend to delete the notebook. Clicking delete a second time deletes the entire notebook. Deleting your last notebook will create an empty "No Name" notebook. Sort:: Presents a page with a choice of fields. Click on a field to sort all notebook entries by the field value. If the field chosen is not the first, a comment related to the sort sequence will be displayed on all subsequent pages. Remove All:: Removes all the entries from the notebook, but retains the design values. A warning message is presented on the first click of this button, a second click is required before all entries are erased. Submit:: Refreshes the page after deleting any entries checked for deletion. Drop Down Box:: This is a list of all your notebooks. You may change the current view just by selecting a different notebook and the page will automatically be refreshed. /!\ When viewing someone else's notebook, the drop down box is replaced by the name of the notebook. Click the '''My Notebooks''' button to view your last-used notebook. /!\ Note that you can update an entry in your notebook by performing a slow-click or drag-click on the image within the notebook page. After an update, you must click the '''Submit''' button to refresh the page and view the updated values. Images or elements may never be made into duplicate entries -- attempts to do so merely edit the original entry. [[FootNote]] ==== Changing the Design ==== It is best to test and critique your notebook design with small amounts of data. If you make any changes to the design of a large notebook (other than deleting fields) you must re-add every element to update the changed fields. If you wish to change the notebook design and retain any existing data, a good starting point is to make a copy of the notebook. When changing the design of a notebook, you may change the positions of fields (under the same heading) and not lose any existing data. You may also change the positions of whole groups of fields, where a group is all the fields under a single heading. However, any change to the spelling of the field label, the type of field (*, #, or =) or the formula appearing after an = operand will result in null values being set for the field for all existing notebook entries. Changing the spelling of a heading results in null values for all fields under the heading. Calculation fields are calculated when a new entry is made to the notebook. Therefore, if you add a new calculation based upon existing fields, its value will be null. Re-adding each existing entry without changing any values will trigger the calculation. ==== Calculation Fields ==== Calculation are evaluated after all other data fields are entered and may appear before their dependent data fields. This may be useful when you wish to sort entries based upon a calculated value. You may not use a calculated value to calculate another value. You may multiply strings by numbers. For example, the following will is acceptable: {{{ Stars # Star Rating = '*' * Stars }}} ---- [http:WikiTutorial http:/wikidata/Graduation.gif] You have completed the Digital``Rock``Art tutorial. If you want to learn how to edit wiki pages, proceed to the WikiTutorial. |
Before designing your notebook, you should establish a research goal - What is the objective of the notebook design - element comparison, statistical analysis, etc. Design your notebook for easy input. Group items of similar content together, e.g. descriptive attributes, measurements, calculations, etc. If a work sheet is the source of data input, the notebook fields should match the worksheets' field naming conventions and order. It would be prudent to test your notebook design on a small sample before spending a large amount of time capturing data and then later discover your data is inadequate. If downloading into a spreadsheet it part of the analysis, test the download. The spreadsheet display may also indicate a shortcoming in your notebook design. ==== Data Field Types ==== There are four possible types of fields for your notebooks: "Heading" - has only a name or phrase to be used to delineate groups of data fields. Headings should be used as descriptive names defining the use of the attribute being described by check boxes, measurement to be input, calculation to be performed. Headings will automatically be made bold when displayed. Example: <<DraCenterImage(ScreenShots/EntryType-1.PNG)>> "Check box" - begins with a name and ends with an "*". Check boxes give you the ability to include attributes not found in the Digital``Rock``Art application. If you use check boxes, be sure to group them under appropriate headings because unchecked boxes are not displayed on the Show Notebook pages. Example: <<DraCenterImage(ScreenShots/EntryType-2.PNG)>> "Text or numeric entry" - begins with a name and ends with a "#". Text or numeric entry give you the ability to enter text or numeric data that may be used in calculations. Example: <<DraCenterImage(ScreenShots/EntryType-3.PNG)>> "Calculations" - begins with a name, has an "=" and ends with a algebraic calculation. Calculations give you the ability to perform an algebraic calculation. If the numeric entry name has embedded blanks, you must replace the blanks with an underscore _ character in the formula. Example: <<DraCenterImage(ScreenShots/EntryType-4.PNG)>> Calculations are evaluated after all other data fields are entered and may precede dependent data fields. This may be useful when you wish to sort entries based upon a calculated value. If the calculation is an invalid expression, the field will be set to a value of "error". You may not use a calculated value to calculate another value. Formulas may include a call to any function in the Python Mathematical Functions library. ==== Changing the Design of a Notebook ==== It is best to test and critique your notebook design with small amounts of data. If you make any changes to the design of a large notebook (other than deleting fields) you must re-add every element to update the changed fields. If you wish to change the notebook design and retain any existing data, a good starting point is to make a copy of the notebook. When changing the design of a notebook, you may change the positions of fields (under the same heading) and not lose any existing data. You may also change the positions of whole groups of fields, where a group is all the fields under a single heading. However, any change to a checkbox or text / numeric field will result in null values being set for the field in all existing notebook entries. Changes to a calculation or adding a new calculation will be reflected in all notebook entries when the revised design is saved. Changing the spelling of a heading will result in null values for all fields under the heading. |
Show Notebook
Objective
The Show Notebook function is a research tool allowing users to selectively collect images and cropped elements from any number of surveys as entries in a notebook or work area. The user may design the format of a notebook entry to include four types of data fields: headers, fields for text entry, check boxes for descriptive selection and calculations that use the text entry. Each user can have up to 100 notebooks; each notebook can have an unlimited number of entries.
Notebooks can be used by a survey owner to create collections of elements that require updates. The Update Elements From Notebook function will use the notebook entries as a queue of elements to be processed.
Changes made to images and cropped elements by a survey owner are reflected in notebook entries. For example, when a survey owner changes the attributes of an element, the changes will be reflected the next time the notebook is displayed.
On rare occasions, notebook entries can be adversely affected by changes made to a survey. Should an image or cropped element be deleted by the owner of the survey, views of a notebook that included the deleted image or cropped element will see a text message describing the former contents. Should this occur, the notebook owner must delete the obsolete entry. If a new image or cropped element has been added by the owner of the survey, it is up to the notebook owner to find and add the revised image or element to the notebook.
Processing
Notebooks may be viewed, created, revised, copied, listed, sorted and downloaded from the Show Notebook function. If you do not have a notebook, clicking the Show Notebook function from the Main Menu displays the Create a New Notebook page. If you have a notebook, clicking the Show Notebook function displays the notebook last viewed or used.
Adding an Image or Cropped Element to Your Notebook
To add entries to your notebook, use any function that displays an image or cropped element.
 |
 |
Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions).
To add the entry, complete the form and/or click the Submit button. The window will briefly display an acknowledgment message and then close, returning you to the working function. You may not add the same image or element to a notebook twice; the second attempt will update the prior entry.
Buttons
Submit: add a new entry to the notebook and takes you to the function that displayed the image or cropped element.
Cancel: takes you to the function that displayed the image or cropped element.
Show a Notebook
The Show a Notebook page will display all of the entries of the selected or last notebook you viewed or used.
 |
Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions).
The heading includes the number of entries in the notebook, the number of entries displayed on the current page and the sort sequence last chosen on the "Sort the Notebook" page.
Any data fields in the notebook design, including headers, text fields, check boxes and calculations are displayed. Each image contains a Remove entry from notebook check box. To delete an entry from the notebook, click on an entry's Remove entry from notebook check box and then click on the Submit button.
Buttons
Drop Down Box: displays a list of all the notebooks in your library. You may view any notebook by clicking on a notebook name.
Create: takes you to the Create a New Notebook page.
Revise: takes you to the Revise a Notebook page.
Copy: takes you to the Copy a Notebook page.
Delete Notebook: a warning page requesting an acknowledgment that you intended to delete the notebook being displayed. Clicking Delete Notebook a second time deletes the entire notebook.
All Notebooks: takes you to the Select a Notebook page.
Sort: takes you to the Sort the Notebook page.
Download: takes you to the Download page.
Submit: removes any checked entries from the notebook and updates the page to reflect any changes.
Remove All Entries: a warning message requesting an acknowledgment that you intend to remove all entries from the notebook is displayed. Clicking the Remove All Entries a second time removes all the entries from the notebook but retains the notebook design.
Menu: takes you to the Main Menu.
Create a New Notebook
The Create a New Notebook page is used to create a new notebook. "New Notebook" is displayed in the Notebook name: The Notebook name should be changed to indicate the use or contents of the notebook. The data fields to be used in the notebook should be entered in the Define each data field on a separate line: field.
 |
 |
To create the notebook, click the Submit button.
Buttons
Submit: creates a new notebook and takes you to the Show a Notebook page.
Cancel: takes you to the Show a Notebook page.
Menu: takes you to the Main Menu.
Revise a Notebook
The Revise a Notebook page is used to revise an old notebook. The selected notebook name is displayed in the Notebook name: field and the previously designed data fields of the notebook's format are displayed in the Define each data field on a separate line: field. You may change the notebook name and add, change or delete any data field.
 |
 |
To revise the notebook, click the Submit button.
Buttons
Submit: revises an old notebook and takes you to the Show a Notebook page.
Cancel: takes you to the Show a Notebook page.
Menu: takes you to the Main Menu.
Copy a Notebook
The Copy a Notebook page displays a copy of the current note book. The application generates a notebook name of "Copy of" appended with the former name of the notebook. The name may be changed.
 |
Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions).
To copy the notebook, click the Submit button.
Buttons
Submit: copies the notebook and takes you to the Show a Notebook page.
Cancel: takes you to the Show a Notebook or Show a User's Notebook page.
Delete a Notebook
The Delete a Notebook page displays a warning requesting an acknowledgment that you intend to delete the notebook.
 |
Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions).
To delete the notebook, click Delete Notebook button a second time.
Buttons
Delete Notebook: deletes the notebook takes you to the Show a Notebook page.
Cancel: takes you to the Show a Notebook page.
Menu: takes you to the Main Menu.
All Notebooks
The "All Notebooks" selection takes you to the "Select a Notebook" page. The Select a Notebook page displays a list of all the notebooks on the database. The user ID number enclosed by a pair of asterisk (*) characters is your id. Because DigitalRockArt is a shared resource, you may view and copy another user's notebook.
 |
 |
 |
To view a notebook, click on a Notebook Name. The Show a Notebook page will be displayed if the notebook is yours or Show a User's Notebook will be displayed if the notebook is not yours.
Buttons
Cancel: takes you to Show a Notebook or Show a User's Notebook page.
Menu: takes you to the Main Menu.
Show a User's Notebook
The Show a Notebook page will display all of the entries of the selected user's notebook.
 |
Hyperlinks include: Element ID, Cluster, Panel, Element (see ElementCaptions).
The heading includes the number of entries in the notebook, the number of entries displayed on the current page and the sort sequence last chosen on the "Sort the Notebook" page.
Buttons
Copy: takes you to the Copy a Notebook page.
All Notebooks: takes you to the Select a Notebook page.
My Notebooks: takes you to Show a Notebook displaying a the last notebook viewed.
Download: takes you to the Download a Notebook page.
Menu: takes you to the Main Menu.
Sort a Notebook
The Sort a Notebook page display a list of the field names in the design of the notebook that may be used to sort the notebook entries. Clicking on a Field Name sorts the notebook entries on the selected field and takes you to Show a Notebook page.
 |
If there are no data fields defined, notebook entries will be sorted by the survey reference number, image category, cluster number, panel letter and element number. For sorting purposes, checked boxes have a lower value than unchecked boxes. All subsequent entries into the notebook will be sorted in the selected sequence.
If the notebook design is revised, the sequence of the entries reverts to the default sequence. The default sort sequence is survey reference number, cluster number, panel letter, element number.
Buttons
Cancel: takes you to Show a Notebook or Show a User's Notebook page.
Menu: takes you to the Main Menu.
Download a Notebook
The Download a Notebook allows data values entered into a notebook to be downloaded in CSV (Comma Separated Values) format. The CSV format is widely supported by spreadsheet programs such as Microsoft Excel, Microsoft Works, and Lotus 123.
The Download a Notebook page displays the file name of the notebook to be downloaded. Right click the file name and choose the "Save Target as.." option to initiate a file dialog.
 |
If you save the file to your hard drive and then open the saved file with a spreadsheet program such as Microsoft Excel, you can view the contents and perform additional analysis on your data. Close the window by clicking on the "X" in the upper right hand corner.
Designing a Notebook
Before designing your notebook, you should establish a research goal - What is the objective of the notebook design - element comparison, statistical analysis, etc. Design your notebook for easy input. Group items of similar content together, e.g. descriptive attributes, measurements, calculations, etc. If a work sheet is the source of data input, the notebook fields should match the worksheets' field naming conventions and order.
It would be prudent to test your notebook design on a small sample before spending a large amount of time capturing data and then later discover your data is inadequate. If downloading into a spreadsheet it part of the analysis, test the download. The spreadsheet display may also indicate a shortcoming in your notebook design.
Data Field Types
There are four possible types of fields for your notebooks:
"Heading" - has only a name or phrase to be used to delineate groups of data fields. Headings should be used as descriptive names defining the use of the attribute being described by check boxes, measurement to be input, calculation to be performed. Headings will automatically be made bold when displayed. Example:
 |
"Check box" - begins with a name and ends with an "*". Check boxes give you the ability to include attributes not found in the DigitalRockArt application. If you use check boxes, be sure to group them under appropriate headings because unchecked boxes are not displayed on the Show Notebook pages. Example:
 |
"Text or numeric entry" - begins with a name and ends with a "#". Text or numeric entry give you the ability to enter text or numeric data that may be used in calculations. Example:
 |
"Calculations" - begins with a name, has an "=" and ends with a algebraic calculation. Calculations give you the ability to perform an algebraic calculation. If the numeric entry name has embedded blanks, you must replace the blanks with an underscore _ character in the formula. Example:
 |
Calculations are evaluated after all other data fields are entered and may precede dependent data fields. This may be useful when you wish to sort entries based upon a calculated value.
If the calculation is an invalid expression, the field will be set to a value of "error". You may not use a calculated value to calculate another value. Formulas may include a call to any function in the Python Mathematical Functions library.
Changing the Design of a Notebook
It is best to test and critique your notebook design with small amounts of data. If you make any changes to the design of a large notebook (other than deleting fields) you must re-add every element to update the changed fields. If you wish to change the notebook design and retain any existing data, a good starting point is to make a copy of the notebook.
When changing the design of a notebook, you may change the positions of fields (under the same heading) and not lose any existing data. You may also change the positions of whole groups of fields, where a group is all the fields under a single heading.
However, any change to a checkbox or text / numeric field will result in null values being set for the field in all existing notebook entries. Changes to a calculation or adding a new calculation will be reflected in all notebook entries when the revised design is saved. Changing the spelling of a heading will result in null values for all fields under the heading.