Proposal: REBOL Documentation indexing system for newbies
[1/8] from: gerardcote:sympatico:ca at: 3-Feb-2004 0:29
Hello Rebolers,
I finally thought of some structure to help index all the REBOL related Documentation
available, be it to any existing format from
paper to various electronic ones (HTML, XML, PDF, FLASH, script).
And this includes the many sources too : Existing and to come paper and electronic books,
tutorials and scripts, mailing list
archives, past and current articles and discussions held into Forums, chats, wikis, vanilla,
AltMe and IOS sites, and every other we
could think of.
I don't pretend to index all individual pieces but instead the many active and latent
sources where REBOL is discussed in some way -
trying to classify the many contributions by attributing them keywords and enabling some
full text search over these keywords. Like
is currently done for ML archives and scripts contained into the Official Library. But
I will need some help for deciding the many
categories to be finally used since they could also be used for the Library and any other
REBOL related similar work. I tried at
some of them in the enclosed documents but the list is neither definitive or exhaustive.
It's work in progress.
Try to think of it at it as being a cross indexing tool for the many following POVs that
our community members share :
As a newcomer that has questions to ask related to those general aspects : Where can
I find help about something, Where to start,
Where to get, What can be done with, How to download, install, configure, What if, How-to
applied to each phase of the software
development cycle (individual language construct learning oriented, task based oriented,
problem-solving oriented, debug or test
oriented, doc oreinted) and the most hard to answer Why does REBOL do that this way or
How is REBOL doing this (can even relate to
the internal mechanisms or structure of REBOL or some Dialect like Draw, VID and View
- and many of them are missing or must be
found the hard way by studying at the REBOL sources which already implies some advanced
knowledge of the language constructs).
As a more advanced programmer that has to develop some quality code to be shared with
other community members or even external
programmers when contracting, put code into some library, test it and ensure it to be
reusable. Use all the toolkit the pros use :
compression/decompression, encode/decode, loader, distributed programming and the like.
May be some models are no more necessary
when programmers arrived at this level come from another programming environment/language
where they have already learned to use all
these tools but some demo is nevertheless needed for others that didn't follow these
usual tracks so they can't get any help from
other sources than the REBOL World itself since they don't know any other language or
existing tool and often don't even know the
techniques that go hand in hand with these.
As a teacher who wants to put together most of these questions and try to answer them
with his own limited knowledge of the REBOL
language with its internals and his own limitation as a programmer so he must also refer
to some documented (or live as here)
knowledge somewhere to put some script to work and help newcomers and intermediate programmers
too.
But this fact must also reflect into the indexing and documentation I plan to produce.
Here is the first try I did to put together a global indexing system for all the doc
about REBOL that a newbie can find anywhere -
to be referred to a new source must be known to me and must acknowledge its content to
be shared by others too.
Enclosed are 2 files of my first general index for review and comment. The first is the
.txt that was used by make-doc-pro to
produce the other HTML output.
Except if you don't think it's a good idea or don't like the complete proposed structure
of the document - in the case which you can
suggest another one, I'd like to receive annotations about individual sections only.
Don't send back the complete .txt document
since it would be too long for me to locate the part of the text which was modified by
the submitter.
After compiling all the data received - if any - I will send the revised document. It
is possible that I go to the codeur.org forum
to submit it there for review and discussion too since Didec and Jason offered me to
help. However I wanted everybody to know what
was our work basis. Feel free to suggest any add-on to any current section. We'll take
every submission into account and we'll see
if each one can be kept or not. We'll advise and explain any submitter when his submission
can't be taken into account.
Regards,
Gerard
-- HTML Attachment decoded to text by Ecartis --
-- File: REBOL-Doc-Structure.html
@media screen { h1,h2,h3,h4,h5,p,a,br,li,td, .underline
{font-family:Arial;text-align:justify} hr {text-align:center} p,table
{margin-left: 10px;margin-right:10px} .defword {white-space:nowrap}
..deftable{border-style:none;vertical-align:top} .deftablefaq
{border-style:solid;border-width:thin} .end {font-size:8pt} .example
{margin-left:50px;margin-right:50px;border:2px solid;padding:
10px;background-color:#EEEEEE} .header
{margin-left:50px;margin-right:50px;border:2px solid;padding:
10px;background-color:yellow} .indented {margin-left: 50px} .litable
{text-align:left} .new {border-right: 10px solid; padding-right: 10px;
font-family:Arial} .note {margin-left:50px;margin-right:50px;border:2px
solid;padding: 10px;background-color:#FFCCCC} .tocindent {margin-left: 20px}
..top {font-size:8pt;text-align:right} .underline {text-decoration:underline}
} @media print { h1,h2,h3,h4,h5,p,a,br,li, #underline
{font-family:Arial;text-align:justify;orphans:5;widows:5} p,li,td
{font-size:10pt} ul,ol {page-break-after:avoid;orphans:5;widows:5} }Plan for
a suggested REBOL Documentation Structure
Plan for a suggested REBOL Documentation Structure(Note: Much work is left
tobe done for but this is a first try - Comments are welcome! Any omission
isentirely my fault and please help to complete if this project seems to be
useful to most of the REBOL community members to help any newcomer to better
find his way through the vast REBOL related material pool.
* The black bullets indicate work in progress that I planned to
personally contribute to.
* The white bullets are related to completed work that needs to be
indexed somewhere to be easily found and usable by any newcomer.
----------------------------------------------------------------------------
Contents1. Getting started[1]
1.1 Where to search for Help about REBOL[2]
1.2 A Brief Tour of REBOL family[3]
1.3 Teach Yourself REBOL in a fixed number of Days[4]
2. The REBOL Language[5]
2.1 REBOL Language Manuals and published Books[6]
2.2 Beginning Student subset Language (Should complete the actual
dictionary)[7]
2.3 Intermediate Student subset Language (Idem above)[8]
2.4 Advanced Student Language (Idem above)[9]
3. Learning REBOL[10]
3.1 How to Design Programs in REBOL - Teaching Modules[11]
3.2 Insider's view of REBOL[12]
4. Tools to support developers[13]
4.1 Tools Categories (to be refined)[14]
4.1.1 File and database management[15]
4.1.2 Debug support[16]
4.1.3 Library management[17]
4.1.4 Distributed programming[18]
4.1.5 Gui Management or Enhancement[19]
4.1.6 Graphics toolkit[20]
4.1.7 HTML - XHTML - XML - XML-RPC support[21]
4.1.8 Document Creation and Publishing support for multiple formats (HTML,
PDF, FLASH)[22]
4.1.9 Learning aids creation tools[23]
4.1.10 Dialects (created to help programmers and users alike)[24]
5. Libraries[25]
5.1 Official REBOL script Library Manual[26]
5.2 Miscellaneous Libraries: Reference Manuals[27]
6. Unofficial but Useful Documentation[28]
6.1 REBOL Hosting available[29]
6.2 Articles and discussions from the Official Mailing List (ML)[30]
6.3 Forums List (non exhaustive)[31]
6.4 Other REBOL related resources indexes[32]
7. Shared REBOL apps - by categories (Many are missing)[33]
7.1 Documents Publishing Tools[34]
7.2 Idea Sharing and organizing tools[35]
7.3 Other apps spreaded that must be indexed and classified[36]
1. Getting started1.1 Where to search for Help about REBOL
* Some hints to guide the newcomer to the REBOL world and its vast
documentation
1.2 A Brief Tour of REBOL family
* Comparative presentation of each family member and reasons to select
it(See REBOL site)
* The "Ten steps" proposed by Carl on the OFFICIAL REBOL site
http://www.rebol.com
1.3 Teach Yourself REBOL in a fixed number of Days
* This could be the Tutorial I'm working on now (in Easy-vid format)
Content yet to be refined before submission but will promote a REBOL based
problem solving approach Will present many small tasks to be done using
REBOLas a programming tool Will also emphasize some classical methodology
forstructured analysis, design (algorithms), coding, testing and debugging
techniques using REBOL's own tools and style guide. Some help in the form of
knowledge coming from the unified REBOL community members will be requested,
welcomed and sometimes necessary for me to complete this project...[ back to
top[37] ]
----------------------------------------------------------------------------
2. The REBOL Language2.1 REBOL Language Manuals and published Books
* Refer to the many manuals for - Core, View &PRO, IOS, Command , SDK -
See the official REBOL site http://www.rebol.com (Core User manual, Language
Dictionary, etc...)
* The published books available to help starters and advanced
programmerstoo!
2.2 Beginning Student subset Language (Should complete the actual
dictionary)
* A Illustrated minimalist list of REBOL words
2.3 Intermediate Student subset Language (Idem above)
* An Illustrated enriched list of REBOL words
2.4 Advanced Student Language (Idem above)
* An Illustrated more elaborate list of REBOL words
[ back to top[38] ]
----------------------------------------------------------------------------
3. Learning REBOL3.1 How to Design Programs in REBOL -
Teaching Modules
* Guidelines to help newcomers to programming develop their scripts
* Usage-vid script by Cybarite for /View programming
* Various tutorials about Parse and the many Dialects created by
community members
3.2 Insider's view of REBOL
* Here could be concentrated many articles from REBOL Zine and
* from other contributors as to how REBOL do some of its inside work
[ back to top[39] ]
----------------------------------------------------------------------------
4. Tools to support developers4.1 Tools Categories (to be
refined)4.1.1 File and database management
* File Manager (Gabriele Santilli)
* Other File Managers (See REBOL.ORG Library)
* ODBC socket server (REBOLFRANCE)
* MySQL Protocol (DocKimbel)
* DyBase Oriented Object Database (Konstantin Knizhnik)
* RebDB - Pseudo-Relational Database (Ashley Trüter)
* Flat Database (See REBOL.ORG Library and The Official Book)
Other entries to be put here4.1.2 Debug support
* Anamonitor (Romano Paolo Tenca)
Other tools to be added here4.1.3 Library management
* Slim (Maxim Olivier-Adlhoch)
* Many Loaders
Other stuff to be added here4.1.4 Distributed programming
* Rugby (Marteen Koopmans)
* eREBOL (ASP and JSP like)
Other entries to be put here4.1.5 Gui Management or Enhancement
* Glass Library (Maxim Olivier-Adlhoch)
4.1.6 Graphics toolkit
* Draw Dialect (Cyphre)
Many other contributions to be added here4.1.7 HTML - XHTML - XML - XML-RPC
support
* ML (Andrew J. MArtin)
* Names of the many other scripts contributed and their authors
4.1.8 Document Creation and Publishing support for multiple formats (HTML,
PDF, FLASH)
* Make-doc (Carl Sassenrath)
* Make-doc-pro (Robert Muench)
* Flash dialect (Oldes)
* Easy-VID (Carl Sassenrath)
4.1.9 Learning aids creation tools
* Make-doc-pro (Robert Muench)
* vid-usage (Cybarite)
* easy-vid (CArl Sassenrath)
* Vanilla (Christian Langreiter &al)
Others to be added here4.1.10 Dialects (created to help programmers and
usersalike)
* ML (Andrew J. Martin)
Others to be added here[ back to top[40] ]
----------------------------------------------------------------------------
5. Libraries5.1 Official REBOL
script Library Manual
* Doc already available from REBOL.org for the Librarian and the Library
Data Services
* Analysis of some selected scripts
* Additional DOC to be added for selected scripts: Usage, GOAL
description, High Level Design and sample data for testing
* May be we can expect some additional scripts sharing from the many
individual REB sites
5.2 Miscellaneous Libraries: Reference Manuals
* Slim (Maxim Olivier-Adlhoch)
* Other librarians available - ?
* Glass (Maxim Olivier-Adlhoch)
* High Level functions (Ladislav Mecir)
Others to be shared and added here[ back to top[41] ]
----------------------------------------------------------------------------
6. Unofficial but
UsefulDocumentation6.1 REBOL Hosting available
* Gabriele's Hosting company
Others to be added here6.2 Articles and discussions from the Official
MailingList (ML)
* ML archives contents for consulting and searching
* REBOL Zine
* REBOLForces
* Codeconscious web site
* Compkarori web site
* Individual contributors articles : Ladislav, Marteen, Jeff, Gregg,
Chris and others...
Others to be added here6.3 Forums List (non exhaustive)
* REBOLFRANCE - codeur.org
* REBOLTALK
Others to be added here6.4 Other REBOL related resources indexes
* DMOZ (the Open Directory Project)
* REBOLFRANCE
Others to be added here[ back to top[42] ]
----------------------------------------------------------------------------
7. Shared REBOL apps - by
categories (Many are missing)7.1 Documents Publishing Tools
* make-doc-pro
* make-doc
* Online make-doc anywhere (by Christopher Ross-Gill)
Others to be added here7.2 Idea Sharing and organizing tools
* Vanilla
* REBOL Wikis
Others to be added here7.3 Other apps spreaded that must be indexed and
classified
* Graphical Toolkits
* REBOL Application Framework (RFM)
Others to be added here[ back to top[43] ]
----------------------------------------------------------------------------
Document formatter copyright Robert M. M=FCnch[44]. All Rights Reserved.
XHTML 1.0 Transitional formatted with Make-Doc-Pro Version:1.0.8 on
2-Feb-2004 at 23:26:30
--- Links ---
1 #sect1
2 #sect1.1
3 #sect1.2
4 #sect1.3
5 #sect2
6 #sect2.1
7 #sect2.2
8 #sect2.3
9 #sect2.4
10 #sect3
11 #sect3.1
12 #sect3.2
13 #sect4
14 #sect4.1
15 #sect4.1.1
16 #sect4.1.2
17 #sect4.1.3
18 #sect4.1.4
19 #sect4.1.5
20 #sect4.1.6
21 #sect4.1.7
22 #sect4.1.8
23 #sect4.1.9
24 #sect4.1.10
25 #sect5
26 #sect5.1
27 #sect5.2
28 #sect6
29 #sect6.1
30 #sect6.2
31 #sect6.3
32 #sect6.4
33 #sect7
34 #sect7.1
35 #sect7.2
36 #sect7.3
37 #top
38 #top
39 #top
40 #top
41 #top
42 #top
43 #top
44 http://www.robertmuench.de
-- Attached file included as plaintext by Ecartis --
-- File: REBOL-Doc-Structure.txt
Plan for a suggested REBOL Documentation Structure
(Note: Much work is left to be done for but this is a first try - Comments are welcome!
Any omission is entirely my fault and please help to complete if this project seems to
be useful
to most of the REBOL community members to help any newcomer to better find his way through
the
vast REBOL related material pool.
**The black bullets indicate work in progress that I planned to personally contribute
to.
**The white bullets are related to completed work that needs to be indexed somewhere
to be easily found and usable by any newcomer.
=toc
===Getting started
---Where to search for Help about REBOL
** Some hints to guide the newcomer to the REBOL world and its vast documentation
---A Brief Tour of REBOL family
**Comparative presentation of each family member and reasons to select it (See REBOL
site)
**The "Ten steps" proposed by Carl on the OFFICIAL REBOL site http://www.rebol.com
---Teach Yourself REBOL in a fixed number of Days
* This could be the Tutorial I'm working on now (in Easy-vid format)
Content yet to be refined before submission but will promote a REBOL based problem solving
approach
Will present many small tasks to be done using REBOL as a programming tool
Will also emphasize some classical methodology for structured analysis, design (algorithms),
coding, testing and debugging techniques using REBOL's own tools and style guide.
Some help in the form of knowledge coming from the unified REBOL community members will
be requested,
welcomed and sometimes necessary for me to complete this project...
===The REBOL Language
---REBOL Language Manuals and published Books
**Refer to the many manuals for - Core, View & PRO, IOS, Command , SDK -
See the official REBOL site http://www.rebol.com
(Core User manual, Language Dictionary, etc...)
**The published books available to help starters and advanced programmers too!
---Beginning Student subset Language (Should complete the actual dictionary)
* A Illustrated minimalist list of REBOL words
---Intermediate Student subset Language (Idem above)
* An Illustrated enriched list of REBOL words
---Advanced Student Language (Idem above)
* An Illustrated more elaborate list of REBOL words
===Learning REBOL
---How to Design Programs in REBOL - Teaching Modules
* Guidelines to help newcomers to programming develop their scripts
**Usage-vid script by Cybarite for /View programming
**Various tutorials about Parse and the many Dialects created by community members
---Insider's view of REBOL
**Here could be concentrated many articles from REBOL Zine and
**from other contributors as to how REBOL do some of its inside work
===Tools to support developers
---Tools Categories (to be refined)
+++File and database management
**File Manager (Gabriele Santilli)
**Other File Managers (See REBOL.ORG Library)
**ODBC socket server (REBOLFRANCE)
**MySQL Protocol (DocKimbel)
**DyBase Oriented Object Database (Konstantin Knizhnik)
**RebDB - Pseudo-Relational Database (Ashley Tr=FCter)
**Flat Database (See REBOL.ORG Library and The Official Book)
Other entries to be put here
+++Debug support
**Anamonitor (Romano Paolo Tenca)
Other tools to be added here
+++Library management
**Slim (Maxim Olivier-Adlhoch)
**Many Loaders
Other stuff to be added here
+++Distributed programming
**Rugby (Marteen Koopmans)
**eREBOL (ASP and JSP like)
Other entries to be put here
+++Gui Management or Enhancement
**Glass Library (Maxim Olivier-Adlhoch)
+++Graphics toolkit
**Draw Dialect (Cyphre)
Many other contributions to be added here
+++HTML - XHTML - XML - XML-RPC support
**ML (Andrew J. MArtin)
**Names of the many other scripts contributed and their authors
+++Document Creation and Publishing support for multiple formats (HTML, PDF, FLASH)
**Make-doc (Carl Sassenrath)
**Make-doc-pro (Robert Muench)
**Flash dialect (Oldes)
**Easy-VID (Carl Sassenrath)
+++Learning aids creation tools
**Make-doc-pro (Robert Muench)
**vid-usage (Cybarite)
**easy-vid (CArl Sassenrath)
**Vanilla (Christian Langreiter & al)
Others to be added here
+++Dialects (created to help programmers and users alike)
**ML (Andrew J. Martin)
Others to be added here
===Libraries
---Official REBOL script Library Manual
**Doc already available from REBOL.org for the Librarian and the Library Data Services
* Analysis of some selected scripts
* Additional DOC to be added for selected scripts: Usage, GOAL description, High Level
Design and sample data for testing
**May be we can expect some additional scripts sharing from the many individual REB sites
---Miscellaneous Libraries: Reference Manuals
**Slim (Maxim Olivier-Adlhoch)
**Other librarians available - ?
**Glass (Maxim Olivier-Adlhoch)
**High Level functions (Ladislav Mecir)
Others to be shared and added here
===Unofficial but Useful Documentation
---REBOL Hosting available
**Gabriele's Hosting company
Others to be added here
---Articles and discussions from the Official Mailing List (ML)
**ML archives contents for consulting and searching
**REBOL Zine
**REBOLForces
**Codeconscious web site
**Compkarori web site
**Individual contributors articles : Ladislav, Marteen, Jeff, Gregg, Chris and others...
Others to be added here
---Forums List (non exhaustive)
**REBOLFRANCE - codeur.org
**REBOLTALK
Others to be added here
---Other REBOL related resources indexes
**DMOZ (the Open Directory Project)
**REBOLFRANCE
Others to be added here
===Shared REBOL apps - by categories (Many are missing)
---Documents Publishing Tools
**make-doc-pro
**make-doc
**Online make-doc anywhere (by Christopher Ross-Gill)
Others to be added here
---Idea Sharing and organizing tools
**Vanilla
**REBOL Wikis
Others to be added here
---Other apps spreaded that must be indexed and classified
**Graphical Toolkits
**REBOL Application Framework (RFM)
Others to be added here
[2/8] from: greggirwin:mindspring at: 3-Feb-2004 10:30
Hi Gerard,
Thanks for all the effort you're putting into this. I hope to have
time...before too long, to contribute to this project as well, from
the REBOL.org side.
-- Gregg
[3/8] from: jason:cunliffe:verizon at: 3-Feb-2004 15:12
Hi Gerard
> -- HTML Attachment decoded to text by Ecartis --
> -- File: REBOL-Doc-Structure.html
Good work.. I need some time to absorb what you've put out.
Do you need a website to post that document to so we can read/print as html?
Let me know if it will help you to have a shell/ftp login on my server
Else is there a section at rebol.org you can use?
How about formatting it as easy-vid?
I realize content is more imprortant than anything else.
But the mediaum is also important part of the message.
- Jason
[4/8] from: gerardcote:sympatico:ca at: 4-Feb-2004 1:09
Hi Jason, Gregg and Maxim. Thank you for your specific answers,
I will request for help and accept contributions as well when it will
be needed, later in the project. For the moment I simply want some
ML members to read and say what they think about the content of
the proposed indexing system - in view of helping any newbie to find
its way amongst the vast enough already exixting REBOL documentation.
May be some parts may seem to be useless, redundant or misleading.
For example the distinction to be done betwwen the Tools and the Library
- since some scripts seem to fit well into both. Other items may seem to miss.
Don't hesitate to add. But don't forget that until you I feed you with the
future planned TOC and content of my learning tools, many items may
leave you with the idea that not everything would be covered.
Note also that in a far future I also plan to offer advanced learning material
to support programmers that need this kind of material if time and need for
this are always present. It will also be for my own learning since this could
help to decode the inside of many advanced scripts using such concepts as
DYNAMIC DATA STRUCTURES as used in many advanced CS text books
and as supported in part by REBOL with its own list and block data structures.
This week i'll also work about the TOC and try to well plan the gradual
advance needed for the learning material I want to create in addition to all
what already exists here and elsewhere about REBOL learning.
This should will be submitted for review and comment before I begin the
real work about content.
For sure I will now continue my work using French since it will be easier
and shorter to me and I will ask Maxim and/or Jason and DidierC to help
review and translate some parts of my written work.
A last word to Jason about the the Web site and the easy-vid.r format
conversion you offered. In fact at this time
I suggest that we use some Web space on your server to start some
informal showcase
to display the incremental steps of the proposed TOC
when it is revised and updated - but at end I plan to ask Rebol.org to
display this TOC and REBOL.COM to add some pointer to it if Carl agrees to do so.
For the easy-vid.r conversion, I really don't see the urgency or even the true
usefulness of this step at this moment since this would not be easily viewable
with such long titles in the left column - some horizontal scroll bar is needed before.
May be the titles must be shortened instead. If you want to work on this you're
welcome.
But a last question about the way you suggest to use it : If some reader
downloads the TOC in easy-vid format, what will be the next step for him?
If downloading any of the other subsequent parts is your way then this is feasible
now but your content will have to be revised soon - so I personally wait until the
next revision if any before doing so.
If this can be of some help to you I can announce that I already began to hack
the easy-vid script a bit as to let it become 2 new derived apps :
1- an easy-VID generator which when coupled with some .txt file content
- much as the actual make-doc-pro - could automatically replace the actual
easy-VID fixed content and leave its easy-VID coating with its display, navigation
and execution functionalities - not as big deal but this could permit to easily create
from a single .txt entry a dual output simply by switching from a make-doc
generated HTML output to an easy-VID script format.
Actually this job must be done manually. Not a difficult one but one that could be simplified.
This new tool would change its name as the "make-easy-VID" application to
reflect its new nature when related to other make-doc family members. Some
restrictions apply but nevertheless they bear strong likeness.
2- A new version of the current easy-VID as been created with 2 new features :
a) a "Content linking" new mark-up has been added and implemented.
So when this mark-up is encountered in the actual Content a query
to start a new easy-VID copy with its own "Content " is executed and
the new easy-VID replaces the current one. ("#->" Mark-up instead of =URL
may be substituted but may mislead)
b) A second mark-up to add some additional information taken from a .txt
file has also been added trying to simulate in some way an external URL link.
This could be used for example to display in its own window the additional text
when the BOLD ITALIC UNDERLINE line is clicked - I was not able to
let the "anchored" word inside a current paragraph for display with some
different STYLE than the rest and I was not able to keep it with the rest if some
independent mouse click operation was to be used. (## mark-up)
This seems to be a limitation to the actual styles available inside View.
Some RTF like style would help here for the display part but the hyperlinking
seems to be another subtle part to implement ... if it is not done yet.
When this will be implemented (View 2.0 may be ?) there will not be a lot of
difference between the many make-doc family members as to the way the output
could be used - that is with real hyperlinks for easy-VID documents and for
make-doc-pro HTML-PDF documents.
At least this is on an old wish list I saw in the past about View and I finally know
why ... Word processing too is a potential client IIRC !!!
My 2 modifs are almost ready to be used but some adjustments are needed and
yet to be done. And I must also add them to the VID-usage enriched version of
easy-VID.
This is all for now,
Regards,
Gerard
[5/8] from: robert:muench:robertmuench at: 4-Feb-2004 17:42
On Wed, 4 Feb 2004 01:09:48 -0500, Gerard Cote <[gerardcote--sympatico--ca]>
wrote:
> For sure I will now continue my work using French since it will be easier
> and shorter to me and I will ask Maxim and/or Jason and DidierC to help
> review and translate some parts of my written work.
Hi, I would vote for english as otherwise a lot of us will be locked out
and why do all the work twice?
> 1- an easy-VID generator which when coupled with some .txt file content
> - much as the actual make-doc-pro - could automatically replace the
<<quoted lines omitted: 3>>
> output simply by switching from a make-doc generated HTML output to an
> easy-VID script format.
That's what I would like to support. IMO it should be able to create an
easy-vid player that make-doc-pro can feed. It's not that hard for me to
add a new emitter that the easy-vid player can use. Anyone interested in
working together with me on this part? Robert<
[6/8] from: gerardcote:sympatico:ca at: 4-Feb-2004 14:29
Hi Robert,
> > For sure I will now continue my work using French since it will be easier
> > and shorter to me and I will ask Maxim and/or Jason and DidierC to help
> > review and translate some parts of my written work.
>
> Hi, I would vote for english as otherwise a lot of us will be locked out
> and why do all the work twice?
>
The idea is not to fall short of producing an English version here but since my French
writing knowledge is really a lot better than
the actual English counterpart. So I wil gain much time if I express freely in my native
language and let other help me translate my
original work. The gains will be important since not only we will produce the same -
ouput in about the same time - In all cases I
will work a lot slower than them when I will create much of the new REBOL based material
(Design, test, code, debug, ...) so you'll
shouldn't notice the delay between the both versions. And I will gain insights from 2
or more qualified reviewers taht are also good
experienced programmers. This is not to put aside too. And finally even if I want to
produce both versions myself - since here I
really need a French version to support the newcomers that are only able to speak French,
this seems to me the most productive way
to do. The other way would request that I did all the job myself - 2 times since every
example will normally also use French names
for every word defined and comment found inside each script.
Too much a big job for only one people. The way I propose is a sharing one and this seems
the most adequate in this situation for me
and others too.
But I can ensure you Robert that nobody will be left aside during the process - since
this is firstly done for the whole
international REBOL community. I simply favor French as my own support tool since it
will be easier to me.
> > 1- an easy-VID generator which when coupled with some .txt file content
> > - much as the actual make-doc-pro - could automatically replace the
<<quoted lines omitted: 8>>
> working together with me on this part? Robert
> --
I'm a starter to work with you Robert.
I can send you what I already did about easy-vid.r and we could help each other to better
understand what is needed and how it can
be done. In fact I also looked back at the way you're emitting your HTML related tags
inside make-doc-pro. Since in your case the
output can be produced for the Internet browser to manage the display you don't have
to add overhead to the produced document as to
support navigational features like is the case in the easy-VID or VID-usage products.
Actually this overhead is a mere 3k in the current easy-VID script and 7k with the newer
VID-Usage script. I suggest that the latter
should be used instead since of the former since the newer now supports scroll options
for the right display pane . Nevertheless
like you I also think this can be done easily in a relatively short time.
When are you ready to start with ?
Regards,
Gerard
P.S. Don't forget that I'm also working on another easy-VID revision to let me execute
regular (non View) scripts from the easy-VID
script and display the results in another window. I did a first step in this direction
but the work is not completed yet. So doing
we will be able to recreate some functionalities inspired from the TCL-Tutor itself inspired
from the Dr.Scheme main window.
May be we can start working without any further consideration and we'll simply replace
any additional or updated modules when
completed. At least it would become feasible to create self-running REBOL Lessons without
having to dig inside each time to replace
manually any old content by a new one.
[7/8] from: gerardcote:sympatico:ca at: 4-Feb-2004 14:30
Hi List,
After a fresh look at the actual DOC indexing system on the Official Web site I went
to the conclusion that most of the existing
material I planned to re-index is already indexed there. Most of the known REBOL links
have also been added recently to the
displayed list.
So I'll simply continue by contributing some of the missing parts as desctibed in my
proposal and ask Carl to put some links to what
will be considered as useful when delivered exactly as is done now.
But nevertheless there are definitely some material that could be added to help starters
and I'll continue to help fill this gap as
much as I can with the help of the many volunteers that have recently put up their hand
over their head ... but more and more I
work with REBOL I think I always need support for the most advanced features I discover
and that are left unexplained - in the
official ways at least.
The many discussions held over the many comm channels continue to deliver the greatest
support that exists for now - simply hope it
will continue to deliver such a useful help for a long time to come ... since we'll never
be able to encapsulate all this knowledge
in the form of a static display ! But logs and archives search is a good way to cope
with as is currently done by Carl, Graham and
REBOL.org team. Thanks everybody since this is no small task - since recurrent...
Regards,
Gerard
[8/8] from: robert:muench:robertmuench at: 6-Feb-2004 14:00
On Wed, 4 Feb 2004 14:29:21 -0500, Gerard Cote <[gerardcote--sympatico--ca]>
wrote:
> But I can ensure you Robert that nobody will be left aside during the
> process - since this is firstly done for the whole
> international REBOL community. I simply favor French as my own support
> tool since it will be easier to me.
Hi, ok we will see.
> I can send you what I already did about easy-vid.r and we could help
> each other to better understand what is needed and how it can
> be done.
I once had a quick look at easy-vid but I don't remember its internal data
structure to store the parsed input. IMO it makes sense to define a
data/block structure that can be used by the player to create the layout
dynamically from the content and where the navigation stuff is included as
well.
> In fact I also looked back at the way you're emitting your HTML related
> tags inside make-doc-pro. Since in your case the
> output can be produced for the Internet browser to manage the display
> you don't have to add overhead to the produced document as to
> support navigational features like is the case in the easy-VID or
> VID-usage products.
I have a make-site script (thanks to Chris) that uses MDP to create
complete web-sites. My homepage is created with it. This script supports
navigational stuff already. I think this combination can be extended to
support VID emitter as well. That would be my starting point.
> When are you ready to start with ?
Any time but expect a slow progress as I'm doing a more-than-full-time-job
in parallel. As said, first step would be to look at the input data
structure for the player. If this one is defined, adding an emitter should
be easy.
> May be we can start working without any further consideration and we'll
> simply replace any additional or updated modules when
> completed. At least it would become feasible to create self-running
> REBOL Lessons without having to dig inside each time to replace
> manually any old content by a new one.
My idea is to create one output file that contains the input for the
player from a set of input files. The player could become an encapped
standalone version, so people don't have to install anything.
Having the input files separated makes it possible to work with a group of
people in paralle. The input structure is as follow:
\topic1
menu.txt
content1.txt
\topic2
menu.txt
content2.txt
menu.txt
index.txt
topic1.txt
topic2.txt
The first level is the main level. Every sublevel is a separate directory.
For each level exists a menu.txt file, specifying the available
navigation. Robert
Notes
- Quoted lines have been omitted from some messages.
View the message alone to see the lines that have been omitted