hey

On Sun, 2008-06-15 at 16:11 -0500, Joshua Facemyer / Impressus Art
wrote:
> In the Audacity manual, the average size (just a visual estimate) seems 
> to be about 1/2 of a printed page or so, and there are a lot of 
> screenshots and tables included.  The longest was about 2-3 printed 
> pages worth, again with lots of visuals.

yes thats right. 


> 
> I think it's safe to say that our chapters will be roughly 1-2 printed 
> pages on average - there's a lot of information to cover.  Then, of 
> course, there will be lots of graphics for illustration.

ok. 


> 
> Does that sound about right, Adam?  (I'm asking more because we need to 
> know if we'll be fulfilling the google requirements as well.)
> 

it sounds fine to me. As far as google requirements, the main thing is
that you write a manual that you are happy with. i can take that output
and convince google that this is a fantastic output and they will be
happy I am very sure. so please just focus on the manual you want to
write, I will worry about google.

> Adam, just to get clarification, using the Audacity guide as reference, 
> what are the main "headings" called (such as "Introduction", 
> "Installing", etc) under which the chapters are organized?  These are 
> important to remember as we plan, since they are sort of like "master 
> chapters" for organization...though this organization can certainly be 
> done and adapted as we go.


the technical structure of the index works like this:

section heading - just a header
chapter 1 - content
chapter 2 - content 
section heading - just a header
chapter 3 - content
chapter 4 - content 

etc

so if you think of terms of clear section headings, and then clear
chapters (each chapter with 1 x h1) then we are fine. 


adam







> 
> JF
> 
> adam hyde wrote:
> > I think the Audacity manual on FM is a good guide to length.
> > http://en.flossmanuals.net/audacity
> >
> > the length varies, some shortish chapters but it doesn't really matter
> > how long they get, people know how to scroll. the main issue is that
> > they are well formatted with headings and the index is well conceived.
> >
> > adam
> >
> >
> >
> > adam
> >
> >
> > On Sun, 2008-06-15 at 20:43 +0200, Elisa-yemanja wrote:
> >   
> >> Le Sunday 15 June 2008 20:32:14 adam hyde, vous avez écrit :
> >>     
> >>> hey,
> >>>
> >>>       
> >>>> - Do the chapters need to be a particular length (Adam)?
> >>>>         
> >>> Just jumping in to say that FM is really indexed towards thorough 'book
> >>> like' docs.  this is because we output to online html, pdf, and books.
> >>> lots of short chapters dont really fit well into the index format we
> >>> have and don't output as easily into book form.
> >>>       
> >> ok so 2 little chapter can be joined. (align and distribute AND objects 
> >> transformed)
> >> But what is for you little chapter ?
> >> 3 pages is a little chapter ?
> >>
> >> For example a chapter dedicated at one tool is 2, 3 pages.
> >> introduction
> >> why to use
> >> how to use
> >> hotkeys
> >> tips
> >>
> >> Elisa
> >>     
> >>> adam
> >>>
> >>>       
> >>>> As for the issue of media, I think we should be concentrating on digital
> >>>> for the moment, getting something that makes sense for use online and
> >>>> download (including distribution with the software).  I like the idea of
> >>>> using a simple type of chapter, though I could see a possibility to make
> >>>> use of sub-headings.  However, I'm sure we can avoid them if we try hard
> >>>> ;)
> >>>>
> >>>> After quick glance at your list of chapters, it looks fairly complete
> >>>> and well-thought-out.  Fortunately, we don't have to worry about
> >>>> organization at the moment, just getting all of the important content
> >>>> in, since we can organize it however we like later.
> >>>>
> >>>> I think if we can settle on a rough list of chapters soon, we can get
> >>>> some of the current content into them and start from there, thus saving
> >>>> a lot of work later that can be spent on other things.
> >>>>
> >>>> JF
> >>>>
> >>>> Elisa-yemanja wrote:
> >>>>         
> >>>>> Hello all,
> >>>>>
> >>>>> I think it's time to speak about our futur work to made on booksprint.
> >>>>> It's better arrived and know a little about what exactly we will do.
> >>>>>
> >>>>> We know, it's for write an english manual of user for Inkscape.
> >>>>> If we can write a french manual, too, it's an side effect positiv, but
> >>>>> it's not more my goal.
> >>>>>
> >>>>> After, i can translate it.
> >>>>>
> >>>>> Fist of all, i thought we have already a TOC.
> >>>>> But with my little experience of author, i think this TOC, (very good
> >>>>> also) isn't perfect.
> >>>>>
> >>>>> Floss Manual advice :
> >>>>>  * only use one Heading One (h1) for the chapter, at the top of the
> >>>>> page
> >>>>>
> >>>>> (and other : * bold technical terms when first used
> >>>>> * explain every step, and include clear screen shots for every step
> >>>>> * explain all jargon 'inline'
> >>>>> * make no references to chapters before or after )
> >>>>>
> >>>>> Google need : 40 chapters
> >>>>>
> >>>>> One H1 for chapter => other organisation of the TOC.
> >>>>> Actually our official TOC have Part, H1, H2, H3....
> >>>>>
> >>>>> Furthemore i have see, with the same content, the organization change
> >>>>> for each goal.
> >>>>>
> >>>>> What it make for me a little confusion is :
> >>>>> The main goal is write a paper book or an online manual ?
> >>>>>
> >>>>> For me the way to write change a little... Less details on online
> >>>>> manual. Short strings and not attention to construct a linear read.
> >>>>> Clic in internet is the king. Etc.
> >>>>> Print manual : organization of the chapter one after one ; why not
> >>>>> creat quick box (like "Be carful", or "HotKeys most used" etc ; I don't
> >>>>> know why, but paper editor love them. Maye it was for a good things.
> >>>>> Etc.
> >>>>>
> >>>>> Paper book or online manual, we can organize the same TOC, the same of
> >>>>> the kind of organization about our chapter.
> >>>>>
> >>>>> Here my proposal of a TOC. Be careful it was not "in order" (french
> >>>>> expression). It's a Twiki, so we don't care if we don't do chapter in
> >>>>> order.
> >>>>>
> >>>>> * = chapter
> >>>>>
> >>>>> * Interface and vocabulary
> >>>>> * Rectangle tool
> >>>>> * Circle tool
> >>>>> * Star tool
> >>>>> * 3Dbox tol
> >>>>> * Pen tool
> >>>>> * Bezier tool
> >>>>> * Calligraphic tool
> >>>>> * Layers
> >>>>> * Trace bitmap
> >>>>> * Menu Path
> >>>>> * LPE
> >>>>> * Text tool
> >>>>> * Gris, Guides, Snapping
> >>>>> * Ikscape and Wikimedia
> >>>>> * SVG
> >>>>> * Color and Style
> >>>>> * Pattern
> >>>>> * Tile Clone
> >>>>> * Spiral tool
> >>>>> * Node tool
> >>>>> * Selector tool
> >>>>> * Gradient tool
> >>>>> * Filters
> >>>>> * Eraser tool
> >>>>> * Exportation
> >>>>> * Importation
> >>>>> * Save
> >>>>> * Community
> >>>>> * Align and Distribute
> >>>>> * Personnaliser son Inkscape
> >>>>> * XML
> >>>>> * Propriétés du document
> >>>>> * Effects - color
> >>>>> * Effects -  rendu
> >>>>> * Effects - Modifier le chemin
> >>>>> * Effects - Image Raster
> >>>>> * Effects - Visualisation du chemin
> >>>>> * Effets - Générer chemin
> >>>>> * Effects - Générer modèle
> >>>>> * Effects - Images
> >>>>> * Print
> >>>>>
> >>>>> Proposition of organization for each chapter :
> >>>>> * Chapter example of one tool
> >>>>> Introduction (why to use, purpose of this functionnality)
> >>>>> How to use
> >>>>> Hotkeys
> >>>>> Tips
> >>>>>
> >>>>> Other example :
> >>>>> * Color and Style
> >>>>> Introduction
> >>>>> Stroke
> >>>>> Fill
> >>>>> How to use
> >>>>> Markers
> >>>>> Creat his own markers
> >>>>> Hotkeys
> >>>>> Tips
> >>>>>
> >>>>> etc. I have already think in each organization of each chapter. But
> >>>>> this mail is very long.
> >>>>>
> >>>>> I can develop more after yours comments.
> >>>>>           
> >>>> -------------------------------------------------------------------------
> >>>> Check out the new SourceForge.net Marketplace.
> >>>> It's the best place to buy or sell services for
> >>>> just about anything Open Source.
> >>>> http://sourceforge.net/services/buy/index.php
> >>>> _______________________________________________
> >>>> Inkscape-docs mailing list
> >>>> [email protected]
> >>>> https://lists.sourceforge.net/lists/listinfo/inkscape-docs
> >>>>         
> >>
> >>     
> >> ------------------------------------------------------------------------
> >>
> >> -------------------------------------------------------------------------
> >> Check out the new SourceForge.net Marketplace.
> >> It's the best place to buy or sell services for
> >> just about anything Open Source.
> >> http://sourceforge.net/services/buy/index.php
> >> ------------------------------------------------------------------------
> >>
> >> _______________________________________________
> >> Inkscape-docs mailing list
> >> [email protected]
> >> https://lists.sourceforge.net/lists/listinfo/inkscape-docs
> >>     
-- 
Adam Hyde
FLOSS Manuals

http://www.flossmanuals.net
+ 31 6 2808 7108

Attachment: signature.asc
Description: This is a digitally signed message part

-------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It's the best place to buy or sell services for
just about anything Open Source.
http://sourceforge.net/services/buy/index.php
_______________________________________________
Inkscape-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/inkscape-docs

Reply via email to