Mailing List Archive: 49091 messages
  • Home
  • Script library
  • AltME Archive
  • Mailing list
  • Articles Index
  • Site search
 

ANN: make-doc-pro

 [1/6] from: robert:muench:robertmuench at: 4-Aug-2001 12:46


Hi, I have done some improvements to make-doc.r from RT as I'm using it a lot in my daily work. I hope RT doesn't mind. Here is what I have done so far: Changes: - Doesn't need empty line between tags anymore - Comments can have spaces between ; and the comment - Definitions use a flexible table layout, good for long definition words - Definitions only use word wrap in the definition text not the definition word - Support for non-english languages added (use =options "DE" "US" etc.) - Support for FAQ style definitions (two definitions are clustred into a framed table - Added support for images - Use Style sheet syntax for indention - Generates more compact HTML code - Generates more standard conforming HTML code by emitting all closing tags - More comment inserted, so it might be a good place for learning Rebol Next steps: - Add support for tables - Add support for variables which can hold text-blocks - Add support for "footnotes" which will pop up as yellow-styled flags (IE only) - Add support for PDF output Please have a look at it and tell me your comments. I'm going to improve it over time with new requested features. The attachement contains the rebol script, a test.txt file where you can see how to use it, a sampel graphic and a generated HTML file so you can see the new look. Robert -- Binary/unsupported file stripped by Listar -- -- Type: application/x-zip-compressed -- File: make-doc-pro.zip

 [2/6] from: louisaturk:eudoramail at: 4-Aug-2001 11:31


Robert, Hi. I would like to look at your work. However, your files were stripped out by Listar. Would you mind sending them directly to my email address? Thanks, Louis At 12:46 PM 8/4/2001 +0200, you wrote:

 [3/6] from: coussement:c:js:mil:be at: 26-Oct-2001 13:10


Robert, As you may recall, I use your script extensively for project documentation generation :-) I added following functional changes: - _new_ special section: when there are several versions of the same document, it's usefull to the reader if he can identify the last changes. This section add a vertical line to the right of the text between the tags. - a new look for the header: just a border filled with color. Just mention if you're interested by those changes, and I'll mail them to you. @+ christophe==

 [4/6] from: robert:muench:robertmuench at: 27-Oct-2001 13:00


> -----Original Message----- > From: [rebol-bounce--rebol--com] [mailto:[rebol-bounce--rebol--com]]On Behalf Of
<<quoted lines omitted: 4>>
> As you may recall, I use your script extensively for project documentation > generation :-)
Hi, yes I do and it's great that you can get value from it :-))
> - _new_ special section: when there are several versions of the same > document, it's usefull to the reader if he can identify the last changes. > This section add a vertical line to the right of the text between the tags.
Great! I'm thinking about how to handle different versions of a document in a pragmatic manner, so that people not sensitive with version-control can use it. Is it possible to add a date to the vertical bar? I'm not sure if browsers (I expect only IE to support it at all) are able to rotate text 90 degrees... but hey we can use a special view code section to create a graphic and put it to the right of the bar...
> - a new look for the header: just a border filled with color.
Yeah, it really isn't very stylish :-| I think I might create a new header layout...
> Just mention if you're interested by those changes, and I'll mail them to > you.
Yes please! I'm going to add it to the main code line. Robert

 [5/6] from: greggirwin:mindspring at: 27-Oct-2001 11:09


Hi Robert, << I'm thinking about how to handle different versions of a document in a pragmatic manner, so that people not sensitive with version-control can use it. >> I've always liked transparent tools. From a single document standpoint, which could be edited in any ASCII editor, your options are somewhat limited. If they don't have a dialect to use for revision markups (which is not a very transparent way to work unfortunately), you're out of luck. If, however, you provide an editor then you have the option of maintaining diff/delta files. With all these document related things we're discussing, there's a line between structured and unstructured documents and how that affects what we can do with the data and how easy it is for the user to create. I only wish I had some good answers. :) --Gregg

 [6/6] from: robert:muench:robertmuench at: 28-Oct-2001 9:59


> -----Original Message----- > From: [rebol-bounce--rebol--com] [mailto:[rebol-bounce--rebol--com]]On Behalf Of
<<quoted lines omitted: 5>>
> which could be edited in any ASCII editor, your options are somewhat > limited.
Hi, that's the problem but hey, nothing is impossible ;-)).
> If they don't have a dialect to use for revision markups (which is > not a very transparent way to work unfortunately), you're out of luck.
Yep, the solution must be mostly transparent to use for the user. Only a switch to turn version marking on/off should be needed.
> If, however, you provide an editor then you have the option of maintaining > diff/delta files.
Hmm... I never liked tools, which forced me to use its environment. I'm like tools, which do a special job and can be integrated in my working process.
> With all these document related things we're discussing, > there's a line between structured and unstructured documents and how that > affects what we can do with the data and how easy it is for the user to > create. I only wish I had some good answers. :)
My idea at the moment is something like this (only sketch/brainstorming yet): 1. make-doc-pro saves the older versions with continuing numbers. No diff files, may be compressed. 2. You can turn version-markup on like: =options diffs base-version diff-version 3. The diffs are marked in the text. 4. Maybe it's possible to use some browser features and work with javascript to create something like a diff-version-presenter mode. You can move the mouse of a paragraph with changes and a pop-up window will show you what has changed. Just some ideas... Robert

Notes
  • Quoted lines have been omitted from some messages.
    View the message alone to see the lines that have been omitted