GNOME Bugzilla – Bug 641727
Document note pinning & expanding note list
Last modified: 2013-10-09 11:24:43 UTC
Documentation should show users how to pin a note and also how to expand the total notes shown in the panel via gconf (advanced tips & tricks)
> <quote> > There is a 'hidden' GConf preference which can be changed with a tool > like gconf-editor. The key you are looking for > is /apps/tomboy/menu_note_count > </quote>
Hi! I am on Ubuntu 12.10 on GNOME Shell, however I don't see this option of pinning a note anywhere in the note itself nor the "Search All Notes" window. Can you please elaborate on the same?
Ubuntu team modified that part of Tomboy, eliminating this functionality. As you may've noticed, there's only single menu when you either right- or left-click on the Tomboy's icon in the tray. On "vanilla" Tomboy you'd have two different ones, one of them would have a list of notes where you would be able to "pin" them using the pin symbol. See attached for reference (green pin near the note name - this is "pinned" state).
Created attachment 230806 [details] Vanilla Tomboy "Recent Notes" menu
How can I approach writing documentation for the same? What Ubuntu version along with what GNOME version (Classic or GNOME Shell) must I use to see the features you have mentioned?
I don't know exactly when they've introduced that change, but that was, I think, at least a couple of Ubuntu major versions ago, so it would be meaningless to search for such an old one just to prepare the docs. I think you'd be better off by just building the vanilla version on your own - either by using the latest git version or the src tarball published on the main downloads page. If that sounds like too much of an effort, I could just build a binary package for you, which you could put into some dir and just run (but I'd make a backup of your notes first, or run it in some sandbox machine/VM to avoid any unexpected effects on your notes). Let me know if you want that one.
Thank you, Alex! I'll try building the vanilla pkg from git source and will let you know how it goes!
Hello, Alex It's been awhile :) After my internship with GNOME, I decided to come to this very first bug I attempted and finish the job. I have compiled Tomboy from Git master on Fedora Rawhide. To confirm, this is what is required of the documentation right? 1. A page about how user's can pin notes (specifically on GNOME Shell) 2. A page about how expand notes (via gconf-editor) 3. A page about recent notes and related information on how to browse it, change the number of recent notes and so on. I don't about availability of item number 2 and don't have a clue about how the feature works like in Tomboy, but I'll test it out and include it in the docs am going to write.
Hello Sindhu, Out of the initial bug description, I'd say you may want to provide the docs for pinnning the note and docs for setting the amount of notes in the menu (that is your #2 and #3 become a single item). The gconf magic is no longer needed - the setting is now a part of the "Advanced Preferences" plugin which is a part of standard Tomboy package (though it's disabled by default, so the setting is not visible).
Hello, Alex > Out of the initial bug description, I'd say you may want to provide the docs > for pinnning the note. I am unable to find any icon of Tomboy in system tray to access notes to pin (I remember it was like that some versions ago) or any "Pin" icon on the notes for pinning. Has the feature been removed? I have the latest tomboy compiled from git master running inside GNOME 3.8 (compiled via jhbuild). Please confirm, thanks. [I was able to successfully enable "Advanced Preferences" and that in turn enables a tab where a user can set the number of recent notes, so I will be able to write docs about that part].
(In reply to comment #10) Sindhu, not sure if I follow what you are saying here. You should be able to click on the Tomboy icon in the tray and have a list of Notes. There should be a pin by each that if you click it will Pin the note.
(In reply to comment #11) > (In reply to comment #10) > Sindhu, not sure if I follow what you are saying here. > You should be able to click on the Tomboy icon in the tray and have a list of > Notes. There should be a pin by each that if you click it will Pin the note. I am unable to find any icon of Tomboy in system tray. I only see "Accessibility" "Volume" "Bluetooth" and so on. No Tomboy icon. I checked in both GNOME Shell 3.6.2 and 3.8 (compiled via jhbuild) and ran tomboy in each of those ^ sessions but no tray icon. Am I missing something? As in, should I enable the option from anywhere?
(In reply to comment #12) Yeah, I would think so unless something in the latest release of GNOME has causes an issue. I'm not running the latest, guess I better upgrade. There was an issue that caused a VERY small icon to be used in the System tray. I wonder if that is the issue here. You might try starting tomboy with --debug and post parts of the log. Sorry for the trouble.
Created attachment 244560 [details] [review] Screenshot of Tomboy (In reply to comment #13) > (In reply to comment #12) > Yeah, I would think so unless something in the latest release of GNOME has > causes an issue. I'm not running the latest, guess I better upgrade. > > There was an issue that caused a VERY small icon to be used in the System tray. > I wonder if that is the issue here. > > You might try starting tomboy with --debug and post parts of the log. Sorry for > the trouble. No problem. Screenshot attached. I can't figure out what's going on either.
(In reply to comment #14) I don't think you ever could pin from that Menu. You need to go to the bottom right and you should have Tomboy in the Notification Menu.. ya, I know it's not GNOME3 compat.. See. http://imgur.com/L0SO1xv
(In reply to comment #15) Interestingly enough, the example on tomboy projects.gnome doesn't show this. http://projects.gnome.org/tomboy/images/applet-small.png
(In reply to comment #15) > (In reply to comment #14) > I don't think you ever could pin from that Menu. > You need to go to the bottom right and you should have Tomboy in the > Notification Menu.. ya, I know it's not GNOME3 compat.. > > See. http://imgur.com/L0SO1xv Can't see your system tray in the screenshot. Are you using GNOME 2 (classic session fallback) perhaps? Thank you for your patience with this :)
(In reply to comment #17) No fallback. Sorry, I can't get the two screen-shots together. So if you click on this icon.[1] you would then see the previously posted screen-shot. [1] http://imgur.com/RTz5864
(In reply to comment #18) I'm in IRC #tomboy if you want to chat there instead.
Created attachment 244577 [details] [review] Add user help to pin a note Please review, thanks.
Created attachment 244578 [details] [review] Add user help for Preferences add-in Please review. Thanks.
I have written the docs to keep them platform agnostic especially since GNOME runs even on touch screen devices. I was not able to find out what "Enable startup notes" feature does. Jared, could you please give a use case? I'll go through rest of the user pages to see if I have used the right terminology in describing how to access the Tomboy menu (available in GNOME system tray via Ctrl + M), later and follow up when reviews are posted. Thanks.
(In reply to comment #22) Startup Notes. By Default tomboy loads any Notes that were Open when Tomboy was closed in the last session. So if you have Note 1 open when you close tomboy, it will reopen that note next time Tomboy loads. If you don't want this behavior, then set this option to false. This is global. So if set to false Tomboy will never open Notes on startup.
Review of attachment 244577 [details] [review]: It would be great if you could use a nicer <info> layout (<link>, <revision>, <credit>, <include>, <desc>, with blank lines between each one). I know that it's not the style of the project, but it is a more readable style and is more in line with other projects. ::: help/C/pin-notes.page @@ +8,3 @@ + <link type="seealso" xref="edit-notes"/> + <link type="seealso" xref="delete-notes"/> + <desc>Keep a note in <app>Tomboy</app> menu.</desc> Add a note to, maybe? @@ +20,3 @@ + + <p>You can keep notes persistently in the <app>Tomboy</app> menu. This is + called <em>to pin a note</em>, also referred to as <em>pinning a note</em>. "keep notes persistently" is not nice wording. Try "You can add a note to the <app>Tomboy</app> menu by pinning it." or "Pin a note to add it to the <app>Tomboy</app> menu." @@ +22,3 @@ + called <em>to pin a note</em>, also referred to as <em>pinning a note</em>. + It is useful if you want to access notes that are required more frequently + than others.</p> "access notes that are required more frequently" -> "access some notes more frequently" @@ +35,3 @@ + + <p>To remove a pinned note from the <app>Tomboy</app> menu, click on the + green pin icon against the desired note.</p> Icons are not against anything, is it on the note? Next to the note?
Review of attachment 244578 [details] [review]: Content is fine, but… ::: help/C/addins-preferences.page @@ +5,3 @@ + <info> + <link type="guide" xref="addins#manage"/> + <desc>Plugins to enable advanced options.</desc> How about something more active like "Enable advanced option plugins"? @@ +17,3 @@ + + <section id="advanced"> + <title>Advanced Preferences</title> Explain what addins are before you get into your first section. Might be worth just removing this <section> and <title>. @@ +75,3 @@ + <note style="tip"> + <p>You can also use the <gui>˄</gui> and <gui>˅</gui> to + increase or decrease the values entered for the <gui>Recent List</gui>.</p> What's with the indenting? ;) @@ +83,3 @@ + <title>Start-up notes</title> + + <p></p> *ahem* @@ +88,3 @@ + <item> + <p>Enable the <link xref="#advanced">Advanced Preferences</link> + add-in.</p> Indenting…
Created attachment 251855 [details] [review] Reorganize addins user help Some pages don't have elaborate help as I was not able to find any information on how to accomplish the task (such as using some sync Tomboy plugins).
Review of attachment 251855 [details] [review]: ::: help/C/addins-formatting-fixed-width.page @@ +12,3 @@ + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclud1e"/> You mistyped the XInclude namespace
Review of attachment 251855 [details] [review]: ::: help/C/addins-sync-local.page @@ +5,3 @@ + <info> + <link type="guide" xref="addins#sync"/> + <desc>Sync your notes to a local directory.</desc> Synchronize, not sync please. ::: help/C/addins.page @@ +42,3 @@ + <note style="tip"> + <p>To download more add-ins from the internet, from the + <gui><app>Tomboy</app> Preferences</gui> window, in the Is it a window or dialog? ::: help/Makefile.am @@ -45,2 @@ whatsnew.page - Can you leave this line in please?
Created attachment 252933 [details] [review] Reorganize addins user help and replace sync with synchronize New content on addins page, all plugins moved to their own pages. Re-written addins page content. Replace *all* instances of the word 'sync' used in prose with 'synchronize' for grammatical correctness.
Created attachment 252935 [details] [review] Reorganize addins user help Contains changes only *I* made (including changes suggested in reviews here). Please review again, thanks.
Review of attachment 252935 [details] [review]: Check and fix reflowing before pushing: the text is not reflowed on a few pages. ::: help/C/addins-desktop-printing.page @@ +17,3 @@ + + <note style="important"> + <p>Printing with <app>Tomboy</app> requires that you have connected and configured your printer. If you have not done this, please consult the <link href="help:gnome-help/printing">printing help for GNOME</link>.</p> Please reflow.
Thanks for the reviews. Reflowed as suggested. Pushed to master in 438640f Available at: https://git.gnome.org/browse/tomboy/commit/?id=438640fecfda1a007d4c840b7c91673af064d25c Closing bug with RESOLVED and FIXED.
User help related to this bug reported was also pushed to master in 48dda96 Available at: https://git.gnome.org/browse/tomboy/commit/?id=48dda96e839e9fd9f2909dd6610fc8f5713cef04