From: martin f k. <ma...@ma...> - 2006-07-26 13:54:51
|
I am through with CMS systems and hacking Makefiles to turn RST stuff into plain websites! From now on I'd like to maintain RST files and templates in version control and delegate the tool of generating integrated websites to some smart tool. It seems like what I want is some form of templating engine, and there are plenty out there: Cheetah, clearsilver, etc. Then there's rest2web[0], which doesn't seem to use any of these templating engines but seems to cook its own stuff. This puts me off. Thus I am turning to you with the question whether you have suggestions as to what tool to use? Is there a tool out there -- command-line only, and it has to have a batch mode -- that uses one of the known and established templating engines and can then turn my tree of RST files into a website, with proper links and possibly even navigation/breadcrumbs? Thanks for any information you might provide! 0. http://www.voidspace.org.uk/python/rest2web/index.html --=20 martin; (greetings from the heart of the sun.) \____ echo mailto: !#^."<*>"|tr "<*> mailto:" net@madduck =20 spamtraps: mad...@ma... =20 "if a packet hits a pocket on a socket on a port, and the bus is interrupted at a very last resort, and the access of the memory makes your floppy disk abort, then the socket packet pocket has an error to report." -- <speedstream> |
From: Seth F. <set...@gm...> - 2006-07-27 04:18:07
|
martin f krafft <ma...@ma...> writes: > Thus I am turning to you with the question whether you have > suggestions as to what tool to use? Is there a tool out there -- > command-line only, and it has to have a batch mode -- that uses one > of the known and established templating engines and can then turn my > tree of RST files into a website, with proper links and possibly > even navigation/breadcrumbs? You might want to look at Django (and perhaps other light-weight web frameworks). It has its own template lang, but I think this is quite pluggable with one of your choice. There is a contrib module called 'markup' that adds the smarts to interpret/render rst in templates. It isn't what you want, but perhaps it will give you an idea or a starting place. + seth |
From: martin f k. <ma...@ma...> - 2006-07-28 22:03:19
|
also sprach Seth Falcon <set...@gm...> [2006.07.27.0417 +0100]: > You might want to look at Django (and perhaps other light-weight web > frameworks). It has its own template lang, but I think this is quite > pluggable with one of your choice. There is a contrib module called > 'markup' that adds the smarts to interpret/render rst in templates. rest2web looks pretty decent, i just wonder why it (and Django) use their own templating engine, when there are surely enough around in the Python world... --=20 martin; (greetings from the heart of the sun.) \____ echo mailto: !#^."<*>"|tr "<*> mailto:" net@madduck =20 spamtraps: mad...@ma... =20 wind catches lily, scattering petals to the ground. segmentation fault. |
From: Ben F. <big...@be...> - 2006-07-27 11:41:55
|
Howdy all, What facilities are available for me to use docutils to convert reStructuredText documents to Unix man pages? I don't see a command line tool that seems obvious, and the best I can find with Google is this: <URL:http://docutils.sourceforge.net/sandbox/grubert/man/> which seems to be in current development (file modification times during this month). Is there something in the standard docutils distribution I'm missing? -- \ "First they came for the verbs, and I said nothing, for verbing | `\ weirds language. Then, they arrival for the nouns and I speech | _o__) nothing, for I no verbs." -- Peter Ellis | Ben Finney |
From: Felix W. <Fel...@gm...> - 2006-08-11 21:21:45
|
Ben Finney wrote in gmane.text.docutils.user: > What facilities are available for me to use docutils to convert > reStructuredText documents to Unix man pages? > > I don't see a command line tool that seems obvious, and the best I can > find with Google is this: > > <URL:http://docutils.sourceforge.net/sandbox/grubert/man/> Yeah, that's the only one right now. > which seems to be in current development (file modification times > during this month). No, it isn't. The file modification times on the website are misleading; that tool hasn't been touched for almost three years. It's certainly a more than incomplete implementation. Felix -- For private mail please ensure that the header contains 'Felix Wiemann'. "the number of contributors [...] is strongly and inversely correlated with the number of hoops each project makes a contributing user go through." -- ESR |
From: Ben F. <big...@be...> - 2006-07-27 12:10:41
|
Howdy all, What facilities are available for me to use docutils to convert reStructuredText documents to Unix man pages? I don't see a command line tool that seems obvious, and the best I can find with Google is this: <URL:http://docutils.sourceforge.net/sandbox/grubert/man/> which seems to be in current development (file modification times during this month). Is there something in the standard docutils distribution I'm missing? -- \ "First they came for the verbs, and I said nothing, for verbing | `\ weirds language. Then, they arrival for the nouns and I speech | _o__) nothing, for I no verbs." -- Peter Ellis | Ben Finney |
From: P. <pi...@ir...> - 2006-07-27 14:11:04
|
[martin f krafft] > Thanks for any information you might provide! [...] Is there a tool=20 > out there -- command-line only, and it has to have a batch mode --=20 > that uses one of the known and established templating engines and can=20 > then turn my tree of RST files into a website, with proper links and=20 > possibly even navigation/breadcrumbs? Let me try a bit, then! :-) Be warned in advance, however, that I'm=20 using locally developed stuff not really meant for publication. You'll=20 have to write me privately if you want more information, or a copy of my=20 little scripts (if I can get them together). You'll have to adapt them. > From now on I'd like to maintain RST files and templates in version=20 > control and delegate the tool of generating integrated websites to=20 > some smart tool. I'm using the same set of techniques for almost all of my Web sites=20 (about two dozens of them, yet some are private or local). Most original pages are reST, and are organised in a directory hierarchy=20 identical to the URL hierarchy for the equivalent rendered HTML pages. =20 Then, I have a Python script which walks down hierarchies, and a bit=20 like a Makefile would do, compares modification times between the reST=20 hierarchy and the HTML hierarchy, and uses **docutils** for processing=20 anything which recently changed. In most cases, the source and=20 destination hierarchy coincide (visitors may retrieve the reST source by=20 replacing ``.html`` by ``.txt`` in the URLs). So I can edit reST files=20 directly in the DocumentRoot hierarchy, and because I managed so these=20 hierarchies live within my own account home, I do not even have to=20 install files. But I ought to run my updating script, however. Save for my blog, I did not want to use **docutils** on the fly, because=20 some files are long and complex, they would delay page delivery enough=20 for being annoying. Moreover, the generation time would have to be=20 spoiled at each visit. For my blog, which is likely to change often,=20 I decided the other way in favour of my own ease; as blog entries are=20 all rather small, processing time should never be inordinate. And because I run it under a CherryPy server, no extra time is needed for=20 starting Python or for importing **docutils** on each request. I also have a third setup much in use. Nearly each local project, at=20 one place I work, has a ``doc/`` hierarchy holding its documentation,=20 most of it being in reST format. We use our own **setup** module, which=20 is a wrapper around the **distutils.core** one: this wrapper takes care=20 of automatically and transparently installing the whole documentation=20 hierarchy into our internal Web server, and **docutils** gets=20 automatically called at project install time, through timestamps=20 examination, for any documents needing to be recomputed. So, later=20 accesses are always fast. All in all, it's fairly convenient for us. > It seems like what I want is some form of templating engine, and there=20 > are plenty out there: Cheetah, clearsilver, etc. I use my own templating engine (not published either). Keywords are=20 French, as it is meant for French designers or programmers here. =20 Directives are kept within recognisable HTML comments, so HTML pages are=20 valid HTML even before processing. The engine itself is kept within=20 a single Python script, an not a big one. Given a page to process, it=20 does two passes: the first compiles it to some intermediate code, using=20 some moderate optimization, while the second executes that intermediate=20 code and produces the resulting HTML. The added overhead seems quite=20 negligible: we do not feel it at all, given of course that the page does=20 not require serious or hard Python computation on its own. This=20 templating language is well adapted to our needs, and because Python is=20 fully available within it, it is also quite powerful. Most pages do not use templating at all, except that the scripts or=20 tools transforming reST into HTML automatically insert some boilerplate=20 (two or three lines of directive at the beginning, one or two lines of=20 directive at the end) if they happen to see that an HTML template exists=20 for the site. The boilerplate ensures that the HTML template drives the=20 final rendition, made on the fly: most of the times in this context, the=20 HTML code resulting from **docutils** processing is mere data. The HTML=20 template uses templating directives for dynamically creating the overall=20 site aspect, and for generating menus, the contextual navigation menu,=20 and special buttons like, for example, the site-wide search facilities. It means that, once the mechanics in place, the crumbs of complexity are=20 mainly concentrated into HTML templates, usually one per site. Being=20 lazy, I often reuse the same template for many sites. Not something=20 I should be especially proud of, as it shows a bit too much! :-). --=20 Fran=E7ois Pinard http://pinard.progiciels-bpi.ca |
From: Michael F. <fuz...@vo...> - 2006-07-27 22:09:03
|
martin f krafft wrote: > I am through with CMS systems and hacking Makefiles to turn RST > stuff into plain websites! From now on I'd like to maintain RST > files and templates in version control and delegate the tool of > generating integrated websites to some smart tool. > > It seems like what I want is some form of templating engine, and > there are plenty out there: Cheetah, clearsilver, etc. > > Then there's rest2web[0], which doesn't seem to use any of these > templating engines but seems to cook its own stuff. This puts me > off. > rest2web only makes call to the templating engine (which just allows embedded Python in HTML templates and is *very* easy to use) in a couple of places. Adding support for other templating engines is 'on the todo list', but is unlikely to be done by me for a long time. OTOH I would be *very* happy to support anyone else who wants to look at it. Fuzzyman http://www.voidspace.org.uk/python/index.shtml > Thus I am turning to you with the question whether you have > suggestions as to what tool to use? Is there a tool out there -- > command-line only, and it has to have a batch mode -- that uses one > of the known and established templating engines and can then turn my > tree of RST files into a website, with proper links and possibly > even navigation/breadcrumbs? > > Thanks for any information you might provide! > > 0. http://www.voidspace.org.uk/python/rest2web/index.html > > > ------------------------------------------------------------------------ > > ------------------------------------------------------------------------- > Take Surveys. Earn Cash. Influence the Future of IT > Join SourceForge.net's Techsay panel and you'll get the chance to share your > opinions on IT & business topics through brief surveys -- and earn cash > http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV > ------------------------------------------------------------------------ > > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > |
From: Jiri B. <jb...@ho...> - 2006-07-27 22:41:29
|
Hi Ralf, I'm not sure what you're after actually. Either you want your pages completely static - then I cannot think of an example how templates may be useful, or you want your pages dynamic in which case you will need a web framework anyway (Django, Turbogears, etc.); those can handle several template format and/or you can easily plug in docutils renderer in (e.g. http://www.djangoproject.com/documentation/add_ons/ in Django). Please give us an example what you're trying to achieve. Jiri |
From: Michael F. <fuz...@vo...> - 2006-07-28 20:30:45
|
Jiri Barton wrote: > Hi Ralf, > > I'm not sure what you're after actually. Either you want your pages completely > static - then I cannot think of an example how templates may be useful, Where the page content is generated from a ReST source, and then placed into an HTML template. Sure you could do this dynamically every time the page is fetched, but as the contents don't change you could use a templating system *once* to generate static pages. Fuzzyman http://www.voidspace.org.uk/python/index.shtml > or > you want your pages dynamic in which case you will need a web framework > anyway (Django, Turbogears, etc.); those can handle several template format > and/or you can easily plug in docutils renderer in (e.g. > http://www.djangoproject.com/documentation/add_ons/ in Django). > > Please give us an example what you're trying to achieve. > > Jiri > > ------------------------------------------------------------------------- > Take Surveys. Earn Cash. Influence the Future of IT > Join SourceForge.net's Techsay panel and you'll get the chance to share your > opinions on IT & business topics through brief surveys -- and earn cash > http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > > |
From: Nicola L. <ni...@te...> - 2006-07-28 12:02:26
|
> Thus I am turning to you with the question whether you have > suggestions as to what tool to use? Is there a tool out there -- > command-line only, and it has to have a batch mode -- that uses one > of the known and established templating engines and can then turn my > tree of RST files into a website, with proper links and possibly > even navigation/breadcrumbs? For my site (see signature) I'm using a custom system based on Docutils and the outlining editor Leo ( http://leo.sourceforge.net/ ). Another interesting one, using Docutils, Nevow and Twisted, and used for the python.org site, is Pyramid: http://pyramid.pollenation.net/cgi-bin/trac.cgi -- Nicola Larosa - http://www.tekNico.net/ SOAP-based services are called "Web Services" because their proponents wish to partake of the Web's success -- yet they don't build on its core technologies, URIs and HTTP. Somehow many have equated SOAP and Web Services but HTTP has been in Service on the Web for more than a decade now and has not yet hit its prime. -- Paul Prescod, April 2002 |
From: Nicola L. <ni...@te...> - 2006-07-28 21:34:20
|
> Thus I am turning to you with the question whether you have > suggestions as to what tool to use? Is there a tool out there -- > command-line only, and it has to have a batch mode -- that uses one > of the known and established templating engines and can then turn my > tree of RST files into a website, with proper links and possibly > even navigation/breadcrumbs? What about the one used for the new python.org, Pyramid? http://pyramid.pollenation.net/cgi-bin/trac.cgi It uses Docutils, Twisted and Nevow. -- Nicola Larosa - http://www.tekNico.net/ SOAP-based services are called "Web Services" because their proponents wish to partake of the Web's success -- yet they don't build on its core technologies, URIs and HTTP. Somehow many have equated SOAP and Web Services but HTTP has been in Service on the Web for more than a decade now and has not yet hit its prime. -- Paul Prescod, April 2002 |
From: Dave K. <dke...@ya...> - 2006-07-28 03:25:11
|
martin f krafft <madduck <at> madduck.net> writes: > Then there's rest2web[0], which doesn't seem to use any of these > templating engines but seems to cook its own stuff. This puts me > off. I wouldn't give up on rest2web just yet. Aside from tempating, it seems to be the kind of thing you're looking for. I'm not a rest2web expert (I've only experimented with it a little bit) and I know even less about Cheetah, but it seems to me that since you can put raw Python code into the rest2web templates, one could get tricky and embed Cheetah templates without hacking the tool itself. Here's a snippet from a rest2web blog entry template: :: <div class="entry"> <div class="bloganchor"> <a title="Permanent link to this post" id="e<% entry.get_id() %>" name="e<% entry.get_id() %>" href="<% permalink(entry.get_id()) %>" >#<% entry.get_id() %></a> </div> <h2><% entry.title %></h2> <% entry_body %> Now, is it possible that could be written as: :: <# from Cheetah.Template import Template definition = """ <div class="entry"> <div class="bloganchor"> <a title="Permanent link to this post" id="e$entry_id" name="e$entry_id" href="$entry_link" >#$entry_id</a> </div> <h2>$entry.title</h2> $entry_body """ print Template(definition, searchList=[{'entry' : entry, 'entry_id' : entry.get_id(), 'entry_link' : permalink(entry.get_id()), 'entry_body' : entry_body}]) #> I don't have Cheetah installed so I can't try it, but it's crazy enough it just might work :) -- Dave Kessler |
From: Michael F. <fuz...@vo...> - 2006-07-29 13:03:36
|
Dave Kessler wrote: > martin f krafft <madduck <at> madduck.net> writes: > > >> Then there's rest2web[0], which doesn't seem to use any of these >> templating engines but seems to cook its own stuff. This puts me >> off. >> > > I wouldn't give up on rest2web just yet. Aside from tempating, it seems to be > the kind of thing you're looking for. I'm not a rest2web expert (I've only > experimented with it a little bit) and I know even less about Cheetah, but it > seems to me that since you can put raw Python code into the rest2web templates, > one could get tricky and embed Cheetah templates without hacking the tool itself. > > Here's a snippet from a rest2web blog entry template: > > :: > > <div class="entry"> > <div class="bloganchor"> > <a title="Permanent link to this post" id="e<% entry.get_id() %>" > name="e<% entry.get_id() %>" > href="<% permalink(entry.get_id()) %>" > >#<% entry.get_id() %></a> > </div> > <h2><% entry.title %></h2> > <% entry_body %> > > Now, is it possible that could be written as: > > :: > > <# > from Cheetah.Template import Template > > definition = """ > <div class="entry"> > <div class="bloganchor"> > <a title="Permanent link to this post" id="e$entry_id" > name="e$entry_id" > href="$entry_link" > >#$entry_id</a> > </div> > <h2>$entry.title</h2> > $entry_body > """ > > print Template(definition, > searchList=[{'entry' : entry, > 'entry_id' : entry.get_id(), > 'entry_link' : permalink(entry.get_id()), > 'entry_body' : entry_body}]) > #> > > I don't have Cheetah installed so I can't try it, but it's crazy enough it just > might work :) > Embedding cheetah templates *in* rest2web templates... that's pretty far out. :-) If anyone wanted to *help* me build a cheetah templating engine into rest2web I'd be happy to work on it. It should be very easy, but I've never used cheetah so would want someone to test it. All the best, Fuzzyman http://www.voidspace.org.uk/python/index.shtml > -- > Dave Kessler > > > > > ------------------------------------------------------------------------- > Take Surveys. Earn Cash. Influence the Future of IT > Join SourceForge.net's Techsay panel and you'll get the chance to share your > opinions on IT & business topics through brief surveys -- and earn cash > http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > > |
From: Martin B. <bl...@fu...> - 2006-08-08 03:08:47
|
On 7/26/06, martin f krafft <ma...@ma...> wrote: > I am through with CMS systems and hacking Makefiles to turn RST > stuff into plain websites! From now on I'd like to maintain RST > files and templates in version control and delegate the tool of > generating integrated websites to some smart tool. Here is a related idea that has been on my backburner for quite a while and that has a high number in the bang-for-the-buck category (little effort, very useful): implement a little buddy script to buildhtml.py that recursively processes HTML files in a filesystem hierarchy, and that inserts a breadcrumbs DIV right after the body tag. This should work with the output of buildhtml.py, but also with any valid HTML file (i.e. it does not have to be a docutils tool as such). The breadcrumbs should use the <title> tags from the html files, and directories should have simple indexes automatically created for them, using those titles. It may not look so great, but oh so how many times I needed to roll out a large set of HTML files to be viewed by friends or a client, and I did not need anything fancy, but I needed to be able to click around the set of files (breadcrumbs would have been good enough). I want no templates, no dependencies (just HTML should work) and to be able to somehow navigate to all files by just clicking. I'n not sure but I think you want a templates. (I wish I could hack this now, where has all my time gone?) cheers, |
From: Martin B. <bl...@fu...> - 2006-08-08 03:10:42
|
On 8/7/06, Martin Blais <bl...@fu...> wrote: > On 7/26/06, martin f krafft <ma...@ma...> wrote: > > I am through with CMS systems and hacking Makefiles to turn RST > > stuff into plain websites! From now on I'd like to maintain RST > > files and templates in version control and delegate the tool of > > generating integrated websites to some smart tool. > > Here is a related idea that has been on my backburner for quite a Oh and it should **just work**. Like, no options, e.g. buildhtml.py crumbit voila. To avoid the problem of selecting alternate filenames for the generated files, perhaps writing a little better version of buildhtml.py would be more reasonable. |
From: martin f k. <ma...@ma...> - 2006-08-08 09:35:44
|
also sprach Martin Blais <bl...@fu...> [2006.08.08.0408 +0100]: > hierarchy, and that inserts a breadcrumbs DIV right after the body > tag. Why after the body tag? > It may not look so great, but oh so how many times I needed to roll > out a large set of HTML files to be viewed by friends or a client, and > I did not need anything fancy, but I needed to be able to click around > the set of files (breadcrumbs would have been good enough). I want no > templates, no dependencies (just HTML should work) and to be able to > somehow navigate to all files by just clicking. I'n not sure but I > think you want a templates. Check out rest2web. It's dead simple. --=20 martin; (greetings from the heart of the sun.) \____ echo mailto: !#^."<*>"|tr "<*> mailto:" net@madduck =20 spamtraps: mad...@ma... =20 "courage is not the absence of fear, but the decision that something else is more important than fear." -- ambrose redmoon |
From: Martin B. <bl...@fu...> - 2006-08-11 00:40:31
|
On 8/8/06, martin f krafft <ma...@ma...> wrote: > also sprach Martin Blais <bl...@fu...> [2006.08.08.0408 +0100]: > > hierarchy, and that inserts a breadcrumbs DIV right after the body > > tag. > > Why after the body tag? Because it's simple. Simple is good. I love simple. No templates, no b.s. Often, simple is not pretty, but it works, and that has a lot more value than eye candy IMO. So a simple insertion of text right after the body tag in a div should do a mighty fine job. That's just a suggestion though, you could do something more complicated, but IMO it won't help much. > > It may not look so great, but oh so how many times I needed to roll > > out a large set of HTML files to be viewed by friends or a client, and > > I did not need anything fancy, but I needed to be able to click around > > the set of files (breadcrumbs would have been good enough). I want no > > templates, no dependencies (just HTML should work) and to be able to > > somehow navigate to all files by just clicking. I'n not sure but I > > think you want a templates. > > Check out rest2web. It's dead simple. I want to do this: cd <dir> rest2web # go in firefox and browse results. It has to work on all HTML pages. I certainly don't want to learn about the tool any more than its name to invoke it, and most of all not have to read configuration documentation in web pages (engineers don't read documentation anyway ;-) ). I'll try this with rest2web. |
From: Michael F. <fuz...@vo...> - 2006-08-11 13:46:32
|
Martin Blais wrote: > On 8/8/06, martin f krafft <ma...@ma...> wrote: > >> also sprach Martin Blais <bl...@fu...> [2006.08.08.0408 +0100]: >> >>> hierarchy, and that inserts a breadcrumbs DIV right after the body >>> tag. >>> >> Why after the body tag? >> > > Because it's simple. > Simple is good. > I love simple. > No templates, no b.s. > > Often, simple is not pretty, but it works, and that has a lot more > value than eye candy IMO. So a simple insertion of text right after > the body tag in a div should do a mighty fine job. That's just a > suggestion though, you could do something more complicated, but IMO it > won't help much. > > > > >>> It may not look so great, but oh so how many times I needed to roll >>> out a large set of HTML files to be viewed by friends or a client, and >>> I did not need anything fancy, but I needed to be able to click around >>> the set of files (breadcrumbs would have been good enough). I want no >>> templates, no dependencies (just HTML should work) and to be able to >>> somehow navigate to all files by just clicking. I'n not sure but I >>> think you want a templates. >>> >> Check out rest2web. It's dead simple. >> > > I want to do this: > > cd <dir> > rest2web > # go in firefox and browse results. > > It has to work on all HTML pages. I certainly don't want to learn > about the tool any more than its name to invoke it, and most of all > not have to read configuration documentation in web pages (engineers > don't read documentation anyway ;-) ). > > I'll try this with rest2web. > The only things you'll need to know are : r2w.py -f Which is force mode. You may also not like the default template used in force mode. Replace 'rest2web/defaults/template.txt' with something that looks like : <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=<% final_encoding %>" /> <link rel="stylesheet" href="stylesheets/docutils.css" type="text/css" /> <title><% title %> </head> <body> <% body %> <div name="breadcrumbs"> <# print_crumbs(breadcrumbs) #> </div> </body> </body> </html> All the best, Fuzzyman http://www.voidspace.org.uk/python/rest2web/ > ------------------------------------------------------------------------- > 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 > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > > |
From: Fuzzyman <fuz...@vo...> - 2006-08-08 09:40:28
|
Martin Blais wrote: >On 7/26/06, martin f krafft <ma...@ma...> wrote: > > >>I am through with CMS systems and hacking Makefiles to turn RST >>stuff into plain websites! From now on I'd like to maintain RST >>files and templates in version control and delegate the tool of >>generating integrated websites to some smart tool. >> >> > >Here is a related idea that has been on my backburner for quite a >while and that has a high number in the bang-for-the-buck category >(little effort, very useful): implement a little buddy script to >buildhtml.py that recursively processes HTML files in a filesystem >hierarchy, and that inserts a breadcrumbs DIV right after the body >tag. This should work with the output of buildhtml.py, but also with >any valid HTML file (i.e. it does not have to be a docutils tool as >such). The breadcrumbs should use the <title> tags from the html >files, and directories should have simple indexes automatically >created for them, using those titles. > >It may not look so great, but oh so how many times I needed to roll >out a large set of HTML files to be viewed by friends or a client, and >I did not need anything fancy, but I needed to be able to click around >the set of files (breadcrumbs would have been good enough). I want no >templates, no dependencies (just HTML should work) and to be able to >somehow navigate to all files by just clicking. I'n not sure but I >think you want a templates. > >(I wish I could hack this now, where has all my time gone?) >cheers, > > *Well*, the new rest2web force mode can generate directories of HTML documents from ReST source documents with no metadata. It can include breadcrumbs in the generated pages and will generate a simple index page for each directory. Subdirectories will be linked to from the index page. At the moment the standard template for force mode is 'less-minimal' than it should be, so the generated output may not be to everyone's taste (the template is based on the new rest2web site: http://www.voidspace.org.uk/python/rest2web ). I can easily provide a more basic template to be used instead. The question is, how do you want breadcrumbs to work. The standard way is for breadcrumbs to be based on the directory hierarchy - clicking on the previous breadcrumb will take you to the index page up a directory. If you want breadcrumbs to have a 'trail' within a single directory, rest2web has to have *some* way of knowing the order. If this is interesting to you, I can adapt the template to make it more useful and provide a 'breadcrumb algorithm' which meets your needs. Fuzzyman http://www.voidspace.org.uk/python/index.shtml >------------------------------------------------------------------------- >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 >_______________________________________________ >Docutils-users mailing list >Doc...@li... >https://lists.sourceforge.net/lists/listinfo/docutils-users > >Please use "Reply All" to reply to the list. > > > |
From: Michael F. <fuz...@vo...> - 2006-08-11 14:09:03
|
Michael Foord wrote: > Martin Blais wrote: > >> On 8/8/06, martin f krafft <ma...@ma...> wrote: >> >> >>> also sprach Martin Blais <bl...@fu...> [2006.08.08.0408 +0100]: >>> >>> >>>> hierarchy, and that inserts a breadcrumbs DIV right after the body >>>> tag. >>>> >>>> >>> Why after the body tag? >>> >>> >> Because it's simple. >> Simple is good. >> I love simple. >> No templates, no b.s. >> >> Often, simple is not pretty, but it works, and that has a lot more >> value than eye candy IMO. So a simple insertion of text right after >> the body tag in a div should do a mighty fine job. That's just a >> suggestion though, you could do something more complicated, but IMO it >> won't help much. >> >> >> >> >> >>>> It may not look so great, but oh so how many times I needed to roll >>>> out a large set of HTML files to be viewed by friends or a client, and >>>> I did not need anything fancy, but I needed to be able to click around >>>> the set of files (breadcrumbs would have been good enough). I want no >>>> templates, no dependencies (just HTML should work) and to be able to >>>> somehow navigate to all files by just clicking. I'n not sure but I >>>> think you want a templates. >>>> >>>> >>> Check out rest2web. It's dead simple. >>> >>> >> I want to do this: >> >> cd <dir> >> rest2web >> # go in firefox and browse results. >> >> It has to work on all HTML pages. I certainly don't want to learn >> about the tool any more than its name to invoke it, and most of all >> not have to read configuration documentation in web pages (engineers >> don't read documentation anyway ;-) ). >> >> I'll try this with rest2web. >> >> > > The only things you'll need to know are : > > r2w.py -f > > Oh... rest2web needs to know your source directory and where you want the html files putting. You'll need to create a copy of r2w.ini (can be in the current directory when you run r2w.py). Put the appropriate values in 'start_directory' and 'target_directory'. All the best, Fuzzyman http://www.voidspace.org.uk/python/index.shtml |
From: martin f k. <ma...@ma...> - 2006-08-11 14:13:04
|
also sprach Michael Foord <fuz...@vo...> [2006.08.11.1503 +010= 0]: > Oh... rest2web needs to know your source directory and where you want=20 > the html files putting. You'll need to create a copy of r2w.ini (can be= =20 > in the current directory when you run r2w.py). >=20 > Put the appropriate values in 'start_directory' and 'target_directory'. Why not assume . and . for the two, unless specified? --=20 martin; (greetings from the heart of the sun.) \____ echo mailto: !#^."<*>"|tr "<*> mailto:" net@madduck =20 spamtraps: mad...@ma... =20 if god had meant for us to be naked, we would have been born that way. |
From: Michael F. <fuz...@vo...> - 2006-08-11 16:35:28
|
martin f krafft wrote: > also sprach Michael Foord <fuz...@vo...> [2006.08.11.1503 +0100]: > >> Oh... rest2web needs to know your source directory and where you want >> the html files putting. You'll need to create a copy of r2w.ini (can be >> in the current directory when you run r2w.py). >> >> Put the appropriate values in 'start_directory' and 'target_directory'. >> > > Why not assume . and . for the two, unless specified? > Because the force mode is new, so it hasn't made sense not to have a config file up until now. :-) I guess if force mode is on, and there is no config file, that is a sensible thing to do. What about putting the html into a subdirectory called 'html', or would you rather just mix them with the source files (use '.') ? Fuzzyman http://www.voidspace.org.uk/python/rest2web/ |
From: Martin B. <bl...@fu...> - 2006-08-11 16:49:31
|
On 8/11/06, Michael Foord <fuz...@vo...> wrote: > martin f krafft wrote: > > also sprach Michael Foord <fuz...@vo...> [2006.08.11.1503 +0100]: > > > >> Oh... rest2web needs to know your source directory and where you want > >> the html files putting. You'll need to create a copy of r2w.ini (can be > >> in the current directory when you run r2w.py). > >> > >> Put the appropriate values in 'start_directory' and 'target_directory'. > >> > > > > Why not assume . and . for the two, unless specified? > > > > Because the force mode is new, so it hasn't made sense not to have a > config file up until now. :-) > > I guess if force mode is on, and there is no config file, that is a > sensible thing to do. What about putting the html into a subdirectory > called 'html', or would you rather just mix them with the source files > (use '.') ? I have had the very, very same issue with curator (http://furius.ca/curator/). This is exactly what curator does: by default, mix with the source files, and with an option create an html at the root that contains a replica of the hierarchy. The problem with using this option is that all linked files and/or images have to be either linked or copied. OTOH the problem with mixing the output with the source files is that the resulting source directories are quite messy. That's why I conclude that the best compromise is to just improve buildhtml.py to make it able to generate breadcrumbs, i.e. it generates both the breadcrumbs and the HTML files at the same time. This will make 90% of the people happy with a good-enough solution. The drawback is that this will not support HTML files that are not generated from rest files. cheers, |
From: Michael F. <fuz...@vo...> - 2006-08-11 17:39:48
|
Martin Blais wrote: > On 8/11/06, Michael Foord <fuz...@vo...> wrote: >> martin f krafft wrote: >> > also sprach Michael Foord <fuz...@vo...> >> [2006.08.11.1503 +0100]: >> > >> >> Oh... rest2web needs to know your source directory and where you want >> >> the html files putting. You'll need to create a copy of r2w.ini >> (can be >> >> in the current directory when you run r2w.py). >> >> >> >> Put the appropriate values in 'start_directory' and >> 'target_directory'. >> >> >> > >> > Why not assume . and . for the two, unless specified? >> > >> >> Because the force mode is new, so it hasn't made sense not to have a >> config file up until now. :-) >> >> I guess if force mode is on, and there is no config file, that is a >> sensible thing to do. What about putting the html into a subdirectory >> called 'html', or would you rather just mix them with the source files >> (use '.') ? > > I have had the very, very same issue with curator > (http://furius.ca/curator/). > This is exactly what curator does: by default, mix with the source > files, and with an option create an html at the root that contains a > replica of the hierarchy. > > The problem with using this option is that all linked files and/or > images have to be either linked or copied. OTOH the problem with > mixing the output with the source files is that the resulting source > directories are quite messy. > > That's why I conclude that the best compromise is to just improve > buildhtml.py to make it able to generate breadcrumbs, i.e. it > generates both the breadcrumbs and the HTML files at the same time. > This will make 90% of the people happy with a good-enough solution. > The drawback is that this will not support HTML files that are not > generated from rest files. Of course rest2web allows you to store your content in html files, and you can always use the restindex 'file' command to copy files into your output directory. :-) But then I've never found it a problem - I store my images and CSS in the html directory rather than mixing them with the document source files in the first place... All the best, Fuzzyman http://www.voidspace.org.uk/python/index.shtml > > cheers, > |