[SURVEY] Pillar input/output files.

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
10 messages Options
Reply | Threaded
Open this post in threaded view
|

[SURVEY] Pillar input/output files.

CyrilFerlicot
Hi,
I'm currently working on the way we manage the input files and the output files.
The way we manage the files now makes hard some improvement of Pillar.
That's why with Damien we though about makes some changes. The changes
are big so I wanted to talk about that with you.
We propose to have always 1 file with all the work inside. That can
use the inputFile tag. For example:

"${inputFile:Chapter1.pillar}$

${inputFile:Chapter2.pillar}$

${inputFile:Chapter3.pillar}$

${inputFile:Chapter4.pillar}$"

And the option "separateOutputFiles" will now create 1 file each time
we have a new Chapter. (!Level 1 header).
That will make simpler the way to number everything and to create
anchor because those 2 doesn't work well with the "separateOutputFile"
option.

What do you thing? That would be good with you?

--
Cheers
Cyril Ferlicot

Reply | Threaded
Open this post in threaded view
|

Re: [SURVEY] Pillar input/output files.

Damien Cassou-2

Cyril Ferlicot <[hidden email]> writes:

> Hi,
> I'm currently working on the way we manage the input files and the output files.
> The way we manage the files now makes hard some improvement of Pillar.
> That's why with Damien we though about makes some changes. The changes
> are big so I wanted to talk about that with you.
> We propose to have always 1 file with all the work inside. That can
> use the inputFile tag. For example:
>
> "${inputFile:Chapter1.pillar}$
>
> ${inputFile:Chapter2.pillar}$
>
> ${inputFile:Chapter3.pillar}$
>
> ${inputFile:Chapter4.pillar}$"
>
> And the option "separateOutputFiles" will now create 1 file each time
> we have a new Chapter. (!Level 1 header).
> That will make simpler the way to number everything and to create
> anchor because those 2 doesn't work well with the "separateOutputFile"
> option.
>
> What do you thing? That would be good with you?

this change proposes to remove the option inputFiles from Pillar. Pillar
will now take only 1 Pillar input file that must include the rest. This
will simplify pillar.conf, this will simplify compile.sh, this will make
it easier for the author to understand the process, and this will
simplify Pillar's implementation. With this in place, we think we can
fix the problems with anchors and inter-chapter links.

--
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-dev] [SURVEY] Pillar input/output files.

Guillermo Polito
If I understand correctly... then, why the pillar.conf is not just a pillar file? (And the conf is the header if the file?) :)

El lun., 4 de may. de 2015 a la(s) 2:50 p. m., Damien Cassou <[hidden email]> escribió:

Cyril Ferlicot <[hidden email]> writes:

> Hi,
> I'm currently working on the way we manage the input files and the output files.
> The way we manage the files now makes hard some improvement of Pillar.
> That's why with Damien we though about makes some changes. The changes
> are big so I wanted to talk about that with you.
> We propose to have always 1 file with all the work inside. That can
> use the inputFile tag. For example:
>
> "${inputFile:Chapter1.pillar}$
>
> ${inputFile:Chapter2.pillar}$
>
> ${inputFile:Chapter3.pillar}$
>
> ${inputFile:Chapter4.pillar}$"
>
> And the option "separateOutputFiles" will now create 1 file each time
> we have a new Chapter. (!Level 1 header).
> That will make simpler the way to number everything and to create
> anchor because those 2 doesn't work well with the "separateOutputFile"
> option.
>
> What do you thing? That would be good with you?

this change proposes to remove the option inputFiles from Pillar. Pillar
will now take only 1 Pillar input file that must include the rest. This
will simplify pillar.conf, this will simplify compile.sh, this will make
it easier for the author to understand the process, and this will
simplify Pillar's implementation. With this in place, we think we can
fix the problems with anchors and inter-chapter links.

--
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-dev] [SURVEY] Pillar input/output files.

Ben Coman
+1.  I can't think of any detractions.

On Mon, May 4, 2015 at 8:59 PM, Guillermo Polito <[hidden email]> wrote:
If I understand correctly... then, why the pillar.conf is not just a pillar file? (And the conf is the header if the file?) :)

