You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by Felix Knecht <fe...@otego.com> on 2008/10/02 21:41:44 UTC

Corporate Layout for Studio documentation?

Hi all

I fiddled about using customized skins for maven site generation for the studio documentation to see how it could look
alike using the same layout as the project page.

Here's the result [1].
I know it's not everything working perfect and some large tables on the right of the navigation can screw up the layout.
The question is just:
Do you think it's worth to have such a Corporate Layout throughout all the documentation we produce (project site and
maven docs) and investigate some more time in it to make it perfect or is it just a waist of time?

WDOT?

Regards
Felix

[1] http://people.apache.org/~felixk/studio/

Re: Corporate Layout for Studio documentation?

Posted by Pierre-Arnaud Marcelot <pa...@marcelot.net>.
Thanks, I'll give it a try ;)

Pierre-Arnaud

On Fri, Oct 3, 2008 at 9:34 AM, Felix Knecht <fe...@apache.org> wrote:

> Pierre-Arnaud Marcelot schrieb:
> >
> > I'm curious to know how you integrate it in the build. Any hints on that
> ?
>
> That's easy.
> - Checkout and install locally the studio-skin from my sandbox.
> - Apply patch below and run mvn site-deploy -Pintegration-tests and you
> get the page generated in /tmp/projects/studio (on a linux machine and
> being able to do 'ssh localhost')
>
> HTH
> Felix
>
>
> Index: src/site/site.xml
> ===================================================================
> --- src/site/site.xml   (Revision 701205)
> +++ src/site/site.xml   (Arbeitskopie)
> @@ -19,13 +19,14 @@
>   @author <a href="mailto:dev@directory.apache.org">Apache Directory
> Project</a>
>  -->
>  <project name="${project.name}">
> -  <bannerLeft>
> -    <src>images/studio-icon_128x128.png</src>
> -    <href>http://directory.apache.org/studio/</href>
> -    <name>${project.name}</name>
> -  </bannerLeft>
> -  <publishDate position="navigation-bottom" format="dd-MM-yyyy HH:mm"/>
> -  <version position="right"/>
> +
> +  <skin>
> +    <groupId>org.apache.directory.skins</groupId>
> +    <artifactId>studio-skin</artifactId>
> +    <version>1.0.0-SNAPSHOT</version>
> +  </skin>
> +  <publishDate position="bottom" format="dd-MM-yyyy HH:mm"/>
> +  <version position="bottom"/>
>   <body>
>     <breadcrumbs>
>       <item name="Apache Directory Studio"
> href="http://vm094.oxylos.org/projects/studio/" />
> @@ -40,7 +41,6 @@
>        <item name="Apache Directory Studio"
> href="http://directory.apache%2eorg/studio/"/>
>        <item name="Apache Directory"
> href="http://directory.apache%2eorg/"/>
>        <item name="Apache" href="http://www.apache%2eorg/"/>
> -       <item name="Maven" href="http://maven.apache%2eorg/"/>
>     </links>
>     <menu ref="reports"/>
>     <menu ref="modules"/>
> Index: pom.xml
> ===================================================================
> --- pom.xml     (Revision 701205)
> +++ pom.xml     (Arbeitskopie)
> @@ -52,7 +52,7 @@
>   <distributionManagement>
>     <site>
>       <id>apache.directory.studio</id>
> -      <url>scpexe://vm094.oxylos.org/var/www/html/projects/studio/</url>
> +      <url>scpexe://localhost/tmp/projects/studio/</url>
>     </site>
>   </distributionManagement>
>
>

Re: Corporate Layout for Studio documentation?

Posted by Felix Knecht <fe...@apache.org>.
Pierre-Arnaud Marcelot schrieb:
>
> I'm curious to know how you integrate it in the build. Any hints on that ?

That's easy.
- Checkout and install locally the studio-skin from my sandbox.
- Apply patch below and run mvn site-deploy -Pintegration-tests and you
get the page generated in /tmp/projects/studio (on a linux machine and
being able to do 'ssh localhost')

HTH
Felix


Index: src/site/site.xml
===================================================================
--- src/site/site.xml   (Revision 701205)
+++ src/site/site.xml   (Arbeitskopie)
@@ -19,13 +19,14 @@
   @author <a href="mailto:dev@directory.apache.org">Apache Directory
Project</a>
 -->
 <project name="${project.name}">
-  <bannerLeft>
-    <src>images/studio-icon_128x128.png</src>
-    <href>http://directory.apache.org/studio/</href>
-    <name>${project.name}</name>
-  </bannerLeft>
-  <publishDate position="navigation-bottom" format="dd-MM-yyyy HH:mm"/>
-  <version position="right"/>
+
+  <skin>
+    <groupId>org.apache.directory.skins</groupId>
+    <artifactId>studio-skin</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+  </skin>
+  <publishDate position="bottom" format="dd-MM-yyyy HH:mm"/>
+  <version position="bottom"/>
   <body>
     <breadcrumbs>
       <item name="Apache Directory Studio"
href="http://vm094.oxylos.org/projects/studio/" />
@@ -40,7 +41,6 @@
        <item name="Apache Directory Studio"
href="http://directory.apache%2eorg/studio/"/>
        <item name="Apache Directory"
href="http://directory.apache%2eorg/"/>
        <item name="Apache" href="http://www.apache%2eorg/"/>
-       <item name="Maven" href="http://maven.apache%2eorg/"/>
     </links>
     <menu ref="reports"/>
     <menu ref="modules"/>
Index: pom.xml
===================================================================
--- pom.xml     (Revision 701205)
+++ pom.xml     (Arbeitskopie)
@@ -52,7 +52,7 @@
   <distributionManagement>
     <site>
       <id>apache.directory.studio</id>
-      <url>scpexe://vm094.oxylos.org/var/www/html/projects/studio/</url>
+      <url>scpexe://localhost/tmp/projects/studio/</url>
     </site>
   </distributionManagement>


Re: Corporate Layout for Studio documentation?

Posted by Pierre-Arnaud Marcelot <pa...@marcelot.net>.
On Thu, Oct 2, 2008 at 9:41 PM, Felix Knecht <fe...@otego.com> wrote:

> Hi all


Hi Felix,


> I fiddled about using customized skins for maven site generation for the
> studio documentation to see how it could look
> alike using the same layout as the project page.


I saw your commits these last days on your sandbox, and was wondering what
this skin project was about.
I was thinking to a skin for the Studio RCP app or a skin for the generated
Maven website.
It was the second option.


> Here's the result [1].
> I know it's not everything working perfect and some large tables on the
> right of the navigation can screw up the layout.
>

This looks great, even if it's not perfect yet.
It looks way better than the standard Maven template.
Everything seems more integrated to the project with this one.


> The question is just:
> Do you think it's worth to have such a Corporate Layout throughout all the
> documentation we produce (project site and
> maven docs) and investigate some more time in it to make it perfect or is
> it just a waist of time?
>
> WDOT?


I think this is a more integrated solution.
Having the same look between the usual website and these generated docs is
great.
I really like the idea.

I'm curious to know how you integrate it in the build. Any hints on that ?

Thanks,
Pierre-Arnaud