Gnome help file

[GoogleCodeExporter]

From issue #65

> Reported by cri.penta,
> 
> I also would like to volounteer to write some documentation for this good
> program. Can you help me on this? in what language do I have to write it?
> is it good the xml docbook format for gnome documentation?

Original issue reported on code.google.com by yendo0206 on 30 Sep 2010 at 4:36

[GoogleCodeExporter]

> I also would like to volounteer to write some documentation for this good 
program. 

Thank you!!

> Can you help me on this? in what language do I have to write it?

At first, in English (locale C) please.

> is it good the xml docbook format for gnome documentation?

Yes.

  GNOME Documentation Build Utilities
  http://library.gnome.org/devel/gnome-doc-make/unstable/

I will use Python-Distutils-Extra for installation of help files.

  Glatzor moag Di!: Python-Distutils-Extra
  http://www.glatzor.de/projects/active/python-distutils-extra

Original comment by yendo0206 on 30 Sep 2010 at 4:50

[GoogleCodeExporter]

I attach the first draft of gphotoframe documentation. Take a look if it's all 
ok in particular for license (at the end of the xml file there is also the 
possibility to add the email address of the programmer).
If I'm not wrong, gnome photo frame could also be used as screensaver so I 
would like to add a section for this features but the only thing I could find 
is that it is listed under my screensaver list in Ubuntu 10.04. Is there some 
configuration gui for the screensaver? (looking at po files it seems)

My programming knowledge ends here. I don't know how to integrate the help to 
the gui button neither how to extract translatable po file from it, sorry.
I'm willing to learn but I need a step by step assistence.

Original comment by cri.pe...@gmail.com on 3 Oct 2010 at 7:15

Attachments:

• gphotoframe-help.zip

[GoogleCodeExporter]

> I attach the first draft of gphotoframe documentation. 

Thank you for your documentation! Very Nice!

> Take a look if it's all ok in particular for license (at the end
> of the xml file there is also the possibility to add the email
> address of the programmer).

Gnome Photo Frame is not a GNOME applet but a GNOME application.
Refer to the README file about the programmer info.

> Is there some configuration gui for the screensaver? (looking at
po files it seems)

There is no configuration gui for the screensaver.
The usual setting takes effect on the screen saver too. 

> My programming knowledge ends here. I don't know how to integrate
> the help to the gui button neither how to extract translatable po
> file from it, sorry.  I'm willing to learn but I need a step by
> step assistence.

Thank you very much.
I don't know gnome documentation system too.
I will learn it.

Original comment by yendo0206 on 3 Oct 2010 at 9:49

• Changed state: Started

[GoogleCodeExporter]

> Thank you for your documentation! Very Nice!
Thanks, I'm glad you liked it.

> Gnome Photo Frame is not a GNOME applet but a GNOME application.
> Refer to the README file about the programmer info.

Sorry, I will update this in the next days

> There is no configuration gui for the screensaver.
> The usual setting takes effect on the screen saver too. 

I will also add a little section for wallpaper

Original comment by cri.pe...@gmail.com on 4 Oct 2010 at 6:25

[GoogleCodeExporter]

I added new branch "help" for this issue.
Please refer to the branch.
In new help directory, I added a script for making OMF files.

% cd help

% ./makedoc.py

% cd ..

% ./setup.py

You can read your help from the menu of gphotoframe.

Original comment by yendo0206 on 4 Oct 2010 at 11:11

[GoogleCodeExporter]

We can use xml2po (gnome-doc-utils) for translation.

for making the pot file

% xml2po -o help.pot C/gphotoframe.xml C/gphotoframe-C.omf

for translation

% mkdir ja
% cp help.pot ja/ja.pot
% xml2po -p ja/ja.po -o ja/gphotoframe.xml C/gphotoframe.xml

for update

% xml2po -u ja/ja.po C/gphotoframe.xml

Original comment by yendo0206 on 4 Oct 2010 at 11:26

[GoogleCodeExporter]

Thanks for instructions!

I attach a new zip that contains a new iteration of GNOME Photo Frame 
documentation as well as the Italian translation.

I didn't make a diff patch because the changes are pretty big:

- many changes to better adhere to GDP (Gnome Documentation Project) 
specifications.

- reduced the number of images in the manual to 2 (less images means more 
maintainability and lighter package).
 You could delete the old ones.
- changed all reference to "applet" in "application".

- many impagination and writing style optimizations.

- added a Gimp image (.xcf) as template for figure2 with callouts, editable 
text and screenshot layers. With this image, documentation translators, can 
adapt figure2 to any language.

Regards
Cristian

Original comment by cri.pe...@gmail.com on 6 Oct 2010 at 7:40

Attachments:

• help.zip

[GoogleCodeExporter]

Many thanks!
I commited in revision 4e47cb56ba.

Original comment by yendo0206 on 7 Oct 2010 at 1:24

[GoogleCodeExporter]

I added some modifications in revision 864a1af88b.