El lun., 4 de may. de 2015 a la(s) 2:50 p. m., Damien Cassou <[hidden email]> escribió:

Cyril Ferlicot <[hidden email]> writes:

> Hi,
> I'm currently working on the way we manage the input files and the output files.
> The way we manage the files now makes hard some improvement of Pillar.
> That's why with Damien we though about makes some changes. The changes
> are big so I wanted to talk about that with you.
> We propose to have always 1 file with all the work inside. That can
> use the inputFile tag. For example:
>
> "${inputFile:Chapter1.pillar}$
>
> ${inputFile:Chapter2.pillar}$
>
> ${inputFile:Chapter3.pillar}$
>
> ${inputFile:Chapter4.pillar}$"
>
> And the option "separateOutputFiles" will now create 1 file each time
> we have a new Chapter. (!Level 1 header).
> That will make simpler the way to number everything and to create
> anchor because those 2 doesn't work well with the "separateOutputFile"
> option.
>
> What do you thing? That would be good with you?

this change proposes to remove the option inputFiles from Pillar. Pillar
will now take only 1 Pillar input file that must include the rest. This
will simplify pillar.conf, this will simplify compile.sh, this will make
it easier for the author to understand the process, and this will
simplify Pillar's implementation. With this in place, we think we can
fix the problems with anchors and inter-chapter links.

--
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill


Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-dev] [SURVEY] Pillar input/output files.

Guillermo Polito
Well, I'm using pillar for static web page generation. In such case, I don't need a main document.

What would be, more specifically, the impact over me? I know that
 - I will have to move my input files inside a mysite.pillar

and... what else?

El lun., 4 de may. de 2015 a la(s) 3:23 p. m., Ben Coman <[hidden email]> escribió:
+1.  I can't think of any detractions.

On Mon, May 4, 2015 at 8:59 PM, Guillermo Polito <[hidden email]> wrote:
If I understand correctly... then, why the pillar.conf is not just a pillar file? (And the conf is the header if the file?) :)

El lun., 4 de may. de 2015 a la(s) 2:50 p. m., Damien Cassou <[hidden email]> escribió:

Cyril Ferlicot <[hidden email]> writes:

> Hi,
> I'm currently working on the way we manage the input files and the output files.
> The way we manage the files now makes hard some improvement of Pillar.
> That's why with Damien we though about makes some changes. The changes
> are big so I wanted to talk about that with you.
> We propose to have always 1 file with all the work inside. That can
> use the inputFile tag. For example:
>
> "${inputFile:Chapter1.pillar}$
>
> ${inputFile:Chapter2.pillar}$
>
> ${inputFile:Chapter3.pillar}$
>
> ${inputFile:Chapter4.pillar}$"
>
> And the option "separateOutputFiles" will now create 1 file each time
> we have a new Chapter. (!Level 1 header).
> That will make simpler the way to number everything and to create
> anchor because those 2 doesn't work well with the "separateOutputFile"
> option.
>
> What do you thing? That would be good with you?

this change proposes to remove the option inputFiles from Pillar. Pillar
will now take only 1 Pillar input file that must include the rest. This
will simplify pillar.conf, this will simplify compile.sh, this will make
it easier for the author to understand the process, and this will
simplify Pillar's implementation. With this in place, we think we can
fix the problems with anchors and inter-chapter links.

--
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill


Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-dev] [SURVEY] Pillar input/output files.

Damien Cassou-2
In reply to this post by Guillermo Polito

Guillermo Polito <[hidden email]> writes:

> If I understand correctly... then, why the pillar.conf is not just a pillar
> file? (And the conf is the header if the file?) :)

my middle-term goal is to simplify/remove as much as possible both the
pillar.conf and compile.sh scripts.

--
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-dev] [SURVEY] Pillar input/output files.

Damien Cassou-2
In reply to this post by Guillermo Polito

Guillermo Polito <[hidden email]> writes:

> Well, I'm using pillar for static web page generation. In such case, I
> don't need a main document.
>
> What would be, more specifically, the impact over me? I know that
>  - I will have to move my input files inside a mysite.pillar
>
> and... what else?

static web page generation is an important target for us so we won't
forget about this use case. Cyril will give more information when the
picture gets clearer.

