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 620557 - Help Documentation in Mallard format
Help Documentation in Mallard format
Status: RESOLVED FIXED
Product: gnote
Classification: Applications
Component: documentation
git master
Other Linux
: Normal normal
: ---
Assigned To: Aurimas Černius
gnote-maint
Depends on:
Blocks:
 
 
Reported: 2010-06-04 12:08 UTC by Runa Bhattacharjee
Modified: 2011-07-29 20:12 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
mallard doc with separated addin pages (436.58 KB, application/octet-stream)
2011-05-25 23:07 UTC, Pierre-Yves Luyten
  Details
gnote for gnome 3 (346.87 KB, application/octet-stream)
2011-07-02 17:07 UTC, Pierre-Yves Luyten
  Details
Manual in mallard format (938.80 KB, patch)
2011-07-24 14:42 UTC, Aurimas Černius
none Details | Review

Description Runa Bhattacharjee 2010-06-04 12:08:41 UTC
Hello,
The Gnote Help documentation in Mallard format can be found at the link below:

http://runab.fedorapeople.org/gnote-doc-updates.tar.gz

Feedback would be helpful.

Thanks
Runa
Comment 1 André Klapper 2010-06-04 19:04:35 UTC
Can you please send an email to gnome-doc-list at gnome dot org about this (and subscribe to the list before)?
Comment 2 Runa Bhattacharjee 2010-06-07 07:10:39 UTC
(In reply to comment #1)
> Can you please send an email to gnome-doc-list at gnome dot org about this (and
> subscribe to the list before)?

Done: http://mail.gnome.org/archives/gnome-doc-list/2010-June/msg00012.html

Thanks for the pointer.
Comment 3 Pierre-Yves Luyten 2011-05-25 23:07:43 UTC
Created attachment 188628 [details]
mallard doc with separated addin pages

Runa doc is not yet integrated, while appart from mallard, the current doc is not up-to-date ( because of obsolete features like synchro, and because of gnome-shell ).

I was stupid enough to work on my own because I missed this bug and attachment, so I submit another one. A lot of stuff is common. The attachment I put here may be more complete and up to date, but Runa did something different for add-ins because I tryed to make each add-in have it's own doc page, and linking to the right place(s).

We will  also need to integrate previous authors.

I did suscribe to mailing list and to discuss any usefull point.
Comment 4 Aurimas Černius 2011-05-26 19:40:43 UTC
Thank you for your contribution.
I'm planing to make mallard documentation one of the major new features for Gnote 0.8 release.
Comment 5 Aurimas Černius 2011-06-28 14:09:35 UTC
I checked the attached manual. Looks nice in general.
Scanning it through I noticed the following:
1. Screenshots of Gnote windows are not consistent. I'd like to see them all with GNOME 3 theme.
2. I have committed changes to Gnote to make it better for GNOME 3. This includes making  Search All Notes window as main one and removing status icon (theis can be changed to old behavior via gsettings). The manual is directed towards old UI.
3. Typo in Fixed Width addin - in manual it's written "With".
4. Context menus of Search All Notes have been slightly changed, screenshots represent old ones.
5. Addin preferences screenshot out of date
6. Hotkey setup might be moved to Gnome Control Center. This is not yet done though.

Otherwise I like it more than current manual.
Comment 6 Pierre-Yves Luyten 2011-07-02 17:07:53 UTC
Created attachment 191157 [details]
gnote for gnome 3

this attachment updates most of figures, using adwaita theme in order to be consistent. Also, edits were made to fit new interface without status icon by default.
Comment 7 Runa Bhattacharjee 2011-07-04 09:13:42 UTC
Hello, I am sorry I could not reply earlier as I was traveling. Is there any bit that I can help out with? Thanks
Comment 8 Aurimas Černius 2011-07-13 20:09:24 UTC
(In reply to comment #7)
> Hello, I am sorry I could not reply earlier as I was traveling. Is there any
> bit that I can help out with? Thanks

Any help is very welcome.
If you want to contribute, you can read the latest patch, perhaps you'll find something to improve or some typos to fix.

Latest version looks rather good. I still need to read it entirely and modify Gnote to use it, but I already feel it's going to be good. Nice work Pierre.
Comment 9 Aurimas Černius 2011-07-24 14:42:42 UTC
Created attachment 192557 [details] [review]
Manual in mallard format

Edited version of latest manual.
Build system updated to use this new manual, old one removed.

Please, check this patch.
I'm ready to commit it, let me know, if you see anything wrong.
Comment 10 Aurimas Černius 2011-07-29 20:12:51 UTC
Committed.