[gnome-love] Documentation Report Format/Readability



My report is going well, but I need confirmation on the format of my report. Please read my report and give me some suggestions.


Be a better friend, newshound, and know-it-all with Yahoo! Mobile. Try it now.
Changes are enclosed in curly braces { }
Images (their text placeholders) are enclosed in straight brackets [ ]
Irrelevant/unnecessary text is omitted by an ellipse ...


2.2. When You Start Archive Manager
- - - - - - - - - - - - - - - - - - - - -
Current:

When you start Archive Manager, the following window is displayed:

Figure 1 Archive Manager Window

         _______________________________
        |                               |
        |                               |
[       |       outdated screenshot     |       ]
        |                               |
        |_______________________________|

The Archive Manager window contains the following elements: 

Menubar

   ...

Toolbar

    ...

Folderbar

    ...

Display area

    ...

Statusbar

    ...
- - - - - - - - - - - - - - - - - - - - -
Solution:

When you start Archive Manager, the following window is displayed:

Figure 1 Archive Manager Window

         _______________________________
        |                               |
        |                               |
{ [     |         new screenshot        |       ] }
        |                               |
        |_______________________________|

The Archive Manager window contains the following elements: 

Menubar

   ...

Toolbar

    ...

Folderbar

    ...

Display area

    ...

Statusbar

    ...
- - - - - - - - - - - - - - - - - - - - -
Notes: 

A new screenshot is in order; the old one's appearance is different, 
 in addition to its primary name "File Roller" (in the green bar at the top). 

_________________________________________

2.2.1. Bookmarks
- - - - - - - - - - - - - - - - - - - - -
Current:

Several Archive Manager dialogs contain the following components, which enable you to bookmark frequently 
accessed folders:

Bookmarks

    Use this list box to open a bookmarked folder.

    Archive Manager provides the following default bookmarks:
    Bookmark    Location
    Home        $HOME
    Desktop     $HOME/Desktop
    Filesystem  /

 $HOME is the home directory specified in the /etc/passwd file.
 Archive Manager always uses this value, even if the user resets the value of $HOME after login.

Files and folders

    Use this list box to open a subfolder within the bookmarked folder, or to select a file or folder.

...
- - - - - - - - - - - - - - - - - - - - -
Solution:

Several Archive Manager dialogs{, including New, Open, and Extract,} contain the following components, 
 which enable you to bookmark frequently accessed folders.

{Places}

    Use this list box to open a bookmarked folder.

Archive Manager provides the following default bookmarks:
        Bookmark                Location
        Home                    $HOME
        Desktop                 $HOME/Desktop
        Filesystem              /
        {Network Servers        ???}
        {Documents              $HOME/Documents}
        {Music                  $HOME/Music}
        {Pictures               $HOME/Pictures}
        {Videos                 $HOME/Videos}
        {Download               $HOME/Download}


        $HOME is the home directory specified in the /etc/passwd file.
 Archive Manager always uses this value, even if the user resets the value of $HOME after login.

Files and folders

    {This is the area to the right of the "Places" box. }Use this list box to open a subfolder within the 
bookmarked folder, 
 or to select a file or folder.

Add

    {Select a non-empty folder, then} click on this button to add that folder to the bookmarks list box.

...
- - - - - - - - - - - - - - - - - - - - -
Notes:

Some of the directions were ambiguous or hard to understand. 
There are new bookmarks in the new GNOME. 
I'm not sure if this is the right chapter to put such a specific entry.
 

_________________________________________

3.1. Filename Patterns
- - - - - - - - - - - - - - - - - - - - -
Current:

Archive Manager enables you to add, extract, or delete several files at
 once. To apply an action to all files that match a certain pattern,
 enter the pattern in the text box. The pattern can include standard
 wildcard symbols such as * to match any string, and ? to match any single
 symbol. You can enter several patterns separated by semicolons. Archive
 Manager applies the action to all files that match at least one of the
 patterns. The examples in the following table show how to use filename
 patterns to select files.

Pattern         Files Matched
*               All files
*.tar*          All files with extension tar, including those in which the tar extension 
                 is followed by any sequence of symbols, such as filename.tar.gz
*.jpg; *.jpeg   All files with extension jpg and all files with extension jpeg
- - - - - - - - - - - - - - - - - - - - -
Solution:

Archive Manager enables you to add, extract, or delete several files at
 once. To apply an action to all files that match a certain pattern,
 enter the pattern in the text box. The pattern can include standard
 wildcard symbols such as * to match any string, and ? to match any single
 symbol. You can enter several patterns separated by semicolons. Archive
 Manager applies the action to all files that match at least one of the
 patterns. The examples in the following table show how to use filename
 patterns to select files.

Pattern         Files Matched
*               All files
*.tar*          All files with extension tar, including those in which the tar extension 
                 is followed by any sequence of symbols, such as filename.tar.gz
*.jpg; *.jpeg   All files with extension jpg and all files with extension jpeg
{file?.gz       All files with extension gz that have the name: "file" followed by any single character, e.g. 
file2, filex}
- - - - - - - - - - - - - - - - - - - - -
Notes:

Added an example to show the usage of the ? wildcard symbol. 

_________________________________________

3.2. To Open an Archive
- - - - - - - - - - - - - - - - - - - - -
Current:

To open an archive, perform the following steps:

   1. Choose Archive ▸ Open to display the Open dialog.
   2. Select the archive that you want to open.
   3. Click Open.

...
- - - - - - - - - - - - - - - - - - - - -
Solution:

To open an archive, perform the following steps:

   1. Choose Archive ▸ Open {(SHORTCUT KEY: ctrl + o, or simply click the "Open" icon)} to display the Open 
dialog.
   2. Select the archive that you want to open.
   3. Click Open.

...
- - - - - - - - - - - - - - - - - - - - -
Notes:

Added alternatives for displaying the Open dialog. 

_________________________________________

3.3. To Select Files in an Archive
- - - - - - - - - - - - - - - - - - - - -
Current:

To select all files in an archive, choose Edit ▸ Select All. 

...
- - - - - - - - - - - - - - - - - - - - -
Solution:

To select all files in an archive, choose Edit ▸ Select All {(SHORTCUT KEY: ctrl + a)}.

...
- - - - - - - - - - - - - - - - - - - - -
Notes:

Added shortcut key for Select All. 
_________________________________________

3.4. To Extract Files From an Archive
- - - - - - - - - - - - - - - - - - - - -
Current:

To extract files from an open archive, perform the following steps:

   1. Select the files that you want to extract.
   2. Choose Edit ▸ Extract to display the Extract dialog.
   3. Select the folder where Archive Manager extracts the files from the Extract in folder drop-down list. 
If the folder is not present in the list, choose Other... to select the folder from the Destination folder 
dialog, then click on Open.

...
- - - - - - - - - - - - - - - - - - - - -
Solution: 

To extract files from an open archive, perform the following steps:

   1. Select the files that you want to extract.
   2. Choose {Archive} ▸ Extract to display the Extract dialog.
   3. Select the folder where Archive Manager extracts the files {or type in the location}.

...
- - - - - - - - - - - - - - - - - - - - -
Notes:

Updated directions for extracting files. 

_________________________________________

3.5. To Close an Archive
- - - - - - - - - - - - - - - - - - - - -
Current:

To close the current archive but not the Archive Manager window, choose Archive ▸ Close.

To close the current archive and the current Archive Manager window, choose Archive ▸ Quit. 
- - - - - - - - - - - - - - - - - - - - -
Solution:

To close the current archive and the current Archive Manager window, choose Archive ▸ {Close}. 

- - - - - - - - - - - - - - - - - - - - -
Notes:

There seems to be only one way to "Close" now. 
_________________________________________




7.1.1  Folder View
- - - - - - - - - - - - - - - - - - - - -
Current:

...

The folderbar, which Archive Manager displays only in folder view, contains the components described in the 
following table.

Component               Description
[outdated back icon]    Click on this button to navigate backwards in the location history list.
[outdated forward icon] Click on this button to navigate forwards in the location history list.
[outdated up icon]      Click on this button to navigate up one level in the folder tree.
[outdated home icon]    Click on this button to open the top-level folder in the archive.

...
- - - - - - - - - - - - - - - - - - - - -
Solution: 

...

The folderbar, which Archive Manager displays only in folder view, contains the components described in the 
following table.

Component               Description
{ [new back icon] }     Click on this button to navigate backwards in the location history list.
{ [new forward icon] }  Click on this button to navigate forwards in the location history list.
{ [new up icon] }       Click on this button to navigate up one level in the folder tree.
{ [new home icon] }     Click on this button to open the top-level folder in the archive.

...
- - - - - - - - - - - - - - - - - - - - -
Notes: 

New images for the [back], [forward], [up], and [home] icons. 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]