[Shotwell] Contributing to Yorba/Shotwell

Robert Ancell robert.ancell at canonical.com
Sun May 30 23:21:26 PDT 2010


Hi David,

Great to see you've been able to get something working!

Sorry, I forgot to link to information about what content to put in, 
here is a post from the author of Mallard:
http://people.gnome.org/~shaunm/quack/mallard.xml 
<http://people.gnome.org/%7Eshaunm/quack/mallard.xml>

The way I think about it is:

Imagine you are a new user.  You've clicked on an icon called "Shotwell 
Photo Manager" either because you found it or someone told you to.  The 
Shotwell window has opened up and you don't know how to use it.  You've 
opened the help.

What do you want to do? Perhaps you want to:
- Import some photos from your digital camera.
- Crop a photo you have
- Upload your photos to Facebook
- Set your photo as the background

These are the sections to write.

What you don't want to know is:
- How to open the application (if you're reading the help it is already 
open)
- What the application looks like - you can see that already

--Robert

On 31/05/10 15:34, David Velazquez wrote:
> Of course this is only a proof of concept, if you will, but I've 
> managed to get it going and quite nicely. My first impressions are 
> good. It will definitely take some getting used to considering I only 
> dabbled in html many years ago. The hardest thing for me to understand 
> will be the linking structure and the ability to have a second guide, 
> but I'm hoping that will come naturally as I write more.
>
> Starting Page 
> <http://psych.radium.whatbox.ca/up/60082780c619eafa2d3780a0a3de4edd.png>
>
> Starting Shotwell 
> <http://psych.radium.whatbox.ca/up/71bc2ec2e47c114835b688c817ab4fe5.png>
>
>
>
> As I get time I hope to experiment with adding pictures
>
> On Mon, May 31, 2010 at 12:01 AM, David Velazquez 
> <david.velazquez08 at gmail.com <mailto:david.velazquez08 at gmail.com>> wrote:
>
>     This bears remembering I think, a lot of things can change in
>     Shotwell. Though it was early in the morning for me I remember
>     reading that Mallard was especially useful in organizing things so
>     that changes could be made easily. I hope that's what I read.
>
>
>     On Sun, May 30, 2010 at 5:30 AM, Bengt Thuree <bengt at thuree.com
>     <mailto:bengt at thuree.com>> wrote:
>
>
>         Just a thought here that Shotwell is still in early days of
>         development,
>         so we should bear that in mind when the various documentation
>         is produced.
>         That means that there is bound to be a number of changes in a
>         short
>         time...
>
>         /Bengt
>
>         Bengt Thuree bengt at thuree.com <mailto:bengt at thuree.com>
>
>
>
>         Bruno Sun. 2010-5-30
>
>         It is. I only mentioned it because it exists, has all the support
>         processes needed for a new contributor and they will
>         definitely need a
>         section on Shotwell for 10.10. Of course, it would be a lot
>         better to do
>         generic documentation.
>
>
>     I will definitely take a further look at contributing to the
>     Ubuntu Manual project if I can get into things nicely. I've
>     already perused the manual and handed it off to people to use.
>     It's a great project!
>
>         On Sun, May 30, 2010 at 8:23 PM, Robert Ancell
>         <robert.ancell at canonical.com
>         <mailto:robert.ancell at canonical.com>> wrote:
>         Hi all,
>
>         I'm a GNOME Developer and work in the Ubuntu Desktop team.
>
>         The help should definitely be written in Mallard format and I can
>         confirm it is an order of magnitude easier that the old
>         DocBook format!
>
>         All you need is a recent version of Yelp (e.g. Ubuntu 9.10 or
>         higher)
>         and a text editor.
>
>         The Mallard ten minute guide will teach you all you need:
>         http://projectmallard.org/about/learn/tenminutes.html
>
>         Here are some examples of Mallard help files:
>         http://git.gnome.org/browse/gcalctool/tree/help/C
>         http://bazaar.launchpad.net/~robert-ancell/simple-scan/trunk/files/head%3A/help/C/
>         <http://bazaar.launchpad.net/%7Erobert-ancell/simple-scan/trunk/files/head%3A/help/C/>
>         http://git.gnome.org/browse/gbrainy/tree/help/C
>
>         Feel free to ask me any questions, you can also find me on
>         #ubuntu-desktop on freenode as robert-ancell.
>
>         --Robert
>
>
>     Hey Robert, thanks for chiming in! It looks like Mallard will be
>     the way to go. I appreciate the links to the guides and
>     information. I'm sure I'll be stopping by ubuntu-desktop one of
>     these days.
>
>     Since it's been determined Mallard is the way to go I'll try and
>     toy around with it over the next few days and see where I end up.
>     I'm familiar with basic html so hopefully this won't be too hard
>     to figure out.
>
>
>




More information about the Shotwell mailing list