- The version number of help is matched to the version number of the 
application.
- The text of GPL is included in the file GPL not in the COPYING.
- yendo0206 -> Yoshizumi Endo

Original comment by yendo0206 on 7 Oct 2010 at 11:16

[GoogleCodeExporter]

Thanks! Cristian,

I added some modifications in revision e8ca852e05.
Can you check these modifications and my English?

- Flickr & Tumblr are capitalized.
- Folder plugin does not support for fav-icon.
- services icon -> source icon.
- Enable the fullscreen visualization -> Toggle the...
- info-icon is locatedn on the bottom right not left.
- Fix mode does not prevent "Always on Visible Workspace".
- New note: Icons on the Photo Frame require Clutter support.
- New note: In fix mode, all shortcut keys are invalid.

Original comment by yendo0206 on 7 Oct 2010 at 2:33

[GoogleCodeExporter]

> - Flickr & Tumblr are capitalized.
Ok!

> - Folder plugin does not support for fav-icon.
Right!

> - services icon -> source icon.
Ok

> - Enable the fullscreen visualization -> Toggle the...
Ok

> - info-icon is locatedn on the bottom right not left.
Ooops...

> - Fix mode does not prevent "Always on Visible Workspace".
Sorry, you are right. When I enable fix mode the photo frame is movable if 
dragging with mouse but has no compiz effects. The pager thing works as you 
described. 

- New note: Icons on the Photo Frame require Clutter support.
Clutter is a library? maybe is better to tell something like this: Without the 
<application>Clutter library</application> support, these icons will not be 
displayed.

- New note: In fix mode, all shortcut keys are invalid.
In my Ubuntu 10.04 they works with or without "Fix mode"

-I attach a patch that corrects a spelling error (Hoover instead of Hovering), 
move the tooltip for fix mode and the updated figure2 for C locale

Thanks
Cristian

Original comment by cri.pe...@gmail.com on 8 Oct 2010 at 10:17

Attachments:

• help.diff
• gphotoframe_fig2.png

[GoogleCodeExporter]

> > - Fix mode does not prevent "Always on Visible Workspace".
> 
> Sorry, you are right. When I enable fix mode the photo frame is
> movable if dragging with mouse but has no compiz effects. The pager
> thing works as you described.
> 
> - New note: In fix mode, all shortcut keys are invalid.
> In my Ubuntu 10.04 they works with or without "Fix mode"

Oops!  It is a bug.  I opend new issue #68.  Thanks for your information.  

> - New note: Icons on the Photo Frame require Clutter support.
> Clutter is a library? maybe is better to tell something like this:
> Without the <application>Clutter library</application> support,
> these icons will not be displayed.

Yes, clutter is a library. I accept your suggestion.

> -I attach a patch that corrects a spelling error (Hoover instead of
>  Hovering), move the tooltip for fix mode and the updated figure2 for
>  C locale

Thanks. I commit it in revision 264a96f375.

Original comment by yendo0206 on 8 Oct 2010 at 11:27

[GoogleCodeExporter]

Cristian, you are the author of the gphotoframe-help.
The copyright holder of gphotoframe-help po files is you too.
I fixed in revision 01e324f4e4.

You selected GFDL Version 1.1 or any later as the license of the 
gphotoframe-help.
I think the lisence of the po files should be the same, GFDL 1.1+.
What do you think?

Original comment by yendo0206 on 8 Oct 2010 at 11:43

[GoogleCodeExporter]

All help files for gphotoframe 1.1 were committed.
Copyright notices of po files were updated.

Original comment by yendo0206 on 14 Oct 2010 at 1:27

• Changed state: Fixed

[GoogleCodeExporter]

I attach the gphotoframe help updated to ver1.1.1 by with new gconf parameters 
section and some minor changes

Original comment by cri.pe...@gmail.com on 5 Nov 2010 at 12:16

Attachments:

• help.C.diff

[GoogleCodeExporter]

> new gconf parameters section

Thank you very much!!

But, standard GNOME applications don't deal with GConf detail settings in the 
help documentation.  I think that we should keep help documentation simple.

Could you add only border_width and border_color settings to the "Setting the 
Preferences" section?

ex)

tip title: Changing the photo frame border width and color

To set the frame border color or width run the following command in a terminal 
window:

  gconftool-2 --type str --set /apps/gphotoframe/border_color "black"
  gconftool-2 --type int --set /apps/gphotoframe/border_width 12

Original comment by yendo0206 on 5 Nov 2010 at 3:23

[GoogleCodeExporter]

> But, standard GNOME applications don't deal with GConf detail settings in the 
help
> documentation.  I think that we should keep help documentation simple.

Oops I went too far! I didn't know that.

I attach a new patch with the modifications you suggested and all the previous 
minor changes

Original comment by cri.pe...@gmail.com on 8 Nov 2010 at 11:57

Attachments:

• help.C.diff

[GoogleCodeExporter]

Many thanks!
I committed in revision fcf4580384.

Original comment by yendo0206 on 8 Nov 2010 at 1:19