Re: [fossil-users] Documentation for TH1

[pnr]

Stephan,
 
I expressed myself poorly.
 
The actual "port" to OOo is not harder than opening the MS .doc file in OOo 
writer and doing a "save as" into the native ODF format. I have done so and you 
can find it here:
http://www.sqliteconcepts.org/THManual.odt 
<http://www.sqliteconcepts.org/THManual.odt> 
 
When I wrote "pondering organisation and the toc", I was not refering to the 
generating the page index, I meant to say I was pondering how to sequence 
topics to make for a clear linear read for those learning (ref. the many "how 
do I do ..." questions in this list), and to make it a usable reference 
document at the same time. My current plan is as per below -- I have a clear 
idea of what I mean by each line, I hope it understandable for others. 
Suggestions welcome. Do you have a good idea for a very, very small project 
that I can use throughout as an example? Two, three files, 1.000 lines max, 
non-trivial enough to show fossil features in a real way?
 
Draft TOC:
 
Introduction
1. Version Control
 
Part I - Working with Fossil
 
2. Obtaining & installing Fossil
3. Stand-alone development
- Files, leaves and check-ins
- Commiting changes
- Project forks and branches
- Adding tags and properties
- Viewing project history 
- Generating and viewing "diffs"
4. Team development
- Remote repositories
- Sharing changes: Clone, Push, Pull & Sync
- Merging forks and branches
- Setting up an ad-hoc server
- Autosync verus manual-merge
- Private branches
- Local repository state
5. Project archeology
- Working with timelines
- Accessing the 'tip' and 'trunk' branches
- Viewing old file versions
- Generating check-in zip archives
 
Part II - Using the wiki
 
6. Using the wiki gui
- Creating a new page
- Editing a page
- Setting the home page to a wiki page
7. The Fossil Wiki language
- Formatting
- Links
- Images
8. Creating embedded documentation
9. Command line wiki access
10. Wiki Version control
- Wiki versioning background
- Accessing older page versions
- Forks and branches

Part III - The ticket system
 
11. Using the ticket system
13. Customising the ticket system
- Ticket system concepts
- Changing the ticket schema
14. The TH1 script language
- structure & syntax
- core commands
- ticket extensions
15. Changing the ticket interface

Part IV - Fossil administration
 
16. Fossil web administration
17. Fossil command line settings
18. Setting up a Fossil hub server
- cgi
- inet / xinet
- windows
19. Converting projects from CVS

Part V - Advanced Concepts
 
20. Fossil principles & design
21. Storage formats
22. Fossil files and schemas
- The repository file & database schema
- The checkout file & database schema
- The user file & database schema
23. Deltas and the delta algorithm
24. The synchronisation protocol
25. A quick tour of the Fossil source code

Part V - Command line reference
...

Index




From: fossil-users-boun...@lists.fossil-scm.org on behalf of Stephan Beal
Sent: Thu 10/1/2009 5:50 PM
To: fossil-users@lists.fossil-scm.org
Subject: Re: [fossil-users] Documentation for TH1


On Tue, Sep 29, 2009 at 10:24 PM,  wrote:


Hi "slowly slogging" Kevin,
 
Nope, it ain't texinfo -- its plain old ms word, but I will probably 
move it to OOo.
 
The past 6 months I've been absorbed by other projects, but I expect to 
be able to continue work on a full Fossil manual shortly. Actually, I've been 
pondering organisation and the toc most of yesterday.



Can you post the doc file (or send it to me directly)? i wouldn't mind having a 
go at porting it to OOo. IMO you shouldn't fight with the TOC - let OOo build 
it automatically from the headers. i've got an OOo doc which i use as the basis 
for several software lib manuals, which has all of the stuff set up for 
automatic generation of the TOC (e.g. http://s11n.net/download/#manual).

-- 
- stephan beal
http://wanderinghorse.net/home/stephan/

___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[Stephan Beal]

On Tue, Sep 29, 2009 at 10:24 PM,  wrote:

>  Hi "slowly slogging" Kevin,
>
> Nope, it ain't texinfo -- its plain old ms word, but I will probably move
> it to OOo.
>
> The past 6 months I've been absorbed by other projects, but I expect to be
> able to continue work on a full Fossil manual shortly. Actually, I've been
> pondering organisation and the toc most of yesterday.
>


Can you post the doc file (or send it to me directly)? i wouldn't mind
having a go at porting it to OOo. IMO you shouldn't fight with the TOC - let
OOo build it automatically from the headers. i've got an OOo doc which i use
as the basis for several software lib manuals, which has all of the stuff
set up for automatic generation of the TOC (e.g.
http://s11n.net/download/#manual).

-- 
- stephan beal
http://wanderinghorse.net/home/stephan/
___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[pnr]

Hi "slowly slogging" Kevin,
 
Nope, it ain't texinfo -- its plain old ms word, but I will probably move it to 
OOo.
 
The past 6 months I've been absorbed by other projects, but I expect to be able 
to continue work on a full Fossil manual shortly. Actually, I've been pondering 
organisation and the toc most of yesterday.
 
Paul



From: fossil-users-boun...@lists.fossil-scm.org on behalf of kkinnell
Sent: Tue 9/29/2009 5:50 PM
To: fossil-users@lists.fossil-scm.org
Subject: Re: [fossil-users] Documentation for TH1



Actually, if the PDF is in the main repository, then it just
needs to be reworded.  pnr's TH core document is a beautiful
thing.  We just need a short list of built-in vars etc. and
a short tutorial with pointers to examples in the fossil
code.

So the wording ought to be something like "see 
for basic TH1.  Currently there is no tutorial but you can
take a look at the Fossil source for some examples."

Paul: that document looks very texinfo'ish -- is there info
source for it?

--kevin kinnell


___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[kkinnell]

Actually, if the PDF is in the main repository, then it just
needs to be reworded.  pnr's TH core document is a beautiful
thing.  We just need a short list of built-in vars etc. and
a short tutorial with pointers to examples in the fossil
code.

So the wording ought to be something like "see 
for basic TH1.  Currently there is no tutorial but you can
take a look at the Fossil source for some examples."

Paul: that document looks very texinfo'ish -- is there info
source for it?

--kevin kinnell

- Original Message -
From: Daniel Clark 
To: fossil-users@lists.fossil-scm.org
Subject: Re: [fossil-users] Documentation for TH1
Date: Mon, 21 Sep 2009 01:52:07 -0400

>On Tue, May 5, 2009 at 5:10 PM,   wrote:
>> Richard,
>>
>> Please find documentation for the TH core language at
>> this location: http://www.sqliteconcepts.org/THManual.pdf
>> Hope this helps.
>
>Perhaps this doc:
>http://www.fossil-scm.org/index.html/doc/tip/www/bugtheory.wiki
>
>should be updated to point to this thread [1] and
>THManual.pdf?
>
>Currently it states "There is currently no documentation on
>the TH1 language".
>
>[1] Re: Documentation for TH1
>http://thread.gmane.org/gmane.comp.version-control.fossil-scm.user/600/focus=1
>
>-- 
>Daniel JB Clark   | Sys Admin, Free Software Foundation
>pobox.com/~dclark | http://www.fsf.org/about/staff#danny
>___
>fossil-users mailing list
>fossil-users@lists.fossil-scm.org
>http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[kkinnell]

"A slow sort of country!" said the Queen. "Now, here, you
see, it takes all the running you can do, to keep in the
same place. If you want to get somewhere else, you must run
at least twice as fast as that!"

I think the Red Queen has a metaphor for documenting going,
there.

--kevin "slowly slogging" kinnell  ;)

- Original Message -
From: Daniel Clark 
To: fossil-users@lists.fossil-scm.org
Subject: Re: [fossil-users] Documentation for TH1
Date: Mon, 21 Sep 2009 01:52:07 -0400

>On Tue, May 5, 2009 at 5:10 PM,   wrote:
>> Richard,
>>
>> Please find documentation for the TH core language at
>> this location: http://www.sqliteconcepts.org/THManual.pdf
>> Hope this helps.
>
>Perhaps this doc:
>http://www.fossil-scm.org/index.html/doc/tip/www/bugtheory.wiki
>
>should be updated to point to this thread [1] and
>THManual.pdf?
>
>Currently it states "There is currently no documentation on
>the TH1 language".
>
>[1] Re: Documentation for TH1
>http://thread.gmane.org/gmane.comp.version-control.fossil-scm.user/600/focus=1
>
>-- 
>Daniel JB Clark   | Sys Admin, Free Software Foundation
>pobox.com/~dclark | http://www.fsf.org/about/staff#danny
>___
>fossil-users mailing list
>fossil-users@lists.fossil-scm.org
>http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[Daniel Clark]

On Tue, May 5, 2009 at 5:10 PM,   wrote:
> Richard,
>
> Please find documentation for the TH core language at this location:
> http://www.sqliteconcepts.org/THManual.pdf
> Hope this helps.

Perhaps this doc:
http://www.fossil-scm.org/index.html/doc/tip/www/bugtheory.wiki

should be updated to point to this thread [1] and THManual.pdf?

Currently it states "There is currently no documentation on the TH1 language".

[1] Re: Documentation for TH1
http://thread.gmane.org/gmane.comp.version-control.fossil-scm.user/600/focus=1

-- 
Daniel JB Clark   | Sys Admin, Free Software Foundation
pobox.com/~dclark | http://www.fsf.org/about/staff#danny
___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[Robert Ledger]

It's not immediately obvious, (at least it wasn't to me ;) how to set
a variable as an array.

I figured it out eventually, but maybe an example would be useful?

--
Robert
___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[pnr]

You're welcome.
 
In the following archive you can find my quick hack to do a standalone (command 
line) TH interpreter for experimentation. Perhaps it will be useful to you.
http://www.sqliteconcepts.org/TH_src.zip 
<http://www.sqliteconcepts.org/TH_src.zip> 
 
Note the docs do not document the use of TH in the ticketing system yet, nor 
the TH embedding API. The latter is not so hard to do, but I haven't understood 
Richard's code well enough to document and define how TH and Fossil should 
interact.
 
Feel free to ask if you have questions that I might be able to answer.
 
Paul



From: fossil-users-boun...@lists.fossil-scm.org on behalf of Robert Ledger
Sent: Sat 5/9/2009 12:00 PM
To: fossil-users@lists.fossil-scm.org
Subject: Re: [fossil-users] Documentation for TH1



Thank you! Very Useful Docs :)  Now we could do with a web page that
accepts th scripts in a text box and prints the result in another text
box -- perhaps providing isolation so that no harm can be done?

