Menu
▾
▴
docutils-users
|
From: Renato P. <ren...@gm...> - 2016-02-13 13:53:59
|
Hi, I'm still looking for "the best" way to build a documentation of the procedure program I use. I'm very inrested in .rst. Because of the way to produce HTML and .pdf output. But I still need a way to built docs, by more people. so I need (I think) a wiki as a container of that doc. Can someone sudgest me a way? TIA Renato |
|
From: Chris G. <cl...@is...> - 2016-02-13 14:46:22
|
On Sat, Feb 13, 2016 at 01:53:42PM +0000, Renato Pontefice wrote: > Hi, > I'm still looking for "the best" way to build a documentation of the > procedure program I use. > I'm very inrested in .rst. Because of the way to produce HTML and .pdf > output. > But I still need a way to built docs, by more people. so I need (I > think) a wiki as a container of that doc. > Can someone sudgest me a way? There are several wikis which can work with RST, a quick Google search will turn up a few. I have written an RST plugin for Dokuwiki which is an excellent wiki for documentation. -- Chris Green |
|
From: renato <ren...@gm...> - 2016-02-13 15:34:39
|
Ok, I 've seen it. It seem very intresting. It has all the thing that I'm looking for. Now, I've to try it and try to write .rst and export on html and pdf. Are there some sandbox that I can proof? Renato Il giorno sab, 13/02/2016 alle 14.46 +0000, Chris Green ha scritto: > On Sat, Feb 13, 2016 at 01:53:42PM +0000, Renato Pontefice wrote: > > Hi, > > I'm still looking for "the best" way to build a documentation of > > the > > procedure program I use. > > I'm very inrested in .rst. Because of the way to produce HTML > > and .pdf > > output. > > But I still need a way to built docs, by more people. so I need > > (I > > think) a wiki as a container of that doc. > > Can someone sudgest me a way? > > There are several wikis which can work with RST, a quick Google > search > will turn up a few. > > I have written an RST plugin for Dokuwiki which is an excellent wiki > for documentation. > |
|
From: Chris G. <cl...@is...> - 2016-02-13 15:55:41
|
On Sat, Feb 13, 2016 at 04:34:29PM +0100, renato wrote:
> Il giorno sab, 13/02/2016 alle 14.46 +0000, Chris Green ha scritto:
> > On Sat, Feb 13, 2016 at 01:53:42PM +0000, Renato Pontefice wrote:
> > > Hi,
> > > I'm still looking for "the best" way to build a documentation of
> > > the
> > > procedure program I use.
> > > I'm very inrested in .rst. Because of the way to produce HTML
> > > and .pdf
> > > output.
> > > But I still need a way to built docs, by more people. so I need
> > > (I
> > > think) a wiki as a container of that doc.
> > > Can someone sudgest me a way?
> >
> > There are several wikis which can work with RST, a quick Google
> > search
> > will turn up a few.
> >
> > I have written an RST plugin for Dokuwiki which is an excellent wiki
> > for documentation.
> >
> Ok, I 've seen it. It seem very intresting. It has all the thing that
> I'm looking for. Now, I've to try it and try to write .rst and export
> on html and pdf.
> Are there some sandbox that I can proof?
>
Dokuwiki is quite simple to install if you have a server of your own,
alternatively a lot of hosting providers have it as a standard web
application to install from the control panel.
A basic Dokuwiki installation comes with a 'playground' area which is
a place to try things out.
... even better, the Dokuwiki home has a playground page:-
https://www.dokuwiki.org/playground
--
Chris Green
|
|
From: Guenter M. <mi...@us...> - 2016-02-13 19:25:12
|
On 2016-02-13, Renato Pontefice wrote: > Hi, > I'm still looking for "the best" way to build a documentation of the > procedure program I use. > I'm very inrested in .rst. Because of the way to produce HTML and .pdf > output. > But I still need a way to built docs, by more people. so I need (I think) a > wiki as a container of that doc. Alternatively, you might consider putting the rst-source under version control. To me, this seems the easiest solution in case the program itself is under version control and the programmers are the same people that also should be able to work on the documentation, at least. Günter |
|
From: Renato P. <ren...@gm...> - 2016-02-15 09:58:33
|
There are several wikis which can work with RST, a quick Google search > will turn up a few. > > I have written an RST plugin for Dokuwiki which is an excellent wiki > for documentation. > > -- > Chris Green > Hi Chris, is this you plugin? > rst Plugin by chrsibsd > I've just seen and installed DW. I need to learn it a bit. > > ------------------------------------------------------------------------------ > Site24x7 APM Insight: Get Deep Visibility into Application Performance > APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month > Monitor end-to-end web transactions and take corrective actions now > Troubleshoot faster and improve end-user experience. Signup Now! > http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140 > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > |
|
From: Chris G. <cl...@is...> - 2016-02-15 10:03:29
|
On Mon, Feb 15, 2016 at 09:58:16AM +0000, Renato Pontefice wrote: > There are several wikis which can work with RST, a quick Google search > > will turn up a few. > I have written an RST plugin for Dokuwiki which is an excellent wiki > for documentation. > -- > Chris Green > > Hi Chris, is this you plugin? > > rst Plugin by chrsibsd > > I've just seen and installed DW. I need to learn it a bit. > Yes, that's my plugin. It's very simple, just uses the Docutils utilities to do the actual conversion from RST to HTML. All my plugin does is hook the conversion into Docuwiki. -- Chris Green |
|
From: Renato P. <ren...@gm...> - 2016-02-15 10:15:16
|
where do can I look for ocumentation? Renato Il giorno lun 15 feb 2016 alle ore 11:03 Chris Green <cl...@is...> ha scritto: > On Mon, Feb 15, 2016 at 09:58:16AM +0000, Renato Pontefice wrote: > > There are several wikis which can work with RST, a quick Google search > > > > will turn up a few. > > I have written an RST plugin for Dokuwiki which is an excellent wiki > > for documentation. > > -- > > Chris Green > > > > Hi Chris, is this you plugin? > > > > rst Plugin by chrsibsd > > > > I've just seen and installed DW. I need to learn it a bit. > > > Yes, that's my plugin. It's very simple, just uses the Docutils > utilities to do the actual conversion from RST to HTML. All my plugin > does is hook the conversion into Docuwiki. > > -- > Chris Green > > > ------------------------------------------------------------------------------ > Site24x7 APM Insight: Get Deep Visibility into Application Performance > APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month > Monitor end-to-end web transactions and take corrective actions now > Troubleshoot faster and improve end-user experience. Signup Now! > http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140 > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > |
|
From: Chris G. <cl...@is...> - 2016-02-15 10:39:31
|
On Mon, Feb 15, 2016 at 10:15:00AM +0000, Renato Pontefice wrote:
> where do can I look for ocumentation?
> Renato
>
It's not very extensive (it's a very simple plugin), but it's here:-
https://www.dokuwiki.org/plugin:rst
--
Chris Green
|
|
From: Renato P. <ren...@gm...> - 2016-02-16 09:30:26
|
Hi, I'm little bit confused...I thought that I can use the normal wiki function, and finaly export varrious page as .rst (then use the .rst to create .pdf or HTML by rst2pdf or rst2html macro).IT seems that it is not the way. I need to create a new link as a .rst page. Is this the way? Or do I made some mistake? Renato Il giorno lun 15 feb 2016 alle ore 11:39 Chris Green <cl...@is...> ha scritto: > On Mon, Feb 15, 2016 at 10:15:00AM +0000, Renato Pontefice wrote: > > where do can I look for ocumentation? > > Renato > > > It's not very extensive (it's a very simple plugin), but it's here:- > > https://www.dokuwiki.org/plugin:rst > > > -- > Chris Green > > > ------------------------------------------------------------------------------ > Site24x7 APM Insight: Get Deep Visibility into Application Performance > APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month > Monitor end-to-end web transactions and take corrective actions now > Troubleshoot faster and improve end-user experience. Signup Now! > http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140 > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > |
|
From: Chris G. <cl...@is...> - 2016-02-16 10:57:13
|
On Tue, Feb 16, 2016 at 09:30:06AM +0000, Renato Pontefice wrote: > Hi, I'm little bit confused...I thought that I can use the normal wiki > function, and finaly export varrious page as .rst (then use the .rst to > create .pdf or HTML by rst2pdf or rst2html macro).IT seems that it is > not the way. I need to create a new link as a .rst page. > Is this the way? Or do I made some mistake? You just create pages in the Wiki and access them as a Wiki, there's no explicit exporting involved the pages are generated dynamically by the Dokuwiki 'engine'. So, if it's an ordinary Dokuwiki syntax page the Dokuwiki engine converts it from Dokuwiki syntax to HTML for the web server to send. If it's some RST then the Dokuwiki engine passes it to my RST plugin which converts it to HTML for the web server. You can either embed RST in a normal Dokuwiki page using the <rst> and </rst> directives or you can create pages with .rst as a suffix and the whole page will be treated as RST. So my RST plugin just provides a way to write your wiki pages in a different mark-up language from the default Dokuwiki markup, they are still Wiki pages just liek the rest of your wiki. -- Chris Green |
|
From: Renato P. <ren...@gm...> - 2016-02-16 11:23:19
|
thank you Chris, maybe I've found another solution;: I've installed a dokuwiki pluginm, that let me export the entir Wiki, as a .pdf. So, with the regular Dokuwiki formatting, I can have either the wiki and the pdf. I've considered .rst just to be able to produce html and pdf from the same source. Maybe this way could work Renato Il giorno mar 16 feb 2016 alle ore 11:57 Chris Green <cl...@is...> ha scritto: > On Tue, Feb 16, 2016 at 09:30:06AM +0000, Renato Pontefice wrote: > > Hi, I'm little bit confused...I thought that I can use the normal wiki > > function, and finaly export varrious page as .rst (then use the .rst > to > > create .pdf or HTML by rst2pdf or rst2html macro).IT seems that it is > > not the way. I need to create a new link as a .rst page. > > Is this the way? Or do I made some mistake? > > You just create pages in the Wiki and access them as a Wiki, there's > no explicit exporting involved the pages are generated dynamically by > the Dokuwiki 'engine'. > > So, if it's an ordinary Dokuwiki syntax page the Dokuwiki engine > converts it from Dokuwiki syntax to HTML for the web server to send. > If it's some RST then the Dokuwiki engine passes it to my RST plugin > which converts it to HTML for the web server. > > You can either embed RST in a normal Dokuwiki page using the <rst> and > </rst> directives or you can create pages with .rst as a suffix and > the whole page will be treated as RST. > > So my RST plugin just provides a way to write your wiki pages in a > different mark-up language from the default Dokuwiki markup, they are > still Wiki pages just liek the rest of your wiki. > > > -- > Chris Green > > > ------------------------------------------------------------------------------ > Site24x7 APM Insight: Get Deep Visibility into Application Performance > APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month > Monitor end-to-end web transactions and take corrective actions now > Troubleshoot faster and improve end-user experience. Signup Now! > http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140 > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > |
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X