[Tinyos-devel] tutorials on docs.tinyos.net wiki (was: Tinyos2.x on Mac)

Wed Dec 19 12:14:47 PST 2007

I am not claiming that reST is a better markup than MediaWiki, but that we
might benefit from keeping the same markup across the working groups. This
would enable direct editing/annotation of the TEPs  like you suggested in
the other mail.

BTW, the link on the Core WG wiki is now live:
http://tinyos.stanford.edu:8000/VladoHandziski/MoinMoinReStructuredTextExample

and shows how an unmodified TEP source can be directly rendered/modified on
the wiki.

Vlado

On Dec 19, 2007 2:26 AM, Matt Welsh <mdw at eecs.harvard.edu> wrote:

> I'm not sure I'm interested in revisiting the markup language issue
> right now.
> It's unclear to me that reST is any better than MediaWiki or any other
> Wiki-based tool, and we stand to lose momentum by waffling on the
> platform. If you want input on this, you can join the doc working
> group and put some effort into convincing the rest of the community
> that this is the right approach and then converting the documents we
> have into this format. I don't care.
>
> On Dec 17, 2007, at 6:33 AM, Vlado Handziski wrote:
>
> > reST is the markup originally used in Python's docutils and PEPs.
> > The MoinMoin wiki engine, being written in python, can support this
> > markup in addition to its own. reST is also supported by WordPress,
> > Trac, etc. There are even on-line services for converting reST
> > markup into PDF and HTML files.
> >
> > I've setup a demo page on the MoinMoin wiki used by the Core WG,
> > unfortunately, the machine hosting the wiki does not have docutils
> > installed, so for the results we have to wait for Phil/Kevin to
> > install the packages:
> >
> >
> http://tinyos.stanford.edu:8000/VladoHandziski/MoinMoinReStructuredTextExample
> >
> > as can be seen, all that is needed to use the alternative markup is
> > the directive:
> > #format rst
> >
> > This only changes the markup, and has no influence on the wiki model
> > itself, while allowing us to provide PDF or HTML versions of the
> > documentation if needed.
> >
> > We use this setup on our internal wiki and have been very satisfied
> > with the flexibility it offers.
> >
> > Vlado
> >
> >
> > On Dec 17, 2007 1:00 AM, Matt Welsh < mdw at eecs.harvard.edu> wrote:
> > I don't care particularly which markup language is used, but I do want
> > the doc WG to use a wiki model where pages can be edited
> > "online" (rather than requiring someone to download the source, edit
> > it separately, then manually publish it). I don't know anything about
> > reST or MoinMoin so would appreciate input on the issue.
> >
> >
> >
> > On Dec 16, 2007, at 6:36 PM, Vlado Handziski wrote:
> >
> > > I am a bit concerned about the proliferation of different source
> > > formats in the TinyOS documentation. The TEP files are reST, the
> > > original tutorials were directly composed in HTML and now we have a
> > > MediaWiki for the doc WG that forces us to use yet another markup. I
> > > believe we have been very happy with the reST. Now when things are
> > > in flux, maybe it is a good time to check if there is a way to
> > > consolidate the different source formats for the different types of
> > > documentation. Does the documentation WG insist on using the
> > > MediaWiki engine and markup? If we move to MoinMoin  (used by the
> > > Core WG)  we can use reST format for the tutorials also....
> > >
> > > Vlado
> > >
> > > On Dec 16, 2007 8:47 PM, Kevin Klues <klueska at gmail.com> wrote:
> > > The problem is that the tutorials on the wiki aren't complete yet.
> > > Most of them were just created using an html->wiki converter that
> > > didn't import any images and left some links external when they
> > > really should have been internal.  I agree though, once these
> > > tutorials are cleaned up, the link to the old ones should redirect
> > > you to the wiki site.  This is actually what I did with the MAC
> > > installation tutorial, but some people had apparently created
> > > bookmarks directly to the google documents page where I created it,
> > > rather than the masked address I used to redirect you there.  I've
> > > now just deleted the tutorial completely and put a reference to
> > > where the new one can be found in the contents of that page.
> > >
> > > Kevin
> > >
> > >
> > > On Dec 16, 2007 9:04 AM, John Griessen <john at ecosensory.com> wrote:
> > > Kevin Klues wrote:
> > > > Al of these error you mention are addressed in the updated version
> > > of the
> > > > tutorial you refernced that is now part of the tinyos
> > > documentation wiki at
> > > > docs.tinyos.net.  I should take down the old one so as not to
> > > confuse people
> > > > I guess..... either that or update it as well.
> > >
> > > The wiki is working easily to add new documentation as the urge
> > > strikes to write it, and the old
> > > tutorials set in the repository are going to be out of date now.
> > >
> > > Back when I wanted to
> > > get the word out about a platform creation tutorial and code that
> > > helps debug new
> > > platform circuit boards, that tutorials were part of the repository
> > > hindered me.
> > > I just published "a version" of the code tree tutorials page on my
> > > web server.
> > >
> > > I suggest deleting the tutorials from tinyos-2.x now, and stopping
> > > serving them from
> > > tinyos.net/tinyos-2.x/doc/html/tutorial.
> > >
> > > John Griessen
> > >
> > > --
> > > Ecosensory   Austin TX
> > > tinyOS devel on:  ubuntu Linux;   tinyOS v2.0.2;   telosb ecosens1
> > > _______________________________________________
> > > Tinyos-devel mailing list
> > > Tinyos-devel at millennium.berkeley.edu
> > >
> https://www.millennium.berkeley.edu/cgi-bin/mailman/listinfo/tinyos-devel
> > >
> > >
> > >
> > > --
> > > ~Kevin
> > > _______________________________________________
> > > Tinyos-devel mailing list
> > > Tinyos-devel at millennium.berkeley.edu
> > >
> https://www.millennium.berkeley.edu/cgi-bin/mailman/listinfo/tinyos-devel
> > >
> > >
> > > _______________________________________________
> > > Tinyos-devel mailing list
> > > Tinyos-devel at millennium.berkeley.edu
> > >
> https://www.millennium.berkeley.edu/cgi-bin/mailman/listinfo/tinyos-devel
> >
> >
> >
> >
> > _______________________________________________
> > Tinyos-devel mailing list
> > Tinyos-devel at millennium.berkeley.edu
> >
> https://www.millennium.berkeley.edu/cgi-bin/mailman/listinfo/tinyos-devel
>
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: https://www.millennium.berkeley.edu/pipermail/tinyos-devel/attachments/20071219/c552dde5/attachment.html