Assuming that's feasible of course.

Maybe I'll have a go at it once I've worked through the docs ...
unless someone beats me to it!  Is that feasible do you think?
--
Robert
___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users


___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[Robert Ledger]

Thank you! Very Useful Docs :)  Now we could do with a web page that
accepts th scripts in a text box and prints the result in another text
box -- perhaps providing isolation so that no harm can be done?

Assuming that's feasible of course.

Maybe I'll have a go at it once I've worked through the docs ...
unless someone beats me to it!  Is that feasible do you think?
--
Robert
___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[Bill Whiting]

I would suggest openoffice as a document format.  It runs on Linux, 
Windows, Mac, FreeBSD and others.
There is a decent drawing tool which will let you include your image in 
a document, or export to a multitude of formats.
And MS-Word documents usually import with no problems.  I even was able 
to read a Word-2007 document when a collegue w/ MS-Word 2000 could not.

//Bill

p...@planet.nl wrote:
> Thank you for your kind words. Below a few remarks to clarify.
>  
> [1] The text and logo are herewith placed in the public domain. Tell 
> me if you need a form ala sqlite. The text is inspired by the Tcl man 
> pages and some paragraphs have been copied verbatim. In my opinion 
> this stays well within the boundaries of "fair use" and the text 
> constitutes an original work in the copyright sense, hence my ability 
> to place it in the public domain. Attribution of the Tcl man pages as 
> a source is the royal road though.
>  
> [2] The text is now in MS Word, which is the fastest way for me to get 
> stuff written up. However, as a publication and/or sharing format it 
> won't do. PDF works well for reading, but does not allow for 
> easy community updates. Perhaps it is best converted into Fossil wiki 
> format, but I am not sure that format offers enough in terms of markup 
> & style sheets. Please advise.
>  
> [3] The logo is just 31 elipses thrown together to suggest a fossil, 
> so doing another drawing should be easy enough. Tell me what (Ubuntu) 
> software you want it drawn in and I'll give it a go.
>  
> [4] I'm not aware of having fossil check in priviliges, nor do I know 
> where in the file hierarchy you would want the files situated. If you 
> advise of such, I'll do the check in.
>  
> Paul
>
> 
> *From:* fossil-users-boun...@lists.fossil-scm.org on behalf of D. 
> Richard Hipp
> *Sent:* Tue 5/5/2009 11:25 PM
> *To:* fossil-users@lists.fossil-scm.org
> *Subject:* Re: [fossil-users] Documentation for TH1
>
>
> On May 5, 2009, at 5:10 PM,   wrote:
>
> > Richard,
> >
> > Please find documentation for the TH core language at this location:
> > http://www.sqliteconcepts.org/THManual.pdf
> > Hope this helps.
> >
> > All feedback welcome & please advise what document format you need.
> >
> >
>
>
> At first glance, this looks *very* nice.  What is the source 
> language?  Is this something that can be checked into the fossil 
> repository.
>
> I really, really like the logo and want to add it to the website.  Can 
> you generate postscript or some other resolution independent format of 
> the logo and check that into the fossil website, at least?
>
>
> D. Richard Hipp
> d...@hwaci.com
>
>
>
> ___
> fossil-users mailing list
> fossil-users@lists.fossil-scm.org
> http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
>
> 
>
> ___
> fossil-users mailing list
> fossil-users@lists.fossil-scm.org
> http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
>   

