Let's write the Etoys reference manual!

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Let's write the Etoys reference manual!

Rita Freudenberg
Hello everyone,

we do have a place now to write an Etoys reference manual:

http://en.flossmanuals.net/bin/view/Etoys/WebHome

Using FLOSS Manuals, everyone can just click on the above link and  
start writing using your web browser. You have to register on their  
page and then you can login. What we have by now is just an outline,  
we can change it if we find out later that we need more or other  
chapters. But for now let's start with
Introduction
Getting Started
User Interface
Objects
Tiles

We can probably write the introduction when everything else is done.  
Getting started should cover technical details on how to start Etoys,  
this is a reference manual, no teaching guide. For the other chapters,  
everyone who wants to help just pick an object, tile or item of the  
user interface, describe what it is and what it is for and add a  
picture.
Writing with FLOSS manuals means, everyone else can read what you have  
written and can change it. So don't hesitate to start writing, even if  
you are not really sure about something, someone else will come and  
change what's wrong :)
We start writing in English, but we can manage translations later. The  
manual will not be publicly available while we are writing. To get an  
idea how it could look like, here is the TurtleArt documentation:

http://en.flossmanuals.net/turtleart

The main reasons to use FLOSS manuals are that it is used by OLPC and  
Sugar and we can reach that community and we can get help from the  
activists from the other projects in translating or proofreading.

Also, we can get a .pdf at the end, not just text on a website. If you  
want to know how that looks like, here is a link to the TurtleArt  
manual:

http://en.flossmanuals.net/TurtleArt/FM_TurtleArt_06Sep08.pdf

Please let me know if you have any problems with FLOSS or what and how  
to write!

Greetings,
Rita


Rita Freudenberg
[hidden email]



_______________________________________________
squeakland mailing list
[hidden email]
http://lists.squeakland.org/mailman/listinfo/squeakland
Reply | Threaded
Open this post in threaded view
|

Re: Let's write the Etoys reference manual!

Karl Ramberg


On Tue, Oct 6, 2009 at 11:11 PM, Rita Freudenberg <[hidden email]> wrote:
Hello everyone,

we do have a place now to write an Etoys reference manual:

http://en.flossmanuals.net/bin/view/Etoys/WebHome

Using FLOSS Manuals, everyone can just click on the above link and start writing using your web browser. You have to register on their page and then you can login. What we have by now is just an outline, we can change it if we find out later that we need more or other chapters. But for now let's start with
Introduction
Getting Started
User Interface
Objects
Tiles

We can probably write the introduction when everything else is done. Getting started should cover technical details on how to start Etoys, this is a reference manual, no teaching guide. For the other chapters, everyone who wants to help just pick an object, tile or item of the user interface, describe what it is and what it is for and add a picture.
Writing with FLOSS manuals means, everyone else can read what you have written and can change it. So don't hesitate to start writing, even if you are not really sure about something, someone else will come and change what's wrong :)
We start writing in English, but we can manage translations later. The manual will not be publicly available while we are writing. To get an idea how it could look like, here is the TurtleArt documentation:

http://en.flossmanuals.net/turtleart

The main reasons to use FLOSS manuals are that it is used by OLPC and Sugar and we can reach that community and we can get help from the  activists from the other projects in translating or proofreading.

Also, we can get a .pdf at the end, not just text on a website. If you want to know how that looks like, here is a link to the TurtleArt manual:

http://en.flossmanuals.net/TurtleArt/FM_TurtleArt_06Sep08.pdf

Please let me know if you have any problems with FLOSS or what and how to write!

Greetings,
Rita


Rita Freudenberg
[hidden email]



_______________________________________________
squeakland mailing list
[hidden email]
http://lists.squeakland.org/mailman/listinfo/squeakland

It's good to have a style for the writing to look at so the documentation get a coherrent apperance.
I have not read the Turtleart one yet so maybe it will give us a few hints.
 
 
Karl
 

_______________________________________________
squeakland mailing list
[hidden email]
http://lists.squeakland.org/mailman/listinfo/squeakland
Reply | Threaded
Open this post in threaded view
|

Re: Let's write the Etoys reference manual!

Rita Freudenberg

Am 07.10.2009 um 16:16 schrieb karl ramberg:

>
>
> On Tue, Oct 6, 2009 at 11:11 PM, Rita Freudenberg <[hidden email]
> > wrote:
> Hello everyone,
>
> we do have a place now to write an Etoys reference manual:
>
> http://en.flossmanuals.net/bin/view/Etoys/WebHome
>
> Using FLOSS Manuals, everyone can just click on the above link and  
> start writing using your web browser. You have to register on their  
> page and then you can login. What we have by now is just an outline,  
> we can change it if we find out later that we need more or other  
> chapters. But for now let's start with
> Introduction
> Getting Started
> User Interface
> Objects
> Tiles
>
> We can probably write the introduction when everything else is done.  
> Getting started should cover technical details on how to start  
> Etoys, this is a reference manual, no teaching guide. For the other  
> chapters, everyone who wants to help just pick an object, tile or  
> item of the user interface, describe what it is and what it is for  
> and add a picture.
> Writing with FLOSS manuals means, everyone else can read what you  
> have written and can change it. So don't hesitate to start writing,  
> even if you are not really sure about something, someone else will  
> come and change what's wrong :)
> We start writing in English, but we can manage translations later.  
> The manual will not be publicly available while we are writing. To  
> get an idea how it could look like, here is the TurtleArt  
> documentation:
>
> http://en.flossmanuals.net/turtleart
>
> The main reasons to use FLOSS manuals are that it is used by OLPC  
> and Sugar and we can reach that community and we can get help from  
> the  activists from the other projects in translating or proofreading.
>
> Also, we can get a .pdf at the end, not just text on a website. If  
> you want to know how that looks like, here is a link to the  
> TurtleArt manual:
>
> http://en.flossmanuals.net/TurtleArt/FM_TurtleArt_06Sep08.pdf
>
> Please let me know if you have any problems with FLOSS or what and  
> how to write!
>
> Greetings,
> Rita
>
>
> Rita Freudenberg
> [hidden email]
>
>
>
> _______________________________________________
> squeakland mailing list
> [hidden email]
> http://lists.squeakland.org/mailman/listinfo/squeakland
>
> It's good to have a style for the writing to look at so the  
> documentation get a coherrent apperance.
> I have not read the Turtleart one yet so maybe it will give us a few  
> hints.

Yes, it can serve as a reference for the look, I think. I hope to find  
some time soon to start writing, and then we can discuss the style. Of  
course, anyone else can start writing also :)

Rita
>
>
> Karl
>

Rita Freudenberg
[hidden email]



_______________________________________________
squeakland mailing list
[hidden email]
http://lists.squeakland.org/mailman/listinfo/squeakland
Reply | Threaded
Open this post in threaded view
|

Re: Let's write the Etoys reference manual!

teefal
In reply to this post by Rita Freudenberg
Great idea Rita! Do you want to do a sprint for this? We can probably do a 2 week one in time for the Oct. 21st release of Etoys 4?




-------------------- m2f --------------------

(from forum)
http://squeakland.org/forums/viewtopic.php?p=11788#11788

-------------------- m2f --------------------

_______________________________________________
squeakland mailing list
[hidden email]
http://lists.squeakland.org/mailman/listinfo/squeakland