You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by sebb <se...@gmail.com> on 2011/02/07 19:11:44 UTC
Changing the site footer
Turns out that it's easy to update the default-site.vm template to add
the required footer - either as fixed text, or as text that can be
passed in as a property.
Unfortunately, as soon as one uses a custom site template, the site
plugin assumes that one will provide all the images and CSS files -
none of the defaults are copied across. This is also easy to fix -
just add the missing files to the resources directory.
However, this only works for the HC Parent Pom, as the site.vm is
loaded relative to the parent project folder.
I also looked at creating a background image instead, but there is a
lot of text, and it would be hard to make it look OK except at
specific screen resolution and browser window size. Although easy to
use, I think that's a non-starter.
So it looks like the best solution is to create a Maven Skin project
and install the jar which can then be used in all the HC projects.
(Same as was done for the notice plugin).
I propose to start on that shortly (I've done a lot of the work
already whilst investigating how to update the footer).
S.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Re: Changing the site footer
Posted by sebb <se...@gmail.com>.
On 8 February 2011 13:18, Oleg Kalnichevski <ol...@apache.org> wrote:
> On Tue, 2011-02-08 at 03:03 +0000, sebb wrote:
> ...
>
>> >
>> > Thanks for working on this Sebastian! Looks good.. I can imagine many other
>> > projects would be finding it difficult to get this done too. Maybe you could
>> > share a few details with other pmcs' too
>>
>> I was planning on mentioning it to Commons at least, once any bugs are
>> ironed out.
>> I've not yet removed the duplicates of the CSS and images from the
>> parent project - this may cause issues.
>> [If so, we can just keep the duplicates and document the need to keep
>> them in step]
>>
>> It looks like each TLP will need to create their own skin in order to
>> have the correct logo etc.
>>
>> Unless we can keep the local customisations in project, and the
>> standard stuff in the skin - I've not tried that yet.
>> I may try tomorrow.
>>
>> The proper solution would be for the default stylesheet to be updated
>> to allow more customisation (I've raised a JIRA for this) but I
>> suspect that will take too long.
>
> Looks good to me.
>
> Maven and its site plugin especially have historically been a major pain
> in the rectum for non-trivial tasks. It might be time to start
> considering alternatives.
I agree it's a pain, IMO mainly because the Maven documentation is lacking.
Large areas of built-in processing are not documented at all - for
example the site.xml <custom> tag is only mentioned in passing.
And there is broken functionality that is not fixed, just worked round
(e.g. DOXIA-150)
However, I think I've got the custom template working better now.
I've changed it to use the <custom> tag in site.xml, so we can just add:
<custom>
<footer>
<div class="xleft">Apache HttpComponents, Commons HttpClient,
Apache, the Apache feather logo, and the Apache HttpComponents project
logo are trademarks of The Apache Software Foundation.</div>
<br/>
<div class="xleft">All other marks mentioned may be trademarks
or registered trademarks of their respective owners.</div>
</footer>
</custom>
and have the HTML added to the footer just before the copyright.
Also, it seems that using a custom skin does not override the custom
CSS and images, so the skin can be generic.
I'll be uploading a new version soon.
> Oleg
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Re: Changing the site footer
Posted by Oleg Kalnichevski <ol...@apache.org>.
On Tue, 2011-02-08 at 03:03 +0000, sebb wrote:
...
> >
> > Thanks for working on this Sebastian! Looks good.. I can imagine many other
> > projects would be finding it difficult to get this done too. Maybe you could
> > share a few details with other pmcs' too
>
> I was planning on mentioning it to Commons at least, once any bugs are
> ironed out.
> I've not yet removed the duplicates of the CSS and images from the
> parent project - this may cause issues.
> [If so, we can just keep the duplicates and document the need to keep
> them in step]
>
> It looks like each TLP will need to create their own skin in order to
> have the correct logo etc.
>
> Unless we can keep the local customisations in project, and the
> standard stuff in the skin - I've not tried that yet.
> I may try tomorrow.
>
> The proper solution would be for the default stylesheet to be updated
> to allow more customisation (I've raised a JIRA for this) but I
> suspect that will take too long.
Looks good to me.
Maven and its site plugin especially have historically been a major pain
in the rectum for non-trivial tasks. It might be time to start
considering alternatives.
Oleg
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Re: Changing the site footer
Posted by sebb <se...@gmail.com>.
On 8 February 2011 02:41, Asankha C. Perera <as...@apache.org> wrote:
> On 02/08/2011 03:52 AM, sebb wrote:
>>>>
>>>> So it looks like the best solution is to create a Maven Skin project
>>>> and install the jar which can then be used in all the HC projects.
>>>> (Same as was done for the notice plugin).
>>>>
>>>> I propose to start on that shortly (I've done a lot of the work
>>>> already whilst investigating how to update the footer).
>>>>
>>> +1
>>>
>>> Many thanks for taking care of that.
>>
>> OK, no problem.
>>
>> I think it's working OK now.
>>
>> I've uploaded to the snapshot repo, so if anyone wants to test they
>> should be able to do so.
>>
>> There's a sample of the HC front page here:
>>
>> http://people.apache.org/~sebb/stagingSite/
>>
>> None of the module links work as I only created the top-level site (mvn
>> -N)
>>
>> If people are happy with it, then I can start a vote to release the skin.
>
> Thanks for working on this Sebastian! Looks good.. I can imagine many other
> projects would be finding it difficult to get this done too. Maybe you could
> share a few details with other pmcs' too
I was planning on mentioning it to Commons at least, once any bugs are
ironed out.
I've not yet removed the duplicates of the CSS and images from the
parent project - this may cause issues.
[If so, we can just keep the duplicates and document the need to keep
them in step]
It looks like each TLP will need to create their own skin in order to
have the correct logo etc.
Unless we can keep the local customisations in project, and the
standard stuff in the skin - I've not tried that yet.
I may try tomorrow.
The proper solution would be for the default stylesheet to be updated
to allow more customisation (I've raised a JIRA for this) but I
suspect that will take too long.
> cheers
> asankha
>
> --
> Asankha C. Perera
> AdroitLogic, http://adroitlogic.org
>
> http://esbmagic.blogspot.com
>
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Re: Changing the site footer
Posted by "Asankha C. Perera" <as...@apache.org>.
On 02/08/2011 03:52 AM, sebb wrote:
>>> So it looks like the best solution is to create a Maven Skin project
>>> and install the jar which can then be used in all the HC projects.
>>> (Same as was done for the notice plugin).
>>>
>>> I propose to start on that shortly (I've done a lot of the work
>>> already whilst investigating how to update the footer).
>>>
>> +1
>>
>> Many thanks for taking care of that.
> OK, no problem.
>
> I think it's working OK now.
>
> I've uploaded to the snapshot repo, so if anyone wants to test they
> should be able to do so.
>
> There's a sample of the HC front page here:
>
> http://people.apache.org/~sebb/stagingSite/
>
> None of the module links work as I only created the top-level site (mvn -N)
>
> If people are happy with it, then I can start a vote to release the skin.
Thanks for working on this Sebastian! Looks good.. I can imagine many
other projects would be finding it difficult to get this done too. Maybe
you could share a few details with other pmcs' too
cheers
asankha
--
Asankha C. Perera
AdroitLogic, http://adroitlogic.org
http://esbmagic.blogspot.com
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Re: Changing the site footer
Posted by sebb <se...@gmail.com>.
On 7 February 2011 20:08, Oleg Kalnichevski <ol...@apache.org> wrote:
> On Mon, 2011-02-07 at 18:11 +0000, sebb wrote:
>> Turns out that it's easy to update the default-site.vm template to add
>> the required footer - either as fixed text, or as text that can be
>> passed in as a property.
>> Unfortunately, as soon as one uses a custom site template, the site
>> plugin assumes that one will provide all the images and CSS files -
>> none of the defaults are copied across. This is also easy to fix -
>> just add the missing files to the resources directory.
>>
>> However, this only works for the HC Parent Pom, as the site.vm is
>> loaded relative to the parent project folder.
>>
>> I also looked at creating a background image instead, but there is a
>> lot of text, and it would be hard to make it look OK except at
>> specific screen resolution and browser window size. Although easy to
>> use, I think that's a non-starter.
>>
>> So it looks like the best solution is to create a Maven Skin project
>> and install the jar which can then be used in all the HC projects.
>> (Same as was done for the notice plugin).
>>
>> I propose to start on that shortly (I've done a lot of the work
>> already whilst investigating how to update the footer).
>>
>
> +1
>
> Many thanks for taking care of that.
OK, no problem.
I think it's working OK now.
I've uploaded to the snapshot repo, so if anyone wants to test they
should be able to do so.
There's a sample of the HC front page here:
http://people.apache.org/~sebb/stagingSite/
None of the module links work as I only created the top-level site (mvn -N)
If people are happy with it, then I can start a vote to release the skin.
> Oleg
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Re: Changing the site footer
Posted by Oleg Kalnichevski <ol...@apache.org>.
On Mon, 2011-02-07 at 18:11 +0000, sebb wrote:
> Turns out that it's easy to update the default-site.vm template to add
> the required footer - either as fixed text, or as text that can be
> passed in as a property.
> Unfortunately, as soon as one uses a custom site template, the site
> plugin assumes that one will provide all the images and CSS files -
> none of the defaults are copied across. This is also easy to fix -
> just add the missing files to the resources directory.
>
> However, this only works for the HC Parent Pom, as the site.vm is
> loaded relative to the parent project folder.
>
> I also looked at creating a background image instead, but there is a
> lot of text, and it would be hard to make it look OK except at
> specific screen resolution and browser window size. Although easy to
> use, I think that's a non-starter.
>
> So it looks like the best solution is to create a Maven Skin project
> and install the jar which can then be used in all the HC projects.
> (Same as was done for the notice plugin).
>
> I propose to start on that shortly (I've done a lot of the work
> already whilst investigating how to update the footer).
>
+1
Many thanks for taking care of that.
Oleg
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org