Hi Bart,

Just found this!! I've attached the $DOCDIR/template and $EXDIR/template we use. However, in the current Click site, we do this differently -- we create Dokuwiki-formatted files rather than HTML.

Eddie


Bart Braem wrote:
Thanks for the fast answer! The script requires a template in both $DOCDIR/template and $EXDIR/template for use by click-pretty, if I understand things correctly. What should I provide? No template or just a directory do not seem to be good ideas.

regards,
Bart

On 20 Oct 2009, at 20:46, Eddie Kohler wrote:

All of Click's online documentation is generated by a script that is checked in to the repository, but not part of the tarball. The script is doc/mkwebdoc.pl. It depends on doc/man2html as well.

The online element documentation is stored in a dokuwiki (easy to find online); at this point doc/mkwebdoc.pl generates dokuwiki-formatted files.

E


[email protected] wrote:
I wonder is this an offer to run a click mirror site ? :-)
Adam
-original message-
Subject: [Click] Generate local Click element documentation?
From: "Bart Braem" <[email protected]>
Date: 20/10/2009 4:35 pm
Hi,
What would be the best way to generate local element documentation?
Our students have to use Click-1.6.0, so we want to generate a copy of the element documentation of version 1.6.0 and host it on a local web server. We know the element documentation is generated, but how?
regards,
Bart
_______________________________________________
click mailing list
[email protected]
https://amsterdam.lcs.mit.edu/mailman/listinfo/click
_______________________________________________
click mailing list
[email protected]
https://amsterdam.lcs.mit.edu/mailman/listinfo/click


Title: &mantitle; - Click documentation
Click home
documentation
&mantitle;

Click documentation

Click home
examples
<~filename>

<~filename>: <~title>

Configuration

<~config>

Element tables

' noinputentry='' outputentry='' nooutputentry='' inputconnection='<~name> [<~port>]' outputconnection='[<~port>] <~name>' noinputconnection='not connected' nooutputconnection='not connected' column='1/2' /-->' noinputentry='' outputentry='' nooutputentry='' inputconnection='<~name> [<~port>]' outputconnection='[<~port>] <~name>' noinputconnection='not connected' nooutputconnection='not connected' column='2/2' /-->
<~elements entry='
<~name> :: <~type link><~config limit=10 parens> <~configlink>
  <~inputs><~outputs>
' configlink='(config)' inputentry='
input  <~port> (<~processing>) <- <~inputconnections sep=", ">
no inputs
output <~port> (<~processing>) -> <~outputconnections sep=", ">
no outputs
  <~elements entry='
<~name> :: <~type link><~config limit=10 parens> <~configlink>
  <~inputs><~outputs>
' configlink='(config)' inputentry='
input  <~port> (<~processing>) <- <~inputconnections sep=", ">
no inputs
output <~port> (<~processing>) -> <~outputconnections sep=", ">
no outputs

Index

<~elements entry='

<~name> :: <~type link> - <~configlink sep=", ">table

' typeentry='

<~type link> (type)
see <~typerefs sep=", ">

' typeref='<~name>' configlink='config' column='1/2' /-->
  <~elements entry='

<~name> :: <~type link> - <~configlink sep=", ">table

' typeentry='

<~type link> (type)
see <~typerefs sep=", ">

' typeref='<~name>' configlink='config' column='2/2' /-->
_______________________________________________
click mailing list
[email protected]
https://amsterdam.lcs.mit.edu/mailman/listinfo/click

Reply via email to