| <?xml version="1.0" encoding="UTF-8"?> |
| <document> |
| <properties> |
| <author email="akarasulu@apache.org">Alex Karasulu</author> |
| <title>Apache Directory Project: </title> |
| </properties> |
| |
| <body> |
| <section name="Links Howto"> |
| <p> |
| All links to documents within the same subproject are relative to that |
| subproject. Links to resources outside the subproject must take into |
| account the relative position of the target directory the subproject's |
| generated content is copied into. |
| </p> |
| |
| <p> |
| For example the 'directory' link in the sitedocs project is simply |
| '/index.html'. The same 'directory' line in the Eve subproject will |
| be '../../index.html'. This is because the Eve project's generated |
| content ultimately resides two directories deep with the sitedocs |
| project's document root here: './subprojects/eve'. It takes a |
| '../../' to get to the index.html that is the home page for the TLP |
| site. |
| </p> |
| |
| <p> |
| Links to Apache, Directory, Eve, LDAP, Naming, Janus, Snickers and |
| Sitedocs must be maintained by all subprojects to keep the overall |
| site consistant. |
| </p> |
| </section> |
| |
| <section name="Navigations"> |
| <p> |
| Maintaining a consistant look and feel means perserving the top level |
| site's menus. To do this you'll need to work with the same navigation |
| and this requires the following navigation.xml template: |
| </p> |
| |
| <source> |
| <?xml version="1.0" encoding="UTF-8"?> |
| |
| <project> |
| |
| <title>Apache Directory Project</title> |
| |
| <body> |
| |
| <links> |
| <item name="Apache" href="http://apache.org/"/> |
| <item name="Directory" href="../../index.html"/> |
| <item name="Server" href="/index.html"/> |
| <item name="LDAP" href="../ldap/index.html"/> |
| <item name="Naming" href="../naming/index.html"/> |
| <item name="AuthX" href="../authx/index.html"/> |
| <item name="ASN1" href="../asn1/index.html"/> |
| <item name="Sitedocs" href="../sitedocs/index.html"/> |
| </links> |
| |
| <menu name="About Directory"> |
| <item name="Overview" href="../../index.html"/> |
| <item name="Community" href="../../community/index.html"/> |
| <item name="Latest News" href="../../news.html"/> |
| <item name="Subprojects" href="../../subprojects/index.html"> |
| <item name="Server" href="/index.html"/> |
| <item name="LDAP" href="../ldap/index.html"/> |
| <item name="AuthX" href="../authx/index.html"/> |
| <item name="Naming" href="../naming/index.html"/> |
| <item name="ASN1" href="../asn1/index.html"/> |
| <item name="Sitedocs" href="../sitedocs/index.html"/> |
| </item> |
| <item name="Documentation" href="../../doc/index.html"/> |
| </menu> |
| |
| <menu name="Resources"> |
| <item name="IRC" href="../../irc.html"/> |
| <item name="Jira" href= |
| "http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10400"/> |
| <item name="Wiki" href="http://wiki.apache.org/directory"/> |
| <item name="Lists" href="../../mailing-lists.html"/> |
| <item name="License" href="../../license.html"/> |
| <item name="Sandbox" href="../../sandbox/index.html"/> |
| <item name="Downloads" href="../../download.cgi"/> |
| <item name="Subversion" href="../../svn.html"/> |
| <item name="Related Projects" href="../../related/index.html"/> |
| </menu> |
| |
| </body> |
| |
| </project> |
| </source> |
| |
| <p> |
| You can download this navigation template from |
| <a href="./nav-template.txt">here</a>. Remember you take this |
| template and expand one of the subproject nodes to the number and kind |
| of subitems of your choosing by breaking up into a two part tag and |
| embedding more items within. For example this is how the Eve |
| subproject site navigation is structured: |
| </p> |
| |
| <source> |
| <item name="Eve" href="/index.html"> |
| <item name="Design" href="/design/index.html"/> |
| <item name="Features" href="/features.html"/> |
| <item name="Backend" href="/backend/index.html"/> |
| <item name="Frontend" href="/frontend/index.html"/> |
| </item> |
| </source> |
| </section> |
| |
| <section name="Links"> |
| <p> |
| Check out the section talking about links. All we do here is let you |
| know that you have to keep in mind the distance between the TLP site |
| documents and your subproject's site in the final deployed state. |
| Basically you have <b>subprojects/[supproject-name]</b> in the way. |
| That means two relative levels up to get to TLP resources while the |
| resources local to the project are still accessed as relative |
| resources. |
| </p> |
| |
| <p> |
| If you have questions just take a look at the links section and the |
| links in the navigation template above. If you still have questions |
| use trial and error until you develope a feel for it. Just generate |
| the document and see if it works locally by pointing a browser to it. |
| If you still need help post to the list. |
| </p> |
| </section> |
| </body> |
| </document> |
