hi Joshua and the Inkscape Docs team :)
-can we write original content in multiple languages within the same
manual so that it can be translated easily to others
-can we have multiple authors
-can we import what we have easily
The answer appears to be yes for all of those, but we'll need to discuss
what our options are with him.
All those are possible. I think it is really important that the doc team
gets familiar with FLOSS Manuals and how it works. This is best through
creating an account and some content.
We have built FM for collaboratively writing quality documentation on
free softwares. We built it because there are no equivalent systems
available. So we can offer you a tool set specific to creating
documentation collaboratively, and the opportunity to shape that tool
set to meet your needs. However because there are no equivalent systems
you should give yourself some time to get used to the workflow.
By creating some content you will get an idea of how FM works, and will
help shape the discussion on how to use FM and how we can help to meet
Adam, since you're listening now, I
think that our first topic of discussion with you should be the
multi-lingual authorship (if everyone here agrees). What are the
possibilities we have for this? Ideally any user would be able to write
original content in any language, and that content would be available to
translate into any other language. I know we're probably limited on how
this will work - can you give us some details?
There are a few options that already exist for this or we can do some
dev work to shape something that more readily fits what the doc team
would like. I think the second option is probably only possible after
you have had some experience with the system and you can see what it is
like you would like to change.
As a starter, I recommend making a new chapter for each topic in each
language. For example if you wished to create the following structure:
Introduction to Inkscape
What are Vector Graphics
Installing on Ubuntu
Creating a New Image
You could author the content in language specific chapters like so:
Introduction to Inkscape_fr
Introduction to Inkscape_en
What are Vector Graphics_en
What are Vector Graphics_de
Installing on Ubuntu_de
Creating a New Image_fr
Adam has set up our test manual at
Adam, is this solely a test place, or will it become our functional
manual eventually? I think the answer to that question will determine
how much we're willing to mess it up while we play with it :)
I think it is important for you and the doc team to get used to how FM
works first so lets treat this as a test space. When you are ready I can
either clean it out or create a new clean manual for you.
Also, can you tell us what our export format options are? I think
that's interesting to us, since it could make wrapping the manual for
releases very easy.
At the moment we enable export to indexed PDF and HTML. We are currently
working on linking the output to other formats including (at first) man
pages and docbook.
We are also building the print on demand processes so manuals can be
published directly to a print on demand system. We currently use
for this but the process is more manual they we would like. If
we automate it on our server side then you would be able to update the
manual and publish the updates to print on demand copy which would eb
uploaded directly to lulu.
Additionally we have a api for including manuals in webpages by cutting
and pasting a few lines of html. This might be of interest to your team
as you can create content in FM and host it on your domain.
If I understand correctly, you said we could import xhtml into the FM
format. How would we have to set it up?
All content is stored in xhtml. So just copy and paste the html from
your current docs into new chapters in FM.
Would it take a monolithic
document, or separated by chapter, or something else?
Manuals are broken down to chapters. My recommendation is :
* one topic per chapter
* one H1 per chapter
You create new chapters from within the repository homepage for the
Here you will find an option to 'Create a new chapter'
One other important point of discussion was the option for an more
community-driven set of docs/how-tos. I think it might be nice to have
"Inkscape Docs" as well as "Inkscape Manual" on FM.
ok, sounds great.
The manual would be
the official Inkscape documentation (as it is now), and we could draw on
good stuff from the docs also. But the docs section would be a great
place for things (such as tutorials/how-tos) that don't belong in the
manual. And this way, everything would be easily accessible and
editable by anyone who want to use / contribute. How does that sound?
Sounds good. You can have as many manuals as you like. You can also
include chapters from one manual in another using %INCLUDE% statements,
but when you need these I can walk you through how to use them.
I hope I have not left anything out. Oh, Adam, thank you (and Floss
Manuals people) for your time and help!
We are very happy the Inkscape doc team would like to utilise what we
have built for your documentation! If there is anything we can do to
help make the system work better for you or assist with using it then
please let me know. I would also recommend to anyone interested that
they join the FM list as you can also discuss things there about the
Alexandre Prokoudine wrote:
> Hi people,
> A week ago I was in Zagreb on Open Translation Tools 2007 conference.
> One of the guys there wa Adam Hyde who created
. This is a website based on twiki which is
> multilingual by design. You can create/edit content, translate content
> etc. It outputs PDF, HTML and zipped HTML, maybe even more.
> Do we want to invest time into figuring out how it might fit our workflow?
email is sponsored by:
> Check out the new SourceForge.net
> It's the best place to buy or sell services
> for just about anything Open Source.
> Inkscape-docs mailing list
email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
Inkscape-docs mailing list