webgen users - Nov 2011 - RFC: Block starting line of Webgen Page Format

Hello everybody,

I''m currently deciding whether to simplify the block starting line of
the Webgen Page Format. Currently one can specify arbitrary key:value
pairs on the block starting line, e.g.

    --- name:test pipeline:erb,kramdown option:value

(see http://webgen.rubyforge.org/documentation/webgen_page_format.html)

However, I don''t think that these options ever get used and therefore I
would like to remove them so that the block starting line just consists
of the three dashes, the name and optionally three or more dashes for
better visual distinction of blocks. I.e.

    --- test ---------------------------------------

What do you think? +1 on this change or leave it as it is now?

FYI: This will come into effect in the next major version of webgen.

Best regards,
  Thomas

I am still trying to convert my 0.4 sites with hundreds of pages to 0.5, so it
would be nice to consider backward compatibility.

In this case though, I personally don''t use these options, so I would
not miss them.


Scott M.


-----Original Message-----
From: webgen-users-bounces at rubyforge.org [mailto:webgen-users-bounces at
rubyforge.org] On Behalf Of Thomas Leitner
Sent: Sunday, November 20, 2011 8:10 AM
To: webgen-users at rubyforge.org
Subject: [webgen-users] RFC: Block starting line of Webgen Page Format

Hello everybody,

I''m currently deciding whether to simplify the block starting line of
the Webgen Page Format. Currently one can specify arbitrary key:value
pairs on the block starting line, e.g.

    --- name:test pipeline:erb,kramdown option:value

(see http://webgen.rubyforge.org/documentation/webgen_page_format.html)

However, I don''t think that these options ever get used and therefore I
would like to remove them so that the block starting line just consists
of the three dashes, the name and optionally three or more dashes for
better visual distinction of blocks. I.e.

    --- test ---------------------------------------

What do you think? +1 on this change or leave it as it is now?

FYI: This will come into effect in the next major version of webgen.

Best regards,
  Thomas
_______________________________________________
webgen-users mailing list
webgen-users at rubyforge.org
http://rubyforge.org/mailman/listinfo/webgen-users

On 2011-11-22 06:06 +0000 McClelland, Scott wrote:
> I am still trying to convert my 0.4 sites with hundreds of pages to
> 0.5, so it would be nice to consider backward compatibility.
Most things in the new version will be backwards compatible. However,
some things will break, especially custom extension. But these
breakages should be easy to fix (the homepage of webgen will also need
to be updated, so I will document everything and maybe I will write a
small script which does the heavy lifting).

If you need help converting from 0.4 to 0.5, just mail me.
 
> In this case though, I personally don''t use these options, so I
would
> not miss them.
Thanks for the input!

Best regards,
  Thomas

>From Thomas Leitner, the Sun 20 Nov 2011 at 17:09:32 (+0100):
> I''m currently deciding whether to simplify the block starting line
of
> the Webgen Page Format. Currently one can specify arbitrary key:value
> pairs on the block starting line, e.g.
> 
>     --- name:test pipeline:erb,kramdown option:value
> 
> (see http://webgen.rubyforge.org/documentation/webgen_page_format.html)
> 
> However, I don''t think that these options ever get used and
therefore I
> would like to remove them so that the block starting line just consists
> of the three dashes, the name and optionally three or more dashes for
> better visual distinction of blocks. I.e.
> 
>     --- test ---------------------------------------
But in this case, how could we change the options for a particular block?
I sometimes use the key:value format to change the pipeline options of a
block. It is true that I seldom use this feature, but it seems like webgen
could support both formats, the key:value one, and the simple --- name ---
one.

-- 
Damien

On 2011-11-25 13:33 +0100 Damien Robert wrote:
> >From Thomas Leitner, the Sun 20 Nov 2011 at 17:09:32 (+0100):
> > However, I don''t think that these options ever get used and
> > therefore I would like to remove them so that the block starting
> > line just consists of the three dashes, the name and optionally
> > three or more dashes for better visual distinction of blocks. I.e.
> > 
> >     --- test ---------------------------------------
> 
> But in this case, how could we change the options for a particular
> block? I sometimes use the key:value format to change the pipeline
> options of a block. It is true that I seldom use this feature, but it
> seems like webgen could support both formats, the key:value one, and
> the simple --- name --- one.
You can always use the `blocks` meta information to set block specific
options! I also use the key:value form only for setting the pipeline in
some files...

Allowing both forms would probably be the best way to go...

Best regards,
  Thomas