You are viewing a plain text version of this content. The canonical link for it is here.
Posted to rivet-dev@tcl.apache.org by Massimo Manghi <ma...@unipr.it> on 2007/10/10 16:02:40 UTC

Rivet docs

I recently proposed to merge the docs in 1_0 into trunk (no backward
merge was in my intentions). I'm doing it tonight in my working copy
and then I will ask to commit the merge.

 This might also be a chance to write down a list of things that have
to be done for the docs in the near future.

-  For what I know the Russian version of the manual is orphaned.
I can take care of the Italian manual but I wonder if our workforce
is large enough to keep up 3 versions of the manual, we could
concentrate on the English manual as we (hopefully) add more
functionalities and expand the docs.

- The manual is a big xml file. Breaking it in 3 or 4 smaller files
bound together in rivet.xml would make the editing more manageable.

- I have a problem in the html generated by rivet.xml for which
i could not find easily an explanation: the navigation right button
in the "variables and commands" page doesn't link to the following
page but within the same page instead. I thought the dom of
the file had a problem (missing or mispelled tags) but it seemed
to be ok. Anyone can reproduce the same problem?



 -- Massimo
 

---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org


Re: Rivet docs

Posted by Massimo Manghi <ma...@unipr.it>.
Comprehensive patch that fixes a couple of spelling errors, changes the 
front page
and expands the description of 'load_response'. I will commit 
'load_response' (the
procedure) when i commit the docs also.

 -- Massimo


Index: rivet.xml
===================================================================
--- rivet.xml   (revision 584150)
+++ rivet.xml   (working copy)
@@ -37,6 +37,9 @@
       <year>2002</year>
       <year>2003</year>
       <year>2004</year>
+      <year>2005</year>
+      <year>2006</year>
+      <year>2007</year>
       <holder>Apache Software Foundation</holder>
     </copyright>
     <author>
@@ -49,11 +52,11 @@
       </affiliation>
     </author>
   </articleinfo>
-  <para>
+  <!--para>
     This document is also available in the following languages: <ulink
     url="index.it.html">Italian</ulink>, <ulink
     url="index.ru.html">Russian</ulink>
-  </para>
+  </para-->

   <para>
     Document revision: $Revision$, last modified $Date$ by $Author$.
@@ -914,7 +917,21 @@
       <refsect1>
        <title>Description</title>
        Load any form variables passed to this page into an
-       array.
+       array. If <command>load_response</command> is called without
+       arguments the array <option>response</option> is created in
+       the scope of the caller. If the variables var1,var2,var3...
+       having values val1,val2,val3... are passed to the page, the
+       resulting array will be a collection mapping var1,var2,var3...
+       to their corresponding values. <command>load_response</command>
+       was inspired by the same NeoWebScript procedure in the way
+       it deals with multiple assignments: if a variable
+       is assigned more than once the corresponding array element will be a
+       list of the values for the variable. This can be useful in the case
+       of forms with checkbox options that are given the same name.
+       Calling <command>load_response</command> several times for the same
+       array results in adding more values to the array at every call.
+       When needed it is left to the caller to empty the array between
+       two subsequent calls.
       </refsect1>
     </refentry>




---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org


Re: Rivet docs

Posted by David Welton <da...@gmail.com>.
> dio and diodisplay pages don't link to the following
> sections (neither they link to their own subsections)

Woops - it was simply a matter of correcting the id's in the sections:

  <section id="diodisplay">
    <title>DIODisplay - Database Interface Objects Display Class</title>
    <refentry id="diodisplay_package">

> what if we updated the front page? If we are
> dropping the build of the Italian and Russian
> manuals we should at least comment out the links
> to these pages (and maybe remove their .html files
> from the repository). What do you think?

By all means!

-- 
David N. Welton
http://www.welton.it/davidw/

---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org


Re: Rivet docs

Posted by Massimo Manghi <ma...@unipr.it>.
On Thu, 11 Oct 2007 20:09:58 +0200, David Welton wrote
> Ok, the problem was some of the 'fancy' xslt stuff that was 
> happening. I just tossed it out, because that's the simplest thing 
> to do to make it work.  It could use some CSS work too, if anyone 
> were interested.
> 

dio and diodisplay pages don't link to the following
sections (neither they link to their own subsections)

what if we updated the front page? If we are
dropping the build of the Italian and Russian
manuals we should at least comment out the links
to these pages (and maybe remove their .html files
from the repository). What do you think?

Index: rivet.xml
===================================================================
--- rivet.xml   (revision 583966)
+++ rivet.xml   (working copy)
@@ -37,6 +37,9 @@
       <year>2002</year>
       <year>2003</year>
       <year>2004</year>
+      <year>2005</year>
+      <year>2006</year>
+      <year>2007</year>
       <holder>Apache Software Foundation</holder>
     </copyright>
     <author>
@@ -49,11 +52,11 @@
       </affiliation>
     </author>
   </articleinfo>
