I started to write a tutorial explaining how to use and how to extract the best results from the recent "Trace Pixel Art" dialog.
I have one question to the devs (su~v suggested me to ping Martin): Should I integrate this documentation with the already existing tracing documentation potrace-related or should I write a new page "from scratch"? I'll start to write it right now, in parallel, so when you respond to the email, I'll be able to take a quick action of merge, quick-fix any wrong references after the "merge" and send it to the repository.
One-page
Advantages
* User won't be misinformed (misthinking that Inkscape has only a GUI for one tracer)
Disadvantages
* Bloat? Maybe it will confuse the user
Regarding the website:
We don't currently have pages for features/tutorials on the website, but this is something we should consider. Especially if they include videos :-)
As for documentation. If you make a wiki page, that should be good enough to describe what the feature does and how it works. Link to any relevant bits of information and assume it'll be read by developers.
For the released features, we need a brief description I think.
~SUV: what where you thinking with regards to this documentation?
Martin,
On Tue, 2013-09-24 at 22:37 -0300, Vinícius dos Santos Oliveira wrote:
I started to write a tutorial explaining how to use and how to extract the best results from the recent "Trace Pixel Art" dialog.
I have one question to the devs (su~v suggested me to ping Martin): Should I integrate this documentation with the already existing tracing documentation potrace-related or should I write a new page "from scratch"? I'll start to write it right now, in parallel, so when you respond to the email, I'll be able to take a quick action of merge, quick-fix any wrong references after the "merge" and send it to the repository.
Em Ter, 2013-09-24 às 21:53 -0400, Martin Owens escreveu:
[...] and assume it'll be read by developers.
su~v just informed me that his tip to ping you was only web site related. My bad.
But moving on, the documentation targeted to developers is something that I'm developing in separate (LaTeX source files to the reviewed content that I initially published on my blog with generated PDF in the source code repository).
The documentation/tutorial I'm referring to now is the documentation/tutorial targeted at the users (and the help > tutorials menu).
On 2013-09-25 03:53 +0200, Martin Owens wrote:
Regarding the website:
We don't currently have pages for features/tutorials on the website, but this is something we should consider. Especially if they include videos :-)
As for documentation. If you make a wiki page, that should be good enough to describe what the feature does and how it works. Link to any relevant bits of information and assume it'll be read by developers.
For the released features, we need a brief description I think.
~SUV: what where you thinking with regards to this documentation?
My recommendation to vinipsmaker on irc was: 1) to look at the tutorials shipping with inkscape (menu 'Help > Tutorials'), and to visit https://launchpad.net/inkscape-docs. For (technical) questions about creating tutorials in Docbook format I recommended to ask JazzyNico.
2) since the new website is WIP, I recommended to ping you on the mailing list wrt what the current state is / future plans might be e.g. for hosting tutorials on-site.
On Tue, 2013-09-24 at 22:37 -0300, Vinícius dos Santos Oliveira wrote:
I started to write a tutorial explaining how to use and how to extract the best results from the recent "Trace Pixel Art" dialog.
I have one question to the devs (su~v suggested me to ping Martin): Should I integrate this documentation with the already existing tracing documentation potrace-related or should I write a new page "from scratch"? I'll start to write it right now, in parallel, so when you respond to the email, I'll be able to take a quick action of merge, quick-fix any wrong references after the "merge" and send it to the repository.
On Wed, 2013-09-25 at 04:11 +0200, su_v wrote:
- since the new website is WIP, I recommended to ping you on the
mailing list wrt what the current state is / future plans might be e.g. for hosting tutorials on-site.
The future plan is to have a comprehensive list of text based and video based tutorials built into the website.
Martin,
So, tutorial is "ready", but I didn't integrate it in the repository yet, because build problems that I'll sort it out.
Nevertheless, I'm attaching the current tutorial (html output is good enough for a review). And I appreciate any feedback.
I tried to write a document useful enough to free the user from the burden of going through all complex subjects of Kopf-Lischinski paper and, at the same time, giving enough knowledge to take out all that "Trace Pixel Art" dialog has to offer.
There are other minor notes too (copyright notice about the example images taken from the Liberated Pixel Cup, teasing the user with the future work of libdepixelize, how to workaround some issues related to limitations of the algorithm, ...).
I'll be writing the missing technical documentation (how libdepixelize make a spline properly lie other splines, ...) now.
Em Qua, 2013-09-25 às 04:11 +0200, su_v escreveu:
My recommendation to vinipsmaker on irc was:
- to look at the tutorials shipping with inkscape (menu 'Help >
Tutorials'), and to visit https://launchpad.net/inkscape-docs. For (technical) questions about creating tutorials in Docbook format I recommended to ask JazzyNico.
I'll try to reach him today later to help me fix the misalignment issue in the generated svg and html.
Em Qua, 2013-09-25 às 07:51 -0300, Vinícius dos Santos Oliveira escreveu:
So, tutorial is "ready", but I didn't integrate it in the repository yet, because build problems that I'll sort it out.
I fixed the alignment problems and pushed the changes to the inkscape-docs repository. Soon I'll be integrating it in the Inkscape code base.
participants (3)
-
Martin Owens -
su_v -
Vinícius dos Santos Oliveira