___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[pnr]

> Maybe a fossilized gnu, Linux penguin, or BSD demon would be more
> appropriate ;).

Or a petrified window? I operate linux, bsd and windows boxes and they are all 
the same to me.
 
Thanks for the correction. I'll leave the text aside for a few weeks and then 
have a fresh read to fix errors and problems. In the meantime all suggestions 
like the below are welcome.
 
Paul




From: fossil-users-boun...@lists.fossil-scm.org on behalf of Stephan Beal
Sent: Wed 5/6/2009 7:58 AM
To: fossil-users@lists.fossil-scm.org
Subject: Re: [fossil-users] Documentation for TH1



On Tue, May 5, 2009 at 11:25 PM, D. Richard Hipp  wrote:
> I really, really like the logo and want to add it to the website.

Maybe a fossilized gnu, Linux penguin, or BSD demon would be more
appropriate ;).


@Paul: Wow! i think you've just doubled the amount of docs fossil has.
A tiny recommendation for Page 4:


Words cannot start with one of the TH special characters { } [ ] \ ; and ". Note
that a single quote ' is not a special character in TH. To use one of
these characters to
start a word it must be escaped, which is discussed further later on.


i would swap sentences 2 and 3 because #3 _seems_ to refer to the
single quote, whereas i believe it's really referring to the chars
listed in the first sentence. Swapping them would clarify that
ambiguity.