-  <para>
+  <!--para>
     This document is also available in the following languages: <ulink
     url="index.it.html">Italian</ulink>, <ulink
     url="index.ru.html">Russian</ulink>
-  </para>
+  </para-->

   <para>
     Document revision: $Revision$, last modified $Date$ by $Author$.

-- Massimo
Universita' degli Studi di Parma (http://www.unipr.it)


---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org


Re: Rivet docs

Posted by David Welton <da...@gmail.com>.
Ok, the problem was some of the 'fancy' xslt stuff that was happening.
 I just tossed it out, because that's the simplest thing to do to make
it work.  It could use some CSS work too, if anyone were interested.

-- 
David N. Welton
http://www.welton.it/davidw/

---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org


Re: Rivet docs

Posted by Massimo Manghi <ma...@unipr.it>.
On Thu, 11 Oct 2007 18:10:45 +0200, David Welton wrote
> > I commited the merge. I inferred the branch revision number from the
> > log of rivet.xml. Does an svn command exist that returns the revnum in
> > a more reliable way?
> 
> svn log
> 
> ?
> 

when i said that i inferred the revision number from
the log i meant 'svn log'. you did intentionally 
write in the log the creation of the branch and that
saved the day for me. IIRC cvs had a branching 
mechanism that was reflected in the way file
version numbers were generated for the branch.

> > > Seems to work for me.
> >
> > It doesn't for Cristian too.
> 
> Ah, I see the problem in the latest version.  It's sending you to the
> subsections within the document. I'll have a look.
> 

ok thanks

-- Massimo


---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org


Re: Rivet docs

Posted by David Welton <da...@gmail.com>.
> I commited the merge. I inferred the branch revision number from the
> log of rivet.xml. Does an svn command exist that returns the revnum in
> a more reliable way?

svn log

?

> > Seems to work for me.
> >
> >
>
>
> It doesn't for Cristian too.

Ah, I see the problem in the latest version.  It's sending you to the
subsections within the document. I'll have a look.

-- 
David N. Welton
http://www.welton.it/davidw/

---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org


Re: Rivet docs

Posted by Massimo Manghi <ma...@unipr.it>.
David Welton wrote:
> On 10/10/07, Massimo Manghi <ma...@unipr.it> wrote:
>   
>> I recently proposed to merge the docs in 1_0 into trunk (no backward
>> merge was in my intentions). I'm doing it tonight in my working copy
>> and then I will ask to commit the merge.
>>     
>
> Go for it!
>
>   
I commited the merge. I inferred the branch revision number from the
log of rivet.xml. Does an svn command exist that returns the revnum in
a more reliable way?

> I would say dump the Italian and Russian versions.  Your time is more
> valuable working on code, I think.
>
>   

I agree, I'll do it as soon as we start to make changes.

> Seems to work for me.
>
>   


It doesn't for Cristian too. 


-- Massimo

---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org


Re: Rivet docs

Posted by David Welton <da...@gmail.com>.
On 10/10/07, Massimo Manghi <ma...@unipr.it> wrote:
> I recently proposed to merge the docs in 1_0 into trunk (no backward
> merge was in my intentions). I'm doing it tonight in my working copy
> and then I will ask to commit the merge.

Go for it!

>  This might also be a chance to write down a list of things that have
> to be done for the docs in the near future.
>
> -  For what I know the Russian version of the manual is orphaned.
> I can take care of the Italian manual but I wonder if our workforce
> is large enough to keep up 3 versions of the manual, we could
> concentrate on the English manual as we (hopefully) add more
> functionalities and expand the docs.

I would say dump the Italian and Russian versions.  Your time is more
valuable working on code, I think.

> - The manual is a big xml file. Breaking it in 3 or 4 smaller files
> bound together in rivet.xml would make the editing more manageable.

I'll see what I can do.  I suppose if every major section had its own
file it would be easier.

> - I have a problem in the html generated by rivet.xml for which
> i could not find easily an explanation: the navigation right button
> in the "variables and commands" page doesn't link to the following
> page but within the same page instead. I thought the dom of
> the file had a problem (missing or mispelled tags) but it seemed
> to be ok. Anyone can reproduce the same problem?

Seems to work for me.

-- 
David N. Welton
http://www.welton.it/davidw/

---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org


Fwd: Rivet docs

Posted by Cristian <cr...@gmail.com>.
I forgot again to add the mailing list in the reply...
I'm on debian unstable... if that knowledge might help.

Cristian.

---------- Forwarded message ----------
From: Massimo Manghi <ma...@unipr.it>
Date: Oct 11, 2007 2:22 PM
Subject: Re: Rivet docs
To: Cristian <cr...@gmail.com>

Cristian wrote:
>
>
> Hi Massimo,
> I see the same problem with the Dio and Diodisplay pages.
>
> Cristian.
>
>
Hi Cristian, please would you send your message also to the
list? David says he's not having this problem and maybe this
must be notified to him. Anyway you're right about
dio and diodisplay...it's the same for me,
thank you for pointing this out... I don't know who is
the cuprit...maybe our docbook installations?

-- Massimo