Menu
▾
▴
naviserver-devel
|
From: Zoran V. <zv...@ar...> - 2006-09-05 17:06:49
|
On 05.09.2006, at 19:07, Bernd Eidenschink wrote: > > http://wiki2man.sourceforge.net/ Almost (although you are right)! What we need is wiki->doctools man-pages not nroff man pages. (what a stupid naming mess !!!) I wonder if there is a wiki->doctools as I know there is doctools->wiki converter... Cheers Zoran |
|
From: Stephen D. <sd...@gm...> - 2006-09-06 21:16:01
|
On 9/5/06, Zoran Vasiljevic <zv...@ar...> wrote: > > On 05.09.2006, at 19:07, Bernd Eidenschink wrote: > > > > > http://wiki2man.sourceforge.net/ > > Almost (although you are right)! What we need is > wiki->doctools man-pages not nroff man pages. > (what a stupid naming mess !!!) > > I wonder if there is a wiki->doctools as I know > there is doctools->wiki converter... If someone adds some Makefile magic to generate nroff and HTML from the doctools source, I'll set up sourceforge to auto generate the HTML straight from CVS and make it available on the website. There's a script in there now which creates symbolic links for all the commands embedded in a singe file, so if foo, bar, and baz are all documented in the foo.man file, you can still access bar and baz directly via 'man bar' etc. Does doctools support anything like this? We can add some wiki-macros so that whenever you type [proc ns_foo] it creates a link to /doc/ns_foo.html (or wherever). If the API doc is always automatically uptodate on the website then that can be the single canonical location to find everything. Is there a script which will convert the existing man pages to doctools format? We can't be the first people to ever have done this. If we can convert the existing stuff, then strip out the old/deprecated APIs and stubb out the new ones, I think finding time to sit down and write something will be much easier. |
|
From: Vlad S. <vl...@cr...> - 2006-09-06 21:24:15
|
agree, having only one place and way of writing documentation will provide no barriers for updating it, just laziness or lack of time :-)) Stephen Deasey wrote: > On 9/5/06, Zoran Vasiljevic <zv...@ar...> wrote: >> On 05.09.2006, at 19:07, Bernd Eidenschink wrote: >> >>> http://wiki2man.sourceforge.net/ >> Almost (although you are right)! What we need is >> wiki->doctools man-pages not nroff man pages. >> (what a stupid naming mess !!!) >> >> I wonder if there is a wiki->doctools as I know >> there is doctools->wiki converter... > > > If someone adds some Makefile magic to generate nroff and HTML from > the doctools source, I'll set up sourceforge to auto generate the HTML > straight from CVS and make it available on the website. > > There's a script in there now which creates symbolic links for all the > commands embedded in a singe file, so if foo, bar, and baz are all > documented in the foo.man file, you can still access bar and baz > directly via 'man bar' etc. Does doctools support anything like this? > > We can add some wiki-macros so that whenever you type [proc ns_foo] it > creates a link to /doc/ns_foo.html (or wherever). > > If the API doc is always automatically uptodate on the website then > that can be the single canonical location to find everything. > > > Is there a script which will convert the existing man pages to > doctools format? We can't be the first people to ever have done this. > > If we can convert the existing stuff, then strip out the > old/deprecated APIs and stubb out the new ones, I think finding time > to sit down and write something will be much easier. > > ------------------------------------------------------------------------- > Using Tomcat but need to do more? Need to support web services, security? > Get stuff done quickly with pre-integrated technology to make your job easier > Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo > http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 > _______________________________________________ > naviserver-devel mailing list > nav...@li... > https://lists.sourceforge.net/lists/listinfo/naviserver-devel > -- Vlad Seryakov 571 262-8608 office vl...@cr... http://www.crystalballinc.com/vlad/ |
|
From: Bernd E. <eid...@we...> - 2006-09-07 10:18:21
|
> If the API doc is always automatically uptodate on the website then > that can be the single canonical location to find everything. A little grouching from me: Not now, but sometime later, we need a faster webpage. No matter what: a dedicated server, a new or version of the Wiki or another Wiki that allows caching in the sense of static HTML pages, or no Wiki at all and from whatever produced HTML pages. But currently THIS wiki is so slow at times, so r e a l l y slow, it kills time you could better invest in doing real work. Bernd. |
|
From: Stephen D. <sd...@gm...> - 2006-09-07 19:12:35
|
On 9/7/06, Bernd Eidenschink <eid...@we...> wrote: > > If the API doc is always automatically uptodate on the website then > > that can be the single canonical location to find everything. > > A little grouching from me: Not now, but sometime later, we need a faster > webpage. No matter what: a dedicated server, a new or version of the Wiki or > another Wiki that allows caching in the sense of static HTML pages, or no > Wiki at all and from whatever produced HTML pages. > But currently THIS wiki is so slow at times, so r e a l l y slow, it kills > time you could better invest in doing real work. > > Bernd. It is annoyingly slow, isn't it. The MediaWiki does already cache to disk... Here's a weird idea: Why don't we use the Tcl wiki? http://wiki.tcl.tk/ NaviServer *is* a Tcl application, and our examples are mainly going to be Tcl applications. We have a whole bunch of Tcl (NaviServer) modules. We probably should be a bit more integrated into the Tcl community, and I'm sure there a are Tcl folks who would be interested in what we're doing. It doesn't feel like we'd be spamming some one else wiki. Doing this would maintain a very important advantage we currently have with sourceforge: very little maintenance on our part. In fact it would be better: zero maintenance! Plus, presumably there would be more people to help clean up after spammers etc. A disadvantage might be that the Tcl wiki is a little plain. We also don't have any control, should we need to change something. Well, I guess we have as much control as the rest of the Tcl community -- we can ask. If we did this, I imagine we would turn the current front page into a static portal page. It would point to key pages within the Tcl wiki which we would maintain, along with pointers to out mailing list interface, cvs, etc. The rest of our current website would be auto generated. The API docs, we've mentioned. We should also auto generate a page for each module in cvs, using the DOAP file. Is this a crazy idea? Should we ask someone at the Tcl wiki? |
|
From: Vlad S. <vl...@cr...> - 2006-09-07 19:26:01
|
This sounds better solution than using SF wiki but still site will not be distinctive and look like "very spare time and not often used project". I am still thinking a dedicated server running naviserver is the way to go but as it happen before i am not convincing anybody, just my opinion Stephen Deasey wrote: > On 9/7/06, Bernd Eidenschink <eid...@we...> wrote: >>> If the API doc is always automatically uptodate on the website then >>> that can be the single canonical location to find everything. >> A little grouching from me: Not now, but sometime later, we need a faster >> webpage. No matter what: a dedicated server, a new or version of the Wiki or >> another Wiki that allows caching in the sense of static HTML pages, or no >> Wiki at all and from whatever produced HTML pages. >> But currently THIS wiki is so slow at times, so r e a l l y slow, it kills >> time you could better invest in doing real work. >> >> Bernd. > > It is annoyingly slow, isn't it. The MediaWiki does already cache to disk... > > Here's a weird idea: Why don't we use the Tcl wiki? > > http://wiki.tcl.tk/ > > NaviServer *is* a Tcl application, and our examples are mainly going > to be Tcl applications. We have a whole bunch of Tcl (NaviServer) > modules. We probably should be a bit more integrated into the Tcl > community, and I'm sure there a are Tcl folks who would be interested > in what we're doing. It doesn't feel like we'd be spamming some one > else wiki. > > Doing this would maintain a very important advantage we currently have > with sourceforge: very little maintenance on our part. In fact it > would be better: zero maintenance! Plus, presumably there would be > more people to help clean up after spammers etc. > > A disadvantage might be that the Tcl wiki is a little plain. We also > don't have any control, should we need to change something. Well, I > guess we have as much control as the rest of the Tcl community -- we > can ask. > > > If we did this, I imagine we would turn the current front page into a > static portal page. It would point to key pages within the Tcl wiki > which we would maintain, along with pointers to out mailing list > interface, cvs, etc. > > The rest of our current website would be auto generated. The API > docs, we've mentioned. We should also auto generate a page for each > module in cvs, using the DOAP file. > > > Is this a crazy idea? Should we ask someone at the Tcl wiki? > > ------------------------------------------------------------------------- > Using Tomcat but need to do more? Need to support web services, security? > Get stuff done quickly with pre-integrated technology to make your job easier > Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo > http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 > _______________________________________________ > naviserver-devel mailing list > nav...@li... > https://lists.sourceforge.net/lists/listinfo/naviserver-devel > -- Vlad Seryakov 571 262-8608 office vl...@cr... http://www.crystalballinc.com/vlad/ |
|
From: Stephen D. <sd...@gm...> - 2006-09-07 19:51:56
|
On 9/7/06, Vlad Seryakov <vl...@cr...> wrote: > This sounds better solution than using SF wiki but still site will not > be distinctive and look like "very spare time and not often used project". > > I am still thinking a dedicated server running naviserver is the way to > go but as it happen before i am not convincing anybody, just my opinion Yeah, that is a concern. The front page, the API docs, module overview pages, and I guess whatever other static pages we have, could all still be branded however we like. Just not the wiki pages. Perhaps we could suggest some slight, generic, improvements to the look of the Tcl wiki? |
|
From: Vlad S. <vl...@cr...> - 2006-09-07 21:55:58
|
I have several servers running in datacenter i can give access to via ssh. They run naviserver already. No maintenace will be involed, once in a while update web pages, or install some scripts, if we product docs in doctools format, no need in backups, all is in CVS, we just generate html files and publish them. But backups are running every night anyway, i run some small databases there so it is one more level of reliability. Just a suggestion Stephen Deasey wrote: > On 9/7/06, Vlad Seryakov <vl...@cr...> wrote: >> This sounds better solution than using SF wiki but still site will not >> be distinctive and look like "very spare time and not often used project". >> >> I am still thinking a dedicated server running naviserver is the way to >> go but as it happen before i am not convincing anybody, just my opinion > > > Yeah, that is a concern. The front page, the API docs, module > overview pages, and I guess whatever other static pages we have, could > all still be branded however we like. Just not the wiki pages. > > Perhaps we could suggest some slight, generic, improvements to the > look of the Tcl wiki? > > ------------------------------------------------------------------------- > Using Tomcat but need to do more? Need to support web services, security? > Get stuff done quickly with pre-integrated technology to make your job easier > Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo > http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 > _______________________________________________ > naviserver-devel mailing list > nav...@li... > https://lists.sourceforge.net/lists/listinfo/naviserver-devel > -- Vlad Seryakov 571 262-8608 office vl...@cr... http://www.crystalballinc.com/vlad/ |
|
From: Vlad S. <vl...@cr...> - 2006-09-08 02:23:51
|
Simple style and web sitelike this for example: all other links will be auto-generated from CVS docs http://www.crystalballinc.com/vlad/nsdocs/ Vlad Seryakov wrote: > I have several servers running in datacenter i can give access to via ssh. > They run naviserver already. > No maintenace will be involed, once in a while update web pages, or > install some scripts, if we product docs in doctools format, no need in > backups, all is in CVS, we just generate html files and publish them. > > But backups are running every night anyway, i run some small databases > there so it is one more level of reliability. > > Just a suggestion > > Stephen Deasey wrote: >> On 9/7/06, Vlad Seryakov <vl...@cr...> wrote: >>> This sounds better solution than using SF wiki but still site will not >>> be distinctive and look like "very spare time and not often used project". >>> >>> I am still thinking a dedicated server running naviserver is the way to >>> go but as it happen before i am not convincing anybody, just my opinion >> >> Yeah, that is a concern. The front page, the API docs, module >> overview pages, and I guess whatever other static pages we have, could >> all still be branded however we like. Just not the wiki pages. >> >> Perhaps we could suggest some slight, generic, improvements to the >> look of the Tcl wiki? >> >> ------------------------------------------------------------------------- >> Using Tomcat but need to do more? Need to support web services, security? >> Get stuff done quickly with pre-integrated technology to make your job easier >> Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo >> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 >> _______________________________________________ >> naviserver-devel mailing list >> nav...@li... >> https://lists.sourceforge.net/lists/listinfo/naviserver-devel >> > -- Vlad Seryakov 571 262-8608 office vl...@cr... http://www.crystalballinc.com/vlad/ |
|
From: Vlad S. <vl...@cr...> - 2006-09-06 21:28:47
|
> > Is there a script which will convert the existing man pages to > doctools format? We can't be the first people to ever have done this. May be it makes sense to use API docs from panoptic Wiki, it has most recent documentation and ignore old nroff files at all? -- Vlad Seryakov 571 262-8608 office vl...@cr... http://www.crystalballinc.com/vlad/ |
|
From: Stephen D. <sd...@gm...> - 2006-09-06 21:30:34
|
On 9/6/06, Vlad Seryakov <vl...@cr...> wrote: > > > > Is there a script which will convert the existing man pages to > > doctools format? We can't be the first people to ever have done this. > > May be it makes sense to use API docs from panoptic Wiki, it has most > recent documentation and ignore old nroff files at all? If they're more uptodate, then sure. It would be nice to automate the initial conversion though. It would be such a great jumpstart that filling in the rest will be a piece of cake :-) |
|
From: Zoran V. <zv...@ar...> - 2006-09-07 11:50:57
|
On 06.09.2006, at 23:15, Stephen Deasey wrote: > On 9/5/06, Zoran Vasiljevic <zv...@ar...> wrote: >> >> On 05.09.2006, at 19:07, Bernd Eidenschink wrote: >> >>> >>> http://wiki2man.sourceforge.net/ >> >> Almost (although you are right)! What we need is >> wiki->doctools man-pages not nroff man pages. >> (what a stupid naming mess !!!) >> >> I wonder if there is a wiki->doctools as I know >> there is doctools->wiki converter... > > > If someone adds some Makefile magic to generate nroff and HTML from > the doctools source, I'll set up sourceforge to auto generate the HTML > straight from CVS and make it available on the website. This may not be the problem. I will try (honestly!) to make some directives in the makefile for that. It should be something like make doc make mandoc make htmldoc where make doc will make both and the others will make only the corresponding formats. I will put the putput into the doc/man doc/html and the source files (mainly templates for now) into doc/src > > There's a script in there now which creates symbolic links for all the > commands embedded in a singe file, so if foo, bar, and baz are all > documented in the foo.man file, you can still access bar and baz > directly via 'man bar' etc. Does doctools support anything like this? I do not thing they can but I'm not 100% sure. I'm afraid it will be 1:1 (one procedure per file) > > We can add some wiki-macros so that whenever you type [proc ns_foo] it > creates a link to /doc/ns_foo.html (or wherever). > > If the API doc is always automatically uptodate on the website then > that can be the single canonical location to find everything. > > > Is there a script which will convert the existing man pages to > doctools format? We can't be the first people to ever have done this. I do not know. I do not believe there are is such tool ready. Mostly people either have no content and they start with some or they already have large existing base in which case they stay with it. We have few in man, few in wiki, none in doctools. The reason why I'm for doctools is: its Tcl its easy to write its easy to convert to wiki/html > > If we can convert the existing stuff, then strip out the > old/deprecated APIs and stubb out the new ones, I think finding time > to sit down and write something will be much easier. I believe that converting the existing things is always going to require manual intervention. As of today we have: html pages from old aolserver docs wiki pages from new aolserver docs some nroff pages from old aolserver docs The task to convert all to doctools and then generate html and man (and wiki) is not small, but once you have done it, you can automate whatever you want. Plus: the doctools itself is written in Tcl so it would be easy for us to tweak it if necessary. I strongly beleive we should start with doc sources in doctools and then use converters to auto-generate other (handful of) formats. Zoran |
|
From: Bernd E. <eid...@we...> - 2006-09-07 12:16:51
|
> I strongly beleive we should start with doc sources in > doctools and then use converters to auto-generate other > (handful of) formats. I also vote for that. I'm creating an updated list of commands to be documented and will post them soon. Bernd. |
×
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