After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 700797 - Documentation of hyperlinks and comments is incomplete.
Documentation of hyperlinks and comments is incomplete.
Status: RESOLVED FIXED
Product: Gnumeric
Classification: Applications
Component: Documentation
1.12.x
Other Linux
: Normal normal
: ---
Assigned To: Andreas J. Guelzow
Jody Goldberg
Depends on:
Blocks:
 
 
Reported: 2013-05-21 17:44 UTC by dgt224
Modified: 2013-05-27 00:28 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Insert Comment dialog. (24.87 KB, image/png)
2013-05-21 17:44 UTC, dgt224
  Details
Insert Hyperlink dialog. (28.22 KB, image/png)
2013-05-21 17:45 UTC, dgt224
  Details
Missing patch for Comments/Hyperlinks docs. (12.44 KB, patch)
2013-05-21 18:56 UTC, dgt224
none Details | Review
Updated patch for Comments/Hyperlinks/Names docs. (35.25 KB, patch)
2013-05-25 20:09 UTC, dgt224
none Details | Review
Edit Modify Names dialog. (25.11 KB, image/png)
2013-05-25 20:12 UTC, dgt224
  Details
Insert Comment dialog. (24.29 KB, image/png)
2013-05-25 20:14 UTC, dgt224
  Details
Insert Hyperlink dialog. (28.50 KB, image/png)
2013-05-25 20:15 UTC, dgt224
  Details

Description dgt224 2013-05-21 17:44:22 UTC
Created attachment 244975 [details]
Insert Comment dialog.

The existing documentation for the Edit and Insert menus concerning hyperlinks and comments is very sparse. The attachments document most existing features of those interfaces.

The "Working with Data" section of the manual ends in a pair of empty sections titled "Adding a Comment to a Cell" and "Adding a Hyperlink to a Cell". Would it be better to move most of the new material to those sections and link to them from the menu entry descriptions?
Comment 1 dgt224 2013-05-21 17:45:29 UTC
Created attachment 244976 [details]
Insert Hyperlink dialog.
Comment 2 Andreas J. Guelzow 2013-05-21 18:22:27 UTC
The attachments I see are just images of the two dialogs. What do you mean with "The attachments document most existing features of those interfaces"? Is something missing.

I think the menu descriptions should ideally be very short and the dialogs and general concepts should be desribed in their own section.
Comment 3 dgt224 2013-05-21 18:56:04 UTC
Created attachment 244985 [details] [review]
Missing patch for Comments/Hyperlinks docs.

Sorry about the delay - I'm new to git, and I was having a hard time producing a patch that would apply cleanly.
Comment 4 dgt224 2013-05-21 18:57:30 UTC
Would you prefer that I move the dialog descriptions to the empty sections under "Working with Data"?
Comment 5 Andreas J. Guelzow 2013-05-21 21:22:33 UTC
I would greatly appreciate having the dialog descriptions in sub sections of 'Working with Data'. We should also add a section 'Defining names' and move most things associated with names into that section do that DataEntry/FormulaElements/Names as well as the menu descriptions primarily refer to that new section. Thanks
Comment 6 dgt224 2013-05-25 20:09:16 UTC
Created attachment 245305 [details] [review]
Updated patch for Comments/Hyperlinks/Names docs.

This moves all the detailed discussion of Comments, Hyperlinks, and Names to the Working with Data section.
Comment 7 dgt224 2013-05-25 20:12:43 UTC
Created attachment 245306 [details]
Edit Modify Names dialog.

This doesn't seem to have made it into git, and I have updated it with new window decoration that is less obviously Ubuntu.
Comment 8 dgt224 2013-05-25 20:14:21 UTC
Created attachment 245307 [details]
Insert Comment dialog.
Comment 9 dgt224 2013-05-25 20:15:29 UTC
Created attachment 245308 [details]
Insert Hyperlink dialog.
Comment 10 Andreas J. Guelzow 2013-05-27 00:28:29 UTC
Thank you for your patch and images. They have been committed.

This problem has been fixed in the development version. The fix will be available in the next major software release. Thank you for your bug report.