2010/11/30 Craig Bradney <span dir="ltr"><<a href="mailto:cbradney@scribus.info">cbradney@scribus.info</a>></span><br><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
<div bgcolor="#ffffff" text="#000000"><div class="im">
On 11/30/10 11:40 PM, Louis Desjardins wrote:
<blockquote type="cite">2010/11/30 Craig Bradney <span dir="ltr"><<a href="mailto:cbradney@scribus.info" target="_blank">cbradney@scribus.info</a>></span><br>
<div class="gmail_quote">
<blockquote class="gmail_quote" style="margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204, 204, 204);padding-left:1ex">
<div bgcolor="#ffffff" text="#000000">
<div> On 11/30/10 11:26 PM, Louis Desjardins
wrote:
<blockquote type="cite">2010/11/30 Gregory Pittman <span dir="ltr"><<a href="mailto:gpittman@iglou.com" target="_blank">gpittman@iglou.com</a>></span><br>
<div class="gmail_quote">
<blockquote class="gmail_quote" style="margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204, 204, 204);padding-left:1ex">
<div>On 11/30/2010 02:24 PM, Louis Desjardins wrote:<br>
<blockquote class="gmail_quote" style="margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204, 204, 204);padding-left:1ex"> <br>
I am not too sure to understand either just how
the doc workflow works.<br>
<br>
Can we translate the doc? can we help write it?
can this job be on a<br>
wiki? (so we can work on it step by step, from
time to time, alone or in<br>
a group of people). How can we improve the doc
workflow, in fact.<br>
</blockquote>
<br>
</div>
Anyone can translate the docs. Simply pull them out
of their location and edit away. Usually what I see
people do on the wiki, which makes sense, is to copy
the original, then stepwise work through the html
file paragraph by paragraph, leaving the tags other
structure in place as you go.<br>
<br>
The structure of the docs directories and files is
pretty straightforward, as is the XML file that
forms the index. I have sent Christoph anything I
make, since he has commit rights and I don't.</blockquote>
<div><br>
</div>
<div>Do we need commit rights to edit an online doc
file? Or to submit a translation? My understanding
of this is it’s tied to the application only by a
URL. Thus, in no way does that affect the code. It’s
a simple link to a website.</div>
</div>
</blockquote>
<br>
</div>
You download the file from SVN, translate it, submit it to
Christoph so he can commit it.</div>
</blockquote>
<div><br>
</div>
<div>What do I do if I want to help write the file on the first
place? <br>
</div>
</div>
</blockquote>
<br></div>
Write the content in plain text format and send it to Christoph..
add the HTML tags if you wish for bold, italic, paragraphs etc if
you wish. He can clarify what he would expect
easiest/best/harder/worse.<div class="im"><br>
<blockquote type="cite">
<div class="gmail_quote">
<blockquote class="gmail_quote" style="margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204, 204, 204);padding-left:1ex">
<div bgcolor="#ffffff" text="#000000">
<div><br>
<br>
<blockquote type="cite">
<div class="gmail_quote">
<div>Can we turn this into a wikipedia-like way to go?
If for some reason someone makes an error and mixes
things or deletes some content, we have ways to
return to the previous stage. I see a lot of
disadvantages at pulling out a file, edit away and
then pushing it back, while there are ways to work
in a collaborative (and sync) mode.</div>
</div>
</blockquote>
<br>
</div>
We have SVN.. which contains the history of Scribus for
(almost) ever... <br>
<br>
I do not believe we have a nice way of extracting from a
wiki to our html format.<br>
</div>
</blockquote>
<div><br>
</div>
<div>There is something I don’t get, obviously. :)</div>
</div>
</blockquote></div>
See the SVN checkout info on <a href="http://docs.scribus.net" target="_blank">docs.scribus.net</a> or the wiki.</div></blockquote><div><br></div><div>Do you mean this page?</div><div><a href="http://docs.scribus.net/index.php?lang=en&page=install1">http://docs.scribus.net/index.php?lang=en&page=install1</a> </div>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div bgcolor="#ffffff" text="#000000"><div class="im"><br>
<blockquote type="cite">
<div class="gmail_quote">
<div>Why should we extract something? When we edit a wikipedia
page, we edit the actual page that is shown to the rest of the
world.</div>
<div><br>
</div>
<div>The only purpose I would see that would require to extract
something is when we would like to produce a book out of the
content of the online doc, using a Scribus template for
instance. Then, yes, we would need to extract something.<br>
</div>
</div>
</blockquote>
<br></div>
We have no intention of producing an online site only.</div></blockquote><div><br></div><div>Maybe it’s time to revisit some old ideas.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
<div bgcolor="#ffffff" text="#000000">Christoph is
writing documentation</div></blockquote><div><br></div><div>We have to ask ourselves why is writing the documentation in the hands of only one individual? Wouldn’t it be better if this effort was distributed? Only a question and NOT a judgement on the work done.</div>
<div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div bgcolor="#ffffff" text="#000000"> that appears under the Help->Scribus Manual
menu entry, as distributed with Scribus.</div></blockquote><div><br></div><div>Why do we still have to distribute the application with the doc files? (maybe the answer is just below, my guess)</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
<div bgcolor="#ffffff" text="#000000">We have a process that
automatically checks out those HTML files and does some data
massaging into the format you see on docs.scribus.net... so.. from 1
HTML file we get a shipped HTML file with the installed software,
plus the online version at <a href="http://docs.scribus.net" target="_blank">docs.scribus.net</a>.<br></div></blockquote><div><br></div><div>If I get it well, the point here is to make the doc available when you’re offline too, right? But in fact this is probably why it’s so unappealing to think of the doc with 49 localized versions. It would be huge, and if we add to this the screenshots, it will be even bigger. If the doc is online only and not shipped with the application, everything will be easier and lighter, don’t you think?</div>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div bgcolor="#ffffff" text="#000000">
<br>
There is, and never has been, any intention of producing a book from
this content.<br></div></blockquote><div><br></div><div>I understand that there is and never has been such intention but this is exactly what I suggest for the future! Some people need a book — that is understandable and acknowledged — but why would the content of this book be different (or so different) than what’s available on the website is one question I ask. It would simply be repurposing of the same data.</div>
<div><br></div><div>Again, I think that there are some bugs into the doc workflow and I suggest ways of making things better.</div><div><br></div><div>I think that the wikipedia way is more appropriate for documentation as SVN is probably more suitable for code.</div>
<div><br></div><div>Louis</div><div><br></div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div bgcolor="#ffffff" text="#000000">
Craig</div></blockquote></div>