You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by rg...@apache.org on 2005/09/01 04:49:33 UTC
svn commit: r265634 - in /cocoon/gsoc/rgraham/refdoc: README.TXT STATUS
samples/index.html slop block with doktor comments.zip
Author: rgraham
Date: Wed Aug 31 19:49:03 2005
New Revision: 265634
URL: http://svn.apache.org/viewcvs?rev=265634&view=rev
Log:
Wrote the README and STATUS files.
Added the slop block zip that has it with its commented version that may be worth looking at. Though the comments in it do not necessarily reflect the direction the system took.
Updated index.html to have info about Lucene indexing and configuration as well as links to the published docs.
Added:
cocoon/gsoc/rgraham/refdoc/STATUS
cocoon/gsoc/rgraham/refdoc/slop block with doktor comments.zip (with props)
Modified:
cocoon/gsoc/rgraham/refdoc/README.TXT
cocoon/gsoc/rgraham/refdoc/samples/index.html
Modified: cocoon/gsoc/rgraham/refdoc/README.TXT
URL: http://svn.apache.org/viewcvs/cocoon/gsoc/rgraham/refdoc/README.TXT?rev=265634&r1=265633&r2=265634&view=diff
==============================================================================
--- cocoon/gsoc/rgraham/refdoc/README.TXT (original)
+++ cocoon/gsoc/rgraham/refdoc/README.TXT Wed Aug 31 19:49:03 2005
@@ -1,3 +1,14 @@
+This is a short readme because almost everything is explained by visting
+the index.html for <Cocoon>/samples/blocks/refdoc/
+
+There you can see the results for the various stages of the processing up to
+the final product. Between this and the sitemap itself in <cocoon-refdoc>/snippets/
+everything is pretty clear. I don't have a lot of "code" so much as xsl files and pipelines to play with
+which are explained in the doktor-usage doc that is off of that index.html.
+
+I did refactor and improve on the DoktorMetadataTransformer which needs to be compiled
+into Cocoon, however. The old readme explains this:
+
How to run the refdoc block under Cocoon 2.2
--------------------------------------------
Added: cocoon/gsoc/rgraham/refdoc/STATUS
URL: http://svn.apache.org/viewcvs/cocoon/gsoc/rgraham/refdoc/STATUS?rev=265634&view=auto
==============================================================================
--- cocoon/gsoc/rgraham/refdoc/STATUS (added)
+++ cocoon/gsoc/rgraham/refdoc/STATUS Wed Aug 31 19:49:03 2005
@@ -0,0 +1,26 @@
+Doktor has moved forward a whole lot this summer. But is isn't ready for live deployment just yet.
+
+Doktor can take a set of files with comments and create snippets that are indexed. These
+are then searchable by their 'key' values and expressed in terms of other metadata fields. [1]
+Afterward when you search for a specific key [2] these snippets for that key are grouped together and
+sorted according to some semantics for publishing to a presentation format. This can then be published
+however is desired. Currently a few files are setup in the pipeline to be published by an XSLT file which
+will process any file, but may not yeild the desired results for your publishing needs. [3]
+
+Broken things that I'm aware of:
+
+Currently the @doktor-whatever stays in the content field of snippet which is probably not
+desired behavior. Such markup should be removed in the processing stage.
+
+
+Things that need work:
+
+[1] It may be that it would be useful to change the meaning of the fields I decided to use or
+even to develop a new set, but I think that whatever happens there it needs a standard.
+
+[3] Also, doktor needs to be able to return something when you aren't searching for a key and in the future
+deal with assembling those documents on the fly.
+
+[2] The publishing needs to come a long way to something more sophisticated (it is just file specific XSLT now),
+reusable, and powerful that can handle a dynamic version of Doktor.
+
Modified: cocoon/gsoc/rgraham/refdoc/samples/index.html
URL: http://svn.apache.org/viewcvs/cocoon/gsoc/rgraham/refdoc/samples/index.html?rev=265634&r1=265633&r2=265634&view=diff
==============================================================================
--- cocoon/gsoc/rgraham/refdoc/samples/index.html (original)
+++ cocoon/gsoc/rgraham/refdoc/samples/index.html Wed Aug 31 19:49:03 2005
@@ -93,7 +93,6 @@
</ul>
<h2>Indexing, Searching, and Neutral Documents</h2>
- (see patch-README.txt for how to create the index)
<ul>
<li>
<a href="snippets/searchQuery/firstExample">Try to search our index for "firstExample"</a>
@@ -101,16 +100,25 @@
<li>
<a href="snippets/searchQuery/firstExample/neutraldoc">Neutral Document Generated from searchQuery for "firstExample"</a>
</li>
-
- </ul>
-
- <p>
- <a href="slop.html">Extended Examples with SLOP block</a>
- </p>
+ <li>
+ <a href="snippets/searchQuery/doktor-usage/neutraldoc/publish">Published Doktor-Usage key</a>
+ </li>
+ <li>
+ <a href="snippets/searchQuery/doktor-future/neutraldoc/publish">Published Doktor-Future key</a>
+ </li>
+ <li>
+ <a href="snippets/searchQuery/doktor-about/neutraldoc/publish">Published Doktor-About key</a>
+ </li>
+ </ul>
+ <h2>Indexing Documents</h2>
+ <p>Head to: site-path/samples/blocks/lucene/create
+
+Create an index (with the below configuration) on
+ site-path/samples/blocks/refdoc/snippets/samples/</p>
<h2>Configuring Lucene Block Index</h2>
- Put this is you web-inf/xconf/cocoon-lucene.xconf file:
+ Put this is your web-inf/xconf/cocoon-lucene.xconf file:
<pre><lucene-xml-indexer logger="core.search.lucene">
<index-fields>snippet_id, metadata, content</index-fields>
<store-fields>snippet_id, metadata, content, filename, key, type, name, filetype</store-fields>
Added: cocoon/gsoc/rgraham/refdoc/slop block with doktor comments.zip
URL: http://svn.apache.org/viewcvs/cocoon/gsoc/rgraham/refdoc/slop%20block%20with%20doktor%20comments.zip?rev=265634&view=auto
==============================================================================
Binary file - no diff available.
Propchange: cocoon/gsoc/rgraham/refdoc/slop block with doktor comments.zip
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream