Setools August 2006

setools@lists.squeakfoundation.org

9 participants
14 discussions

About writing the Gjallar manual
by goran＠krampe.se 05 Aug '06

05 Aug '06

Hi folks! I have been thinking a bit about how to write the manual for Gjallar. Texinfo is the default multi output toolset in the GNU community, quite interesting. But Gjallar also has the current idea of integrated context help in a Swiki format. And I don't want to maintain the same information twice. For printed output LaTeX is good - but I used Lout a few years back and liked it much more. So we already have the Swiki markup and I want to write a user guide, reference manual etc which looks nice, has different output formats but only uses the "simple" techniques: - Auto generated TOC - Headings, paragraphs, lists - Embedded images - Index - Foot notes - Handles URLs The code I have for Swiki parsing (using a superset of the syntax in the standard Swiki implementation) is easy to hack and to add/tweak in different directions. So using a Swiki style as the original source seems like a smart move. I also have added some macro processing mechanisms to the Swiki syntax for more advanced things. Then I want to produce HTML and PDF mainly. HTML is already half there - since we are talking about a Swiki implementation after all! :) It doesn't do TOC, index, footnotes but these things can be added later. The PDF could be easily produced through "cross compiling" to Lout or Texinfo. Lout is IMHO much simpler to use than LaTeX, has outstanding features and produces great output. An alternative - or additional route - would be to generate Texinfo thus gaining other backends too. The Texinfo manual looks nice and must surely be made using Texinfo itself. :) I skimmed it and Texinfo seems kinda easy to use and has a good manual. Since Swiki is hypertext and Lout/Texinfo are sequential we would somehow need to indicate how it should be flattened when rendered to those formats, but that seems like a simple problem. Having a special Swiki page acting like a TOC seems like a simple way - and then some mechanism to find "orphan" pages that are not linked from there. How does it sound? Other ideas? Interest in helping out? regards, Göran

2 2

Gjallar (previously known as Q2) next steps!
by goran＠krampe.se 04 Aug '06

04 Aug '06

Hi! What I intend to try do this week is: 1. Set up a swiki with info at http://swiki.krampe.se/gjallar (unless someone has a better name FAST). The swiki is up already in fact, readonly - see development model below. 2. Prepare one or two documents we already have (need to scan them so that they do not contain any sensitive info). I added a short introduction that I cut out from a different doc, it is a bit rough around the edges but even though it is more of a "selling the dev env"-doc it does contain some other small bits. 3. Harass my project leader further to nail the license so that we can publish code. 4. Prepare a ready to download "dev env" so that people can join and get started without having to put all pieces together manually. 5. Prepare a dev "howto" describing some doits etc. When we get more momentum we can turn the Swiki into a nice website and get a logo - it is funny how important such things are. :) I am doing now 1-3 now, 4-5 is not interesting until I have nailed the license and can publish the code. Regarding the model for development I will probably want to run this project like this to begin with: - I am the project leader and will give developer access to developers. I will act a bit like Linus does by reviewing and integrating contributions into the "official" codebase. - Developers wishing to participate simply contact me and will be given write access to the MC repo and to the Swiki. Each developer should also describe himself with at least one sentence on the Gjallar Swiki so that we always have a list of the team. - There is nothing stopping any of the developers joining to start their own official "branches" in the Gjallar repo, but I would like to discuss that need first. - The Monticello repo will be open for developers to publish their versions into without review. So fixes or enhancements can simply be pushed there. Then I will either pick them up and integrate into the official codebase or we will move them into some contributions directory if integration for some reason is not good. - Initially we don't create yet-another-mailinglist, we can probably start by using this one. - Only code licensed under the MIT license will be let in, given that Gjallar uses that license. :) - As soon as possible I will set up a Gjallar system for issue tracking of Gjallar itself. Eating our own dog food. Please comment on the above. regards, Göran PS. Sorry for the lack of code - I really am trying to get it decided, but people are still away on vacation here etc.

5 21

Q2 got accepted as a Demonstration at OOPSLA
by goran＠krampe.se 01 Aug '06

01 Aug '06

Hi folks! Ok, got an email today saying my Demonstration of the Q2 issue tracker got accepted to OOPSLA! Fun! So if you are going to OOPSLA, see you there! And on another note - I have a few name proposals for the project: 1. Yeti - YET another Issue tracker (or YEt another Tracker for Issues). It is a short catchy name, there doesn't seem to be many other OSS projects having the name and ideas for a logo should be easy. :) 2. Seshat (or Sashet) - An Egyptian Goddess. The goddess of libraries and record keeping, it means "female scribe". So it is really fitting but the name itself is hard to say and not as catchy as Yeti. Well, I probably have a lot more ideas for a name, but currently I am leaning strongly towards Yeti. What do you say? A cool and catchy name is quite important, funny enough. regards, Göran PS. I am still on vacation, will start working next week. Then I will start to open up the project on a public site. Even though the customer has decided to go open source, the license is not yet set - so I have to get that decided first, but it should be quick (MIT most probably). PPS. If you guys have any questions about the system, feel free to post. Otherwise there will be much more info coming up next week (design documents etc)., and if I get the time - a downloadable demo.

5 8

Gjallar screenshots with explanations
by goran＠krampe.se 01 Aug '06

01 Aug '06

Hi! Ok, Giovanni Corriga asked for screenshots last night on IRC so I added 18 of those with detailed descriptions. This should show work as a kinda good intro I think. http://swiki.krampe.se/gjallar regards, Göran

2 1

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

Setools August 2006