[campsite-dev] manual rewrite - Newscoop Development Discussions on Sourcefabric Forum

import

Hi guys,

I want to introduce Sean Flynn, he's the maintainer of the Rocky Mountain
Oulook publication (http://www.outlook-rockies.ca) and he volunteered to help
rewrite the campsite manual, particulary the part regarding the template
language. We have a proposal of reorganizing the manual the following way:

- descripion of use cases (with examples and links to detailed description of
template statements)
- detailed description of template statements

Use cases are ways of using the template language to obtain a certain effect.
Examples of use cases: list articles in a section, list front page articles
from an issue, print article content with subchapters etc.

Use cases would contain a description of the case purpose, a code example and
explanations of every line of code - with links to detailed statements
description.

We'd like to know if you have any other ideeas or, if you are ok with this
proposal to write down a list of use cases to be included in the manual
(starting with the most obvious ones). Please include a code example and a
short description of the use case.

Thanks,
Mugur

__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com

------------------------------------------
Posted to Phorum via PhorumMail

import

Hi,

I guess I wasn't so lucky with this initiative since nobody answered Sad

So I
would like to ask you to add the manual rewrite task to the summer camp
schedule. Documentation is important and software without a good manual may not
be very successful. So please, think of examples of template language usage and
help improve the manual.

Mugur

--- Mugur Rus wrote:
> Hi guys,
>
> I want to introduce Sean Flynn, he's the maintainer of the Rocky Mountain
> Oulook publication (http://www.outlook-rockies.ca) and he volunteered to help
> rewrite the campsite manual, particulary the part regarding the template
> language. We have a proposal of reorganizing the manual the following way:
>
> - descripion of use cases (with examples and links to detailed description of
> template statements)
> - detailed description of template statements
>
> Use cases are ways of using the template language to obtain a certain effect.
> Examples of use cases: list articles in a section, list front page articles
> from an issue, print article content with subchapters etc.
>
> Use cases would contain a description of the case purpose, a code example and
> explanations of every line of code - with links to detailed statements
> description.
>
> We'd like to know if you have any other ideeas or, if you are ok with this
> proposal to write down a list of use cases to be included in the manual
> (starting with the most obvious ones). Please include a code example and a
> short description of the use case.
>
> Thanks,
> Mugur
>
>
> __________________________________________________
> Do You Yahoo!?
> Tired of spam? Yahoo! Mail has the best spam protection around
> http://mail.yahoo.com
>

__________________________________
Do you Yahoo!?
Yahoo! Mail - Helps protect you from nasty viruses.
http://promotions.yahoo.com/new_mail

------------------------------------------
Posted to Phorum via PhorumMail

import

hi mugur,

you are so right. so write. i completely agree and i also agree with your plan b, that we should discuss this at the summer camp. because my ideal scenario would be something like the php.net site where people can add examples etc. from anywhere.

does anybody know what software they are using?

in terms of the masterplan for the manual: i think we should look at what needs to be done (everything Wink

and chop it into pieces where we then find people responsible for these sections.

what i think the rockies should definately do: write a short use/case scenario and tarball thei templates. i think we should have more than that on the page.

what do you think?

campsite-dev@campware.org schrieb am 28.07.04 18:14:26:
>
> Hi,
>
> I guess I wasn't so lucky with this initiative since nobody answered Sad

So I
> would like to ask you to add the manual rewrite task to the summer camp
> schedule. Documentation is important and software without a good manual may not
> be very successful. So please, think of examples of template language usage and
> help improve the manual.
>
> Mugur
>
> --- Mugur Rus wrote:
> > Hi guys,
> >
> > I want to introduce Sean Flynn, he's the maintainer of the Rocky Mountain
> > Oulook publication (http://www.outlook-rockies.ca) and he volunteered to help
> > rewrite the campsite manual, particulary the part regarding the template
> > language. We have a proposal of reorganizing the manual the following way:
> >
> > - descripion of use cases (with examples and links to detailed description of
> > template statements)
> > - detailed description of template statements
> >
> > Use cases are ways of using the template language to obtain a certain effect.
> > Examples of use cases: list articles in a section, list front page articles
> > from an issue, print article content with subchapters etc.
> >
> > Use cases would contain a description of the case purpose, a code example and
> > explanations of every line of code - with links to detailed statements
> > description.
> >
> > We'd like to know if you have any other ideeas or, if you are ok with this
> > proposal to write down a list of use cases to be included in the manual
> > (starting with the most obvious ones). Please include a code example and a
> > short description of the use case.
> >
> > Thanks,
> > Mugur
> >
> >
> > __________________________________________________
> > Do You Yahoo!?
> > Tired of spam? Yahoo! Mail has the best spam protection around
> > http://mail.yahoo.com
> >
>
>
>
>
> __________________________________
> Do you Yahoo!?
> Yahoo! Mail - Helps protect you from nasty viruses.
> http://promotions.yahoo.com/new_mail

------------------------------------------
Posted to Phorum via PhorumMail

import

This is a multi-part message in MIME format.

------=_NextPart_000_0013_01C476D5.044DB690
Content-Type: text/plain;
charset="iso-8859-1"
Content-Transfer-Encoding: 7bit

Hi.

There was a request on the user's mail list a short time ago from "Michael"
asking about template samples. I sent him a copy of some of the ones we use
for the Outlook newspaper and quickly added comments to them. They are
attached as well as my message to him.

Is this going in the right direction for what you have in mind for a "short
use/case scenario"?

- Sean

----------MESSAGE----------
Hello Michael

Our site is www.outlook-rockies.ca. We are a small, regional weekly
distributed at no charge (advertiser supported) throughout the Bow Valley in
Alberta, Canada.

You will notice certain similarities between home.tpl, section.tpl and
article.tpl

All have an for the banner.

All have an for the footer.

All have an if - then - else structure for the navigation. This is because
we wanted different menu items to show depending on whether the viewer was a
registered user or not. If not registered (or not logged in) then display
nav.tpl otherwise display sub_nav.tpl Rightfully I should have included this
code in the nav.tpl itself. Then I would only have one navigation routine
instead of two.

All have an statement. This shows the word
ARCHIVE and a link to the current issue if the viewer is looking at an old
issue. For instance, if they are in the archives. The current issue link
following the ARCHIVE statement always goes to the most recent published
home page.

------=_NextPart_000_0013_01C476D5.044DB690
Content-type: message/external-body; access-type=URL; URL=http://sympa.mdlf.org/sympa-bin/wwsympa.fcgi/attach/campsite-dev/JOEKIKCCBOHOGGIDOEOGCEBDCIAA.sflynn@tec-man.com/template_zip; name="template_zip"; size="8596"

Content-type: application/x-zip-compressed;
name="template.zip"
Content-Transfer-Encoding: base64

------=_NextPart_000_0013_01C476D5.044DB690--

------------------------------------------
Posted to Phorum via PhorumMail

import

Why not use campsite and Sebastian's phorums?
We can than have separated sections and articles and we can make "all in one
page" template too. (than save html for offline browsing)

I like conception of "handbook" and "how-to's", where hanbook is maintained by
developers, while how-to's are written by 3rd parties and we just collect them
and save them to prevent disapearing of the page.

I would also prefer to make article discussion moderated by the article owner,
because it might be misused and this way we can at least hold the informations
and drop the crap.

Ondra

Cituji z emailu od Micz Flor :

> hi mugur,
>
> you are so right. so write. i completely agree and i also agree with your
> plan b, that we should discuss this at the summer camp. because my ideal
> scenario would be something like the php.net site where people can add
> examples etc. from anywhere.
>
> does anybody know what software they are using?
>
> in terms of the masterplan for the manual: i think we should look at what
> needs to be done (everything Wink

and chop it into pieces where we then find
> people responsible for these sections.
>
> what i think the rockies should definately do: write a short use/case
> scenario and tarball thei templates. i think we should have more than that on
> the page.
>
> what do you think?
>
> campsite-dev@campware.org schrieb am 28.07.04 18:14:26:
> >
> > Hi,
> >
> > I guess I wasn't so lucky with this initiative since nobody answered Sad

So
> I
> > would like to ask you to add the manual rewrite task to the summer camp
> > schedule. Documentation is important and software without a good manual may
> not
> > be very successful. So please, think of examples of template language usage
> and
> > help improve the manual.
> >
> > Mugur
> >
> > --- Mugur Rus wrote:
> > > Hi guys,
> > >
> > > I want to introduce Sean Flynn, he's the maintainer of the Rocky Mountain
> > > Oulook publication (http://www.outlook-rockies.ca) and he volunteered to
> help
> > > rewrite the campsite manual, particulary the part regarding the template
> > > language. We have a proposal of reorganizing the manual the following
> way:
> > >
> > > - descripion of use cases (with examples and links to detailed
> description of
> > > template statements)
> > > - detailed description of template statements
> > >
> > > Use cases are ways of using the template language to obtain a certain
> effect.
> > > Examples of use cases: list articles in a section, list front page
> articles
> > > from an issue, print article content with subchapters etc.
> > >
> > > Use cases would contain a description of the case purpose, a code example
> and
> > > explanations of every line of code - with links to detailed statements
> > > description.
> > >
> > > We'd like to know if you have any other ideeas or, if you are ok with
> this
> > > proposal to write down a list of use cases to be included in the manual
> > > (starting with the most obvious ones). Please include a code example and
> a
> > > short description of the use case.
> > >
> > > Thanks,
> > > Mugur
> > >
> > >
> > > __________________________________________________
> > > Do You Yahoo!?
> > > Tired of spam? Yahoo! Mail has the best spam protection around
> > > http://mail.yahoo.com
> > >
> >
> >
> >
> >
> > __________________________________
> > Do you Yahoo!?
> > Yahoo! Mail - Helps protect you from nasty viruses.
> > http://promotions.yahoo.com/new_mail
>
>
>
>

----------------------------------------------------------------
This message was sent using IMP, the Internet Messaging Program.

------------------------------------------
Posted to Phorum via PhorumMail

Howdy, Stranger!

Categories

Poll

Top Posters