Raw and process content directories

[Ferdinand Soethe <sa...@soethe.net>]

Just to make sure I have this right before I rewrite any more
documentation:

In /docs/upgrading_07.html#raw I found:

> In 0.6 version, the raw content was placed in the
> src/documentation/content/ directory and potential sub-directories.
> In the generated site, these links would automatically function. Any
> linked file with .html extension was not processed and not adorned
> with Forrest skin and navigation menus.

> In 0.7 version, any file that is linked to, needs to be placed in
> the content/xdocs/ directory structure. Any linked file with .html
> extension is now processed and is adorned with Forrest skin and
> navigation menus.

> If you need to include files that are not linked to, then place them
> in the src/documentation/content/ directories as with the 0.6
> version.



So does

 "any file that is linked to, needs to be placed in
  the content/xdocs/"

really mean that I will get an error if I place
a file that is linked to in the content-directory.

Or does it mean "can now be placed in either xdocs or content
directory at my disgression" depending on wether I want processing to
happen or not.

> If you need to link to html files but want them to be un-processed,
> then place them in the src/documentation/content/ directories and
> add an entry to conf/cli.xconf to exclude them from processing. An
> FAQ describes the use of Cocoon's cli.xconf

This last para seems to confirm the first version because otherwise I
could just place the file into content rather than writing an
exclusion rule.

Thanks for making that clear.


--
Ferdinand Soethe

Re: Raw and process content directories

[Ross Gardler <rg...@apache.org>]

Ferdinand Soethe wrote:
>>>In 0.6 version, the raw content was placed in the
>>>src/documentation/content/ directory and potential sub-directories.
>>>In the generated site, these links would automatically function. Any
>>>linked file with .html extension was not processed and not adorned
>>>with Forrest skin and navigation menus.
> 
> 
>>>In 0.7 version, any file that is linked to, needs to be placed in
>>>the content/xdocs/ directory structure. Any linked file with .html
>>>extension is now processed and is adorned with Forrest skin and
>>>navigation menus.
> 
> 
>>>If you need to include files that are not linked to, then place them
>>>in the src/documentation/content/ directories as with the 0.6
>>>version.
> 
> 
> 
> 
>>So does
> 
> 
>> "any file that is linked to, needs to be placed in
>>  the content/xdocs/"
> 
> 
>>really mean that I will get an error if I place
>>a file that is linked to in the content-directory.

Yes, I believe so, but the only sure way to find out is to test it.

Ross

Re: Raw and process content directories

[Ferdinand Soethe <sa...@soethe.net>]

David Crossley wrote:

> Sorry, if i am going to try and explain it then i would rather
> go and do the job myself, because, like you i do not fully
> understand the ramifications of changing the behaviour from
> 0.6 version. The only way is to go and fix the seed site.

OK, I didn't realize that nobody really knows, so I figured rather then
testing against an unknown standard I'd rather ask.

Will try and see what I get.

--
Ferdinand Soethe

Re: Raw and process content directories

[David Crossley <cr...@apache.org>]

Ferdinand Soethe wrote:
> Maybe this has gotten lost in all the mail delays. Can anybody pls
> comment so that I can close FOR-470.
> 
> Thanks,
> Ferdinand Soethe
> 
> I wrote:
> 
> > Just to make sure I have this right before I rewrite any more
> > documentation:
> 
> > In /docs/upgrading_07.html#raw I found:
> 
> >> In 0.6 version, the raw content was placed in the
> >> src/documentation/content/ directory and potential sub-directories.
> >> In the generated site, these links would automatically function. Any
> >> linked file with .html extension was not processed and not adorned
> >> with Forrest skin and navigation menus.
> 
> >> In 0.7 version, any file that is linked to, needs to be placed in
> >> the content/xdocs/ directory structure. Any linked file with .html
> >> extension is now processed and is adorned with Forrest skin and
> >> navigation menus.
> 
> >> If you need to include files that are not linked to, then place them
> >> in the src/documentation/content/ directories as with the 0.6
> >> version.
> 
> > So does
> 
> >  "any file that is linked to, needs to be placed in
> >   the content/xdocs/"
> 
> > really mean that I will get an error if I place
> > a file that is linked to in the content-directory.

Try it.

> > Or does it mean "can now be placed in either xdocs or content
> > directory at my disgression" depending on wether I want processing to
> > happen or not.
>
> >> If you need to link to html files but want them to be un-processed,
> >> then place them in the src/documentation/content/ directories and
> >> add an entry to conf/cli.xconf to exclude them from processing. An
> >> FAQ describes the use of Cocoon's cli.xconf
> 
> > This last para seems to confirm the first version because otherwise I
> > could just place the file into content rather than writing an
> > exclusion rule.
> 
> > Thanks for making that clear.

What FOR-470 is really about is needing someone to revise
the self-documenting samples in the "seed" site. That would
soon find out which methods work. Then clarify the upgrading_07
doc.

Sorry, if i am going to try and explain it then i would rather
go and do the job myself, because, like you i do not fully
understand the ramifications of changing the behaviour from
0.6 version. The only way is to go and fix the seed site.

--David

Re: Raw and process content directories

[Ferdinand Soethe <sa...@soethe.net>]

Maybe this has gotten lost in all the mail delays. Can anybody pls
comment so that I can close FOR-470.

Thanks,
Ferdinand Soethe


I wrote:


> Just to make sure I have this right before I rewrite any more
> documentation:

> In /docs/upgrading_07.html#raw I found:

>> In 0.6 version, the raw content was placed in the
>> src/documentation/content/ directory and potential sub-directories.
>> In the generated site, these links would automatically function. Any
>> linked file with .html extension was not processed and not adorned
>> with Forrest skin and navigation menus.

>> In 0.7 version, any file that is linked to, needs to be placed in
>> the content/xdocs/ directory structure. Any linked file with .html
>> extension is now processed and is adorned with Forrest skin and
>> navigation menus.

>> If you need to include files that are not linked to, then place them
>> in the src/documentation/content/ directories as with the 0.6
>> version.



> So does

>  "any file that is linked to, needs to be placed in
>   the content/xdocs/"

> really mean that I will get an error if I place
> a file that is linked to in the content-directory.

> Or does it mean "can now be placed in either xdocs or content
> directory at my disgression" depending on wether I want processing to
> happen or not.

>> If you need to link to html files but want them to be un-processed,
>> then place them in the src/documentation/content/ directories and
>> add an entry to conf/cli.xconf to exclude them from processing. An
>> FAQ describes the use of Cocoon's cli.xconf

> This last para seems to confirm the first version because otherwise I
> could just place the file into content rather than writing an
> exclusion rule.

> Thanks for making that clear.