Lo,
I took advantage of travelling a lot by train this week to read carefully alexander mail.
1) happy to see that you follow the way i've already begun with , ie style 1 +2 ;)
2) context-sensitive help would need that the team had chosen a "help browser" and have ertainly done sone modifications in the core to allow this. For the help browser (which scribus has for example), we could use yelp that is nearly fully docbook compliant but the question many oppose to that is how would it work on other OSs. This is a big problem and until we find a solution, the only easy way would use web browser and have some "html name rewrite" from an ID that could be used as context reference. We cannot go further this way without talking aboutthis with other guys of the core-team.
From that, what can we thing of grouping elements in the TOC?
Grouping is a common task for any author. It tries to organize the needs to help the reader to understand. In the actual manual, you may see that in most part, it describes menus one by one, and in more thematic way some more complex tools or concepts. Why this ? Because if you think of the manual as a help sensitive system, you guess that the reader would read from the beginning to the end but will browse it in search of a specific info (for ex: what means mass in Calligraphic tool and how it is made for).
Sure there could ne many ways in grouping elements, but at least we can simply do link to other parts if needed so, the place of one is less important that it can be in a book. hypertext navigation is not a space navigation so it doesn't change anything for the reader if we use in one part a page that is written in another.
An example of this. In your Proposal, Alex, have a specific part for Preferences. right. But some tool need to be set in preferences quite often, for ex 3d tool) so that preferences is in this case a real part of the tool usage. HAving a complete reference to the page related to this is a must in this case, and would be a gooduse of non-linear reading.
Thinking of some special elements like Color management or icon preview, I'm just wondering if it would not be usefull to have some part about specific usage of Inkscape. I'm thinking of :
- Inkscape for press
- Inkscape for theme design
- inkscape for web design
ans so on.
Having fill'n'stroke in colours is also something strange especially for stroke settings which can be considered as object properties.
I'm not sure if we should map all this to visualize the several relationship that can be set between pages.
We also need to define a basis structure of each pages. Is the one we already have good enough (title+screenshot+Intro+Activation+Procedure+Additional infos+Links) ?
Alex, i'm also wondering if it would not be better to split much than you did. I would do : One file per TOC entry. I didn't follow the new gimp's process, but that was what they had some years ago when i contributed. Roman could be open to help us in a reasonable way, he always answered my mails ;)
A+
radar.map35@...6... wrote:
For the help browser (which scribus has for example), we could use yelp that is nearly fully docbook compliant but the question many oppose to that is how would it work on other OSs.
How do other apps (gimp, etc) handle this? Maybe we can use yelp or kde help (whatever it's called) when it is available (check at run time), and if not, use a browser. I know it complicates things a little, but (without knowing much) sounds like a reasonable solution.
Another possibility is to use the integrated help browsers on Mac and Win, generating a platform-specific help file at compile time. I'm certain there are tools to convert help files from docbook to those platforms' help apps, but again, don't know for sure.
Sure there could ne many ways in grouping elements, but at least we can simply do link to other parts if needed so, the place of one is less important that it can be in a book.
Since it's unlikely that this manual will be published in paper form, I agree that things can be in "arbitrary" places. But it may still be read as a book, even online, so it should have a usable outline or structure for straight reading. I think I'm just agreeing with you here? Maybe I'm not quite sure what you're trying to say...
Thinking of some special elements like Color management or icon preview, I'm just wondering if it would not be usefull to have some part about specific usage of Inkscape. I'm thinking of :
Inkscape for press
Inkscape for theme design
inkscape for web design
ans so on.
I like this idea. However, couldn't we do a "generic" manual, then have a page which basically groups links to pertinent references (with descriptive text, of course)? I don't think we should necessarily separate out "Color Profiling" from the base of the manual and put it into an "Inkscape for press" section, if that's what you're saying, just group it under that heading with other topics.
Having fill'n'stroke in colours is also something strange especially for stroke settings which can be considered as object properties.
I think bulia said the plan was to change this dialog to "object properties", since it contains all different types of object properties anyway.
I'm not sure if we should map all this to visualize the several relationship that can be set between pages.
That might work very well - is there a way to do this on the wiki? Or maybe we could use an svg diagram file on the wiki?
We also need to define a basis structure of each pages. Is the one we already have good enough (title+screenshot+Intro+Activation+Procedure+Additional infos+Links) ?
Is there anything else we need?
One thing that Colin and I discussed was whether proliferation of screen shots is necessary. He's working on a screenshot script so that we can all take relatively similar screenshots, which should make things easier. I think you all know that po tools don't help with updating or translating screenshots, so we had agreed that unless/until a better solution is found for automation, the fewer screenshots we have the better.
I think a lot of the shots could be reused. For instance, we could have one screenshot called something like "main_ui.png" which is referenced by, for instance, "On-Canvas Editing", "Toolbars", "Menus", etc.
In addition, it might be beneficial to put only screenshots where they are absolutely necessary, such as where one may find it difficult to understand without an illustration. I know that's difficult to ascertain in many cases, but I think we should make an effort to do it nonetheless.
Alex, i'm also wondering if it would not be better to split much than you did. I would do : One file per TOC entry. I didn't follow the new gimp's process, but that was what they had some years ago when i contributed. Roman could be open to help us in a reasonable way, he always answered my mails ;)
That seems like a lot of files, and might get a little messy. Is there a benefit to having lots of files rather than one or a few, if we're using po tools?
JF
On 10/28/07, radar.map35 wrote:
Thinking of some special elements like Color management or icon preview, I'm just wondering if it would not be usefull to have some part about specific usage of Inkscape. I'm thinking of :
- Inkscape for press
- Inkscape for theme design
- inkscape for web design
ans so on.
Fair enough :)
And here is another point: Jon Cruz is planning to add common interface to both flat fill, gradient fill and patterns. Which makes me wonder if we shouldn't group related topics into a Swatches chapter.
We also need to define a basis structure of each pages. Is the one we already have good enough (title+screenshot+Intro+Activation+Procedure+Additional infos+Links) ?
Or (title+Intro+screenshot+Activation+Procedure+Additional infos+Links) ?
Alex, i'm also wondering if it would not be better to split much than you did.
It could be done :) I just didn't go into depth that far :)
So, what else should we do to get the ball rolling?
Alexandre
participants (4)
-
Alexandre Prokoudine
-
Elisa-yemanja
-
Joshua Facemyer / Impressus Art
-
radar.map35@...6...