I'd prefer Markdown/PanDoc for target output, as its well supported and has
several output formats.

On Tue, Feb 26, 2013 at 6:01 PM, Ric Sherlock <[email protected]> wrote:

> Joxygen was inspired by Roxygen/Doxygen. You can read more about it from
> the slides in my talk at the J conference.
>
> http://www.jsoftware.com/jwiki/Community/Conference2012/Talks?action=AttachFile&do=view&target=Document_J_Scripts.pdf
>
> What I've done so far up is on the svn server. It currently has one working
> target output - the format/publish addon, but it's more a proof of concept
> than a finished product.
>
> I think the decision that needs to be made now is whether to use a more
> standard text formatting like Markdown or ReST that would let us leverage
> something like PanDoc, or go it ourselves.
>
> Using the format/publish addon is quite nice in that there are no  external
> dependencies (pandoc, latex), but to get the sort of control that we need,
> there'd need to be some more development on the format/publish addon. Not
> sure how much work that would be.
>
> Currently there is no functionality for producing MoinMoin markup for the
> Wiki. That just needs a different output processor. I don't think  that
> PanDoc supports creating MoinMoin markup directly, but it may be  possible
> to get it to produce a format that the Wiki will accept (e.g. ReST).
>
> I'll try to spend some more time on this soon, but can't promise anything.
> If anybody else has any input please let me know.
>
> On Tue, Feb 26, 2013 at 6:43 PM, bill lam <[email protected]> wrote:
>
> > If I remember correctly, the context help uses a vi style tag
> > file to locate entries, so that if there is a local copy of those
> > source files, one can generate a new tag file pointing to local
> > contents.  That should be described in the jtag of GTKIDE guide
> > and inside base.cfg file.
> >
> > the joxygen is inside svn but not yet release.  It was there
> > since last year.  Part of its manifest is as follows,
> >
> > NB. joxygen manifest
> >
> > CAPTION=: 'Documenting J Scripts'
> >
> > DESCRIPTION=: 0 : 0
> > Parses in-script comments to that use Joxygen conventions.
> > Outputs various documentation formats.
> >
> > Contributed by Ric Sherlock
> > )
> >
> > Вт, 26 фев 2013, Gilles Kirouac писал(а):
> > >
> > >   I tried the context help feature. Very neat indeed. In my test
> > > (on MS-Win), it opened the original strings script
> > > from the subversion base at jsoftware.com. Excellent as long
> > > as you are connected. I suppose if someone would keep
> > > the subversion content locally, there could be a parameter
> > > to use the local copy instead.
> > >
> > >   I was not aware of Context Sensitive Help; I should have been!
> > >
> > > >Will you accept if a separate documentation file for stdlib be
> > > >available somewhere?
> > >
> > >   Yes. The original "true source" scripts were previously described
> > > in the User Manual, but I can't find them in J7. As Martin wrote,
> > > we need it "to find a suitable function in first place".
> > >
> > > >There is a joxygen addon but I have no experience with it or
> > > >the original oxygen either.
> > >
> > >   I don't see this addon and I only know oxygen as a theme
> > > in Linux and a XML editor. Curious.
> > >
> > >  ~ Gilles
> > >
> > > ---------- Original Message -----------
> > > From: bill lam <[email protected]>
> > > To: [email protected]
> > > Sent: Mon, 25 Feb 2013 00:12:05 +0800
> > > Subject: Re: [Jgeneral] How access script documentation?
> > >
> > > > I bet very few users have actually used that context help
> > > > feature.  It will open the original source file and jump to the
> > > > exact line containing the name concerned.
> > > >
> > > > Your suggestion of pop up from mouse hovering is appealing, but
> > > > I'll leave that to Chris.
> > > ...
> > > ------- End of Original Message -------
> > >
> > > ----------------------------------------------------------------------
> > > For information about J forums see http://www.jsoftware.com/forums.htm
> >
> > --
> > regards,
> > ====================================================
> > GPG key 1024D/4434BAB3 2008-08-24
> > gpg --keyserver subkeys.pgp.net --recv-keys 4434BAB3
> > ----------------------------------------------------------------------
> > For information about J forums see http://www.jsoftware.com/forums.htm
> >
> ----------------------------------------------------------------------
> For information about J forums see http://www.jsoftware.com/forums.htm
>
----------------------------------------------------------------------
For information about J forums see http://www.jsoftware.com/forums.htm

Reply via email to