--
- stephan beal
http://wanderinghorse.net/home/stephan/ 
<http://wanderinghorse.net/home/stephan/> 
___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users 
<http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users> 


___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[pnr]

Thank you for your kind words. Below a few remarks to clarify.
 
[1] The text and logo are herewith placed in the public domain. Tell me if you 
need a form ala sqlite. The text is inspired by the Tcl man pages and some 
paragraphs have been copied verbatim. In my opinion this stays well within the 
boundaries of "fair use" and the text constitutes an original work in the 
copyright sense, hence my ability to place it in the public domain. Attribution 
of the Tcl man pages as a source is the royal road though.
 
[2] The text is now in MS Word, which is the fastest way for me to get stuff 
written up. However, as a publication and/or sharing format it won't do. PDF 
works well for reading, but does not allow for easy community updates. Perhaps 
it is best converted into Fossil wiki format, but I am not sure that format 
offers enough in terms of markup & style sheets. Please advise.
 
[3] The logo is just 31 elipses thrown together to suggest a fossil, so doing 
another drawing should be easy enough. Tell me what (Ubuntu) software you want 
it drawn in and I'll give it a go.
 
[4] I'm not aware of having fossil check in priviliges, nor do I know where in 
the file hierarchy you would want the files situated. If you advise of such, 
I'll do the check in.
 
Paul



From: fossil-users-boun...@lists.fossil-scm.org on behalf of D. Richard Hipp
Sent: Tue 5/5/2009 11:25 PM
To: fossil-users@lists.fossil-scm.org
Subject: Re: [fossil-users] Documentation for TH1




On May 5, 2009, at 5:10 PM,   wrote:

> Richard,
>
> Please find documentation for the TH core language at this location:
> http://www.sqliteconcepts.org/THManual.pdf
> Hope this helps.
>
> All feedback welcome & please advise what document format you need.
>
>


At first glance, this looks *very* nice.  What is the source 
language?  Is this something that can be checked into the fossil 
repository.

I really, really like the logo and want to add it to the website.  Can 
you generate postscript or some other resolution independent format of 
the logo and check that into the fossil website, at least?


D. Richard Hipp
d...@hwaci.com



___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users


___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[Stephan Beal]

On Tue, May 5, 2009 at 11:25 PM, D. Richard Hipp  wrote:
> I really, really like the logo and want to add it to the website.

Maybe a fossilized gnu, Linux penguin, or BSD demon would be more
appropriate ;).


@Paul: Wow! i think you've just doubled the amount of docs fossil has.
A tiny recommendation for Page 4:


Words cannot start with one of the TH special characters { } [ ] \ ; and ". Note
that a single quote ‘ is not a special character in TH. To use one of
these characters to
start a word it must be escaped, which is discussed further later on.


i would swap sentences 2 and 3 because #3 _seems_ to refer to the
single quote, whereas i believe it's really referring to the chars
listed in the first sentence. Swapping them would clarify that
ambiguity.

-- 
- stephan beal
http://wanderinghorse.net/home/stephan/
___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[D. Richard Hipp]

On May 5, 2009, at 5:10 PM,   wrote:

> Richard,
>
> Please find documentation for the TH core language at this location:
> http://www.sqliteconcepts.org/THManual.pdf
> Hope this helps.
>
> All feedback welcome & please advise what document format you need.
>
>


At first glance, this looks *very* nice.  What is the source  
language?  Is this something that can be checked into the fossil  
repository.

I really, really like the logo and want to add it to the website.  Can  
you generate postscript or some other resolution independent format of  
the logo and check that into the fossil website, at least?


D. Richard Hipp
d...@hwaci.com



___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Re: [fossil-users] Documentation for TH1

[pnr]

Richard,
 
Please find documentation for the TH core language at this location:
http://www.sqliteconcepts.org/THManual.pdf 
 
Hope this helps.
 
All feedback welcome & please advise what document format you need.
 
Paul



From: fossil-users-boun...@lists.fossil-scm.org on behalf of D. Richard Hipp
Sent: Mon 4/27/2009 2:59 PM
To: fossil-users@lists.fossil-scm.org
Subject: Re: [fossil-users] Documentation TH1




On Apr 27, 2009, at 8:56 AM,   wrote:

> Is there documentation for the Fossil scripting language "TH" (or is 
> it "TH1"?) available somewhere?
> Or is it a matter of "Use the Source, Luke" :^)
>

Unfortunately, the only documentation currently available is the 
source code.  This is a deficiency that needs to be addressed.

D. Richard Hipp
d...@hwaci.com



___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users


___
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users