directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From oer...@apache.org
Subject svn commit: r497896 - /directory/sandbox/oersoy/collaboration.platform.documentation/cookbook.apt
Date Fri, 19 Jan 2007 18:29:25 GMT
Author: oersoy
Date: Fri Jan 19 10:29:24 2007
New Revision: 497896

URL: http://svn.apache.org/viewvc?view=rev&rev=497896
Log: (empty)

Added:
    directory/sandbox/oersoy/collaboration.platform.documentation/cookbook.apt

Added: directory/sandbox/oersoy/collaboration.platform.documentation/cookbook.apt
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/collaboration.platform.documentation/cookbook.apt?view=auto&rev=497896
==============================================================================
--- directory/sandbox/oersoy/collaboration.platform.documentation/cookbook.apt (added)
+++ directory/sandbox/oersoy/collaboration.platform.documentation/cookbook.apt Fri Jan 19
10:29:24 2007
@@ -0,0 +1,140 @@
+
+
+
+
+
+
+
+
+Challenge
+
+     Understanding the benefits of using the eclipse help system
+     for our documentation effort.
+
+Solution
+
+     TODO Fix later.
+     See: 
+     http://directory.apache.org/documentation/collaboration/documentation/benefits
+
+Discussion
+
+     - Simple navigation.
+     - Makes sense with respect to the LDAP Studio eclipse plugin.
+     - Ability to check out, update and resubmit content, structure, and formatting documents.
+     - Separation of content and format
+     - CSS controlled styling.
+     - Separation of content and structure.
+     - XML descriptors for structure documents.
+     - Ability to work on documentation in tool of choice.
+     - Ability to work in personally chosen microformat.
+     - Subversioned documentation.
+     - Quick contribution of individual document to apacheds.
+     - Simplified content management.
+     - Better documentation visibility.
+     - Integrated lucene based searching.
+     - Rapid recreation of documentation in other formats.
+     - One common model for all microformatted documents.
+     - Open source documentation platform for rapid introduction of new documentation capabilities.
+     - Project centric documentation location.
+     - Zero effort with integration of apache documentation into eclipse.
+
+Challenge
+
+     Running the eclipse help server.
+
+Solution
+
+     See:
+     http://www-128.ibm.com/developerworks/opensource/library/os-eclipsehelp/
+
+Discussion
+
+     The Eclipse Help Center runs standalone, with an integrated
+     web server.
+     
+     Here's a quick httpd.conf sample borrowed from the 
+     above URL on how to forward requests to the eclipse help center:     
+-----------------------------------------------------------------------------
+LoadModule proxy_module modules/ApacheModuleProxy.dll
+ProxyPass /eclipsehelprepo http://internalhelpserver:8081/help 
+ProxyPassReverse /eclipsehelprepo http://internalhelpserver:8081/help
+-----------------------------------------------------------------------------
+
+
+Challenge
+
+     Creating an eclipse help system documentation plugin.
+
+Solution
+
+     See:
+     http://www.eclipse.org/articles/Article-Online%20Help%20for%202_0/help1.htm
+     http://www-128.ibm.com/developerworks/opensource/library/os-eclipsehelp/
+
+
+
+
+Challenge
+
+     Creating an eclipse help system plugin manifest file.
+
+Solution
+
+     See:
+     http://www.eclipse.org/articles/Article-Online%20Help%20for%202_0/help1.htm
+     http://www-128.ibm.com/developerworks/opensource/library/os-eclipsehelp/
+
+
+
+
+
+Challenge
+
+     Creating the document table of contents.
+
+Solution
+
+     See:
+     http://www.eclipse.org/articles/Article-Online%20Help%20for%202_0/help1.htm
+     http://www-128.ibm.com/developerworks/opensource/library/os-eclipsehelp/
+
+
+
+
+Challenge
+
+     Choosing a supported microformat.
+
+Solution
+
+     TODO Fix later.
+     See:
+     http://directory.apache.org/microformats
+
+
+
+
+Challenge
+
+     Creating a documentation structure.
+     
+
+
+Solution
+
+     See:
+     http://www.eclipse.org/articles/Article-Online%20Help%20for%202_0/help1.htm
+     http://www-128.ibm.com/developerworks/opensource/library/os-eclipsehelp/
+     
+     
+
+Challenge
+
+     
+     
+Solution
+
+     
+     
+



Mime
View raw message