--
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-dev] [SURVEY] Pillar input/output files.

NorbertHartl

> Am 04.05.2015 um 15:52 schrieb Damien Cassou <[hidden email]>:
>
>
> Guillermo Polito <[hidden email]> writes:
>
>> Well, I'm using pillar for static web page generation. In such case, I
>> don't need a main document.
>>
>> What would be, more specifically, the impact over me? I know that
>> - I will have to move my input files inside a mysite.pillar
>>
>> and... what else?
>
> static web page generation is an important target for us so we won't
> forget about this use case. Cyril will give more information when the
> picture gets clearer.
>
Static web page generation is also interesting for me. Stef seems to work on something, too. Maybe it is a good idea to lay out the ideas in the open.

Norbert



Reply | Threaded
Open this post in threaded view
|

Re: [Moose-dev] [SURVEY] Pillar input/output files.

abergel
In reply to this post by CyrilFerlicot
Hi Cyril,

It does not look that different. Something I may recommend, is that Pillar should be effective at writing other things than a book. So, the chapter decomposition should not be forced.

Cheers,
Alexandre
-- 
_,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
Alexandre Bergel  http://www.bergel.eu
^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.



On May 4, 2015, at 7:38 AM, Cyril Ferlicot <[hidden email]> wrote:

Hi,
I'm currently working on the way we manage the input files and the output files.
The way we manage the files now makes hard some improvement of Pillar.
That's why with Damien we though about makes some changes. The changes
are big so I wanted to talk about that with you.
We propose to have always 1 file with all the work inside. That can
use the inputFile tag. For example:

"${inputFile:Chapter1.pillar}$

${inputFile:Chapter2.pillar}$

${inputFile:Chapter3.pillar}$

${inputFile:Chapter4.pillar}$"

And the option "separateOutputFiles" will now create 1 file each time
we have a new Chapter. (!Level 1 header).
That will make simpler the way to number everything and to create
anchor because those 2 doesn't work well with the "separateOutputFile"
option.

What do you thing? That would be good with you?

--
Cheers
Cyril Ferlicot
_______________________________________________
Moose-dev mailing list
[hidden email]
https://www.iam.unibe.ch/mailman/listinfo/moose-dev

Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-dev] [Moose-dev] [SURVEY] Pillar input/output files.

CyrilFerlicot
Hi,
I think we'll be able to avoid what i've expose on the first message.
I changed the way Pillar parsed the files so it's not easier to create
a global numerator or inter file links. When i'll have something that
work i'll do a new configuration a post a message on the ML.

On 18 May 2015 at 22:53, Alexandre Bergel <[hidden email]> wrote:

> Hi Cyril,
>
> It does not look that different. Something I may recommend, is that Pillar
> should be effective at writing other things than a book. So, the chapter
> decomposition should not be forced.
>
> Cheers,
> Alexandre
> --
> _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
> Alexandre Bergel  http://www.bergel.eu
> ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
>
>
>
> On May 4, 2015, at 7:38 AM, Cyril Ferlicot <[hidden email]> wrote:
>
> Hi,
> I'm currently working on the way we manage the input files and the output
> files.
> The way we manage the files now makes hard some improvement of Pillar.
> That's why with Damien we though about makes some changes. The changes
> are big so I wanted to talk about that with you.
> We propose to have always 1 file with all the work inside. That can
> use the inputFile tag. For example:
>
> "${inputFile:Chapter1.pillar}$
>
> ${inputFile:Chapter2.pillar}$
>
> ${inputFile:Chapter3.pillar}$
>
> ${inputFile:Chapter4.pillar}$"
>
> And the option "separateOutputFiles" will now create 1 file each time
> we have a new Chapter. (!Level 1 header).
> That will make simpler the way to number everything and to create
> anchor because those 2 doesn't work well with the "separateOutputFile"
> option.
>
> What do you thing? That would be good with you?
>
> --
> Cheers
> Cyril Ferlicot
> _______________________________________________
> Moose-dev mailing list
> [hidden email]
> https://www.iam.unibe.ch/mailman/listinfo/moose-dev
>
>



--
Cheers
Cyril Ferlicot