From d95e4291fe90d5d37051c94bad83ff80029f8e1d Mon Sep 17 00:00:00 2001 From: erik Date: Sat, 1 Apr 2006 19:22:53 +0000 Subject: [PATCH] Initial version of forrest site for kiss crawler. --- crawler/kiss/docs/README.txt | 7 + .../docs/classes/CatalogManager.properties | 57 +++ crawler/kiss/docs/content/test1.html | 37 ++ crawler/kiss/docs/content/xdocs/hello.pdf | 70 +++ .../docs/content/xdocs/images/group-logo.gif | Bin 0 -> 1092 bytes .../kiss/docs/content/xdocs/images/group.svg | 82 ++++ .../kiss/docs/content/xdocs/images/icon.png | Bin 0 -> 696 bytes .../content/xdocs/images/project-logo.gif | Bin 0 -> 1228 bytes .../docs/content/xdocs/images/project.svg | 82 ++++ .../kiss/docs/content/xdocs/images/usemap.gif | Bin 0 -> 951 bytes crawler/kiss/docs/content/xdocs/index.xml | 49 ++ .../docs/content/xdocs/samples/ascii-art.xml | 56 +++ .../content/xdocs/samples/cocoon-pyramid.aart | 11 + .../docs/content/xdocs/samples/custom.xml | 21 + .../content/xdocs/samples/customSchema.xml | 39 ++ .../content/xdocs/samples/document-v13.xml | 381 +++++++++++++++ .../content/xdocs/samples/embedded_html.html | 111 +++++ .../kiss/docs/content/xdocs/samples/faq.xml | 42 ++ .../docs/content/xdocs/samples/hello-v10.dtd | 49 ++ .../docs/content/xdocs/samples/helloAgain.pdf | 70 +++ .../kiss/docs/content/xdocs/samples/index.xml | 29 ++ .../docs/content/xdocs/samples/linking.xml | 353 ++++++++++++++ .../docs/content/xdocs/samples/sample.xml | 407 ++++++++++++++++ .../docs/content/xdocs/samples/static.xml | 62 +++ .../xdocs/samples/subdir/book-sample.xml | 47 ++ .../content/xdocs/samples/subdir/hello.zip | Bin 0 -> 743 bytes .../content/xdocs/samples/subdir/index.xml | 38 ++ .../docs/content/xdocs/samples/usemap.xml | 61 +++ crawler/kiss/docs/content/xdocs/site.xml | 103 ++++ crawler/kiss/docs/content/xdocs/tabs.xml | 51 ++ .../kiss/docs/resources/schema/catalog.xcat | 29 ++ .../kiss/docs/resources/schema/hello-v10.dtd | 51 ++ .../resources/stylesheets/hello2document.xsl | 39 ++ crawler/kiss/docs/sitemap.xmap | 72 +++ crawler/kiss/docs/skinconf.xml | 441 ++++++++++++++++++ crawler/kiss/docs/translations/langcode.xml | 26 ++ .../kiss/docs/translations/languages_en.xml | 22 + .../kiss/docs/translations/languages_es.xml | 22 + crawler/kiss/docs/translations/menu.xml | 33 ++ crawler/kiss/docs/translations/menu_af.xml | 33 ++ crawler/kiss/docs/translations/menu_de.xml | 33 ++ crawler/kiss/docs/translations/menu_es.xml | 33 ++ crawler/kiss/docs/translations/menu_it.xml | 33 ++ crawler/kiss/docs/translations/menu_no.xml | 33 ++ crawler/kiss/docs/translations/menu_ru.xml | 33 ++ crawler/kiss/docs/translations/menu_sk.xml | 33 ++ crawler/kiss/docs/translations/tabs.xml | 22 + crawler/kiss/docs/translations/tabs_es.xml | 22 + 48 files changed, 3325 insertions(+) create mode 100644 crawler/kiss/docs/README.txt create mode 100644 crawler/kiss/docs/classes/CatalogManager.properties create mode 100644 crawler/kiss/docs/content/test1.html create mode 100644 crawler/kiss/docs/content/xdocs/hello.pdf create mode 100644 crawler/kiss/docs/content/xdocs/images/group-logo.gif create mode 100644 crawler/kiss/docs/content/xdocs/images/group.svg create mode 100644 crawler/kiss/docs/content/xdocs/images/icon.png create mode 100644 crawler/kiss/docs/content/xdocs/images/project-logo.gif create mode 100644 crawler/kiss/docs/content/xdocs/images/project.svg create mode 100644 crawler/kiss/docs/content/xdocs/images/usemap.gif create mode 100644 crawler/kiss/docs/content/xdocs/index.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/ascii-art.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/cocoon-pyramid.aart create mode 100644 crawler/kiss/docs/content/xdocs/samples/custom.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/customSchema.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/document-v13.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/embedded_html.html create mode 100644 crawler/kiss/docs/content/xdocs/samples/faq.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/hello-v10.dtd create mode 100644 crawler/kiss/docs/content/xdocs/samples/helloAgain.pdf create mode 100644 crawler/kiss/docs/content/xdocs/samples/index.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/linking.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/sample.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/static.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/subdir/book-sample.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/subdir/hello.zip create mode 100644 crawler/kiss/docs/content/xdocs/samples/subdir/index.xml create mode 100644 crawler/kiss/docs/content/xdocs/samples/usemap.xml create mode 100644 crawler/kiss/docs/content/xdocs/site.xml create mode 100644 crawler/kiss/docs/content/xdocs/tabs.xml create mode 100644 crawler/kiss/docs/resources/schema/catalog.xcat create mode 100644 crawler/kiss/docs/resources/schema/hello-v10.dtd create mode 100644 crawler/kiss/docs/resources/stylesheets/hello2document.xsl create mode 100644 crawler/kiss/docs/sitemap.xmap create mode 100644 crawler/kiss/docs/skinconf.xml create mode 100644 crawler/kiss/docs/translations/langcode.xml create mode 100644 crawler/kiss/docs/translations/languages_en.xml create mode 100644 crawler/kiss/docs/translations/languages_es.xml create mode 100644 crawler/kiss/docs/translations/menu.xml create mode 100644 crawler/kiss/docs/translations/menu_af.xml create mode 100644 crawler/kiss/docs/translations/menu_de.xml create mode 100644 crawler/kiss/docs/translations/menu_es.xml create mode 100644 crawler/kiss/docs/translations/menu_it.xml create mode 100644 crawler/kiss/docs/translations/menu_no.xml create mode 100644 crawler/kiss/docs/translations/menu_ru.xml create mode 100644 crawler/kiss/docs/translations/menu_sk.xml create mode 100644 crawler/kiss/docs/translations/tabs.xml create mode 100644 crawler/kiss/docs/translations/tabs_es.xml diff --git a/crawler/kiss/docs/README.txt b/crawler/kiss/docs/README.txt new file mode 100644 index 00000000..9bc261b2 --- /dev/null +++ b/crawler/kiss/docs/README.txt @@ -0,0 +1,7 @@ +This is the base documentation directory. + +skinconf.xml # This file customizes Forrest for your project. In it, you + # tell forrest the project name, logo, copyright info, etc + +sitemap.xmap # Optional. This sitemap is consulted before all core sitemaps. + # See http://forrest.apache.org/docs/project-sitemap.html diff --git a/crawler/kiss/docs/classes/CatalogManager.properties b/crawler/kiss/docs/classes/CatalogManager.properties new file mode 100644 index 00000000..af7b5ab3 --- /dev/null +++ b/crawler/kiss/docs/classes/CatalogManager.properties @@ -0,0 +1,57 @@ +# Copyright 2002-2005 The Apache Software Foundation or its licensors, +# as applicable. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +#======================================================================= +# CatalogManager.properties for Catalog Entity Resolver. +# +# This is the default properties file for your project. +# This facilitates local configuration of application-specific catalogs. +# If you have defined any local catalogs, then they will be loaded +# before Forrest's core catalogs. +# +# See the Apache Forrest documentation: +# http://forrest.apache.org/docs/your-project.html +# http://forrest.apache.org/docs/validation.html + +# verbosity: +# The level of messages for status/debug (messages go to standard output). +# The setting here is for your own local catalogs. +# The verbosity of Forrest's core catalogs is controlled via +# main/webapp/WEB-INF/cocoon.xconf +# +# The following messages are provided ... +# 0 = none +# 1 = ? (... not sure yet) +# 2 = 1+, Loading catalog, Resolved public, Resolved system +# 3 = 2+, Catalog does not exist, resolvePublic, resolveSystem +# 10 = 3+, List all catalog entries when loading a catalog +# (Cocoon also logs the "Resolved public" messages.) +verbosity=1 + +# catalogs ... list of additional catalogs to load +# (Note that Apache Forrest will automatically load its own default catalog +# from main/webapp/resources/schema/catalog.xcat) +# Use either full pathnames or relative pathnames. +# pathname separator is always semi-colon (;) regardless of operating system +# directory separator is always slash (/) regardless of operating system +catalogs=../resources/schema/catalog.xcat + +# relative-catalogs +# If false, relative catalog URIs are made absolute with respect to the +# base URI of the CatalogManager.properties file. This setting only +# applies to catalog URIs obtained from the catalogs property in the +# CatalogManager.properties file +# Example: relative-catalogs=[yes|no] +relative-catalogs=no diff --git a/crawler/kiss/docs/content/test1.html b/crawler/kiss/docs/content/test1.html new file mode 100644 index 00000000..1a174a8b --- /dev/null +++ b/crawler/kiss/docs/content/test1.html @@ -0,0 +1,37 @@ + + + + Raw un-processed HTML page (test1) + + +

raw un-processed HTML page (test1)

+

+ This raw HTML page is linked to from xdocs/samples/static.xml + and from xdocs/samples/linking.xml +

+

All linked-to pages (for example: + <a href="test2.html">) are + also available. +

+
+

+ [return to Index]
+ [return to Linking demonstration] +

+ + diff --git a/crawler/kiss/docs/content/xdocs/hello.pdf b/crawler/kiss/docs/content/xdocs/hello.pdf new file mode 100644 index 00000000..5ca4f313 --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/hello.pdf @@ -0,0 +1,70 @@ +%PDF-1.3 +%ª«¬­ +4 0 obj +<< /Type /Info +/Producer (FOP 0.20.4) >> +endobj +5 0 obj +<< /Length 203 /Filter [ /ASCII85Decode /FlateDecode ] + >> +stream +Gar'!]afWZ&;9q-MRA)RFnblL2&]tQSZsjOOT[ck2SQkp(bfQ[R7ZPq=U24c0dqq_i?B[A.0s\)5f5 +endstream +endobj +6 0 obj +<< /Type /Page +/Parent 1 0 R +/MediaBox [ 0 0 595 842 ] +/Resources 3 0 R +/Contents 5 0 R +>> +endobj +7 0 obj +<< /Type /Font +/Subtype /Type1 +/Name /F1 +/BaseFont /Helvetica +/Encoding /WinAnsiEncoding >> +endobj +8 0 obj +<< /Type /Font +/Subtype /Type1 +/Name /F5 +/BaseFont /Times-Roman +/Encoding /WinAnsiEncoding >> +endobj +1 0 obj +<< /Type /Pages +/Count 1 +/Kids [6 0 R ] >> +endobj +2 0 obj +<< /Type /Catalog +/Pages 1 0 R + >> +endobj +3 0 obj +<< +/Font << /F1 7 0 R /F5 8 0 R >> +/ProcSet [ /PDF /ImageC /Text ] >> +endobj +xref +0 9 +0000000000 65535 f +0000000687 00000 n +0000000745 00000 n +0000000795 00000 n +0000000015 00000 n +0000000071 00000 n +0000000365 00000 n +0000000471 00000 n +0000000578 00000 n +trailer +<< +/Size 9 +/Root 2 0 R +/Info 4 0 R +>> +startxref +883 +%%EOF diff --git a/crawler/kiss/docs/content/xdocs/images/group-logo.gif b/crawler/kiss/docs/content/xdocs/images/group-logo.gif new file mode 100644 index 0000000000000000000000000000000000000000..f017f3246633bb6750d4e4505218a2a5c9aeaef9 GIT binary patch literal 1092 zcmV-K1iSl3Nk%w1VcY;g0OJ4vDMe#HMqF!2PJl{BtV}qTOF&ddRoG7|?ocDbPBH)g z|NsC0|NsC0|NsC0|NsC0A^sIZa%Ew3Wn>_CX>@2HRA^-&M@dak04x9i007(oK>z>* z{t(DXtGzhu&Ab0#D2`-lo@lDBZ0o*oEYEap-*~R?eDD9jpm0bm8jr}Na_I^P1_FU5 zFd$e71%oXL)iS@5K;eKW9|{3Nc`cQw*JWuMjyMb~fdqY>@J=Yt@>m7jN9AkA4!ZWu3`DkO$vkm*k>w z>$erZ=M({u1^Bh%;#`0Ok6s;iK@51i@N1r%LL1)r%b>8#zi<}D4OEu_l0$_4HquSJ z;87Y!4v_R&NJ-%nvWL+utkED6qz{c4aOM=qVP-_0o&aV9YRF;+mo|Io92#?HQw=^% zK1IruTvUcalj^96p=5@o8P=$*z!KccNkk`HwZK(tj*18h22EQ5tkaPf;9fjyw;Td{ z6ui34;jSP*h)zF(i`y~l+yi(77p)@~Ksv~Sbu1guj0&BPeMy>8Ij4+Du@nr*+c>&H zy1$us{Bp(Z3IRyPY@Y=HH&v7n z*VXRlHK=IwjrOU8?Fcj&7*FS#21|Pguz%`pejUKzfuP3syT5#6`Wm(M3(4mqKF0qut$J`fmi^aBWQ?OM3#qnSD9*NwmC?32hb?z4q1+O#&5JZ zW+QrzH3H0UX+E;!pEy*hsBi(D6wex2c%r6uE6Vjt0+0exC8l4QLBVUa0mBq#SeX{; zO+kXgYF9u(f?u64?T0}+-@Qshlx^)=#zYm(>YAa&Zjh|6faAsrlVVg+)haU5hGi79 zIYe1yw1&21Xtfwvi0!Y=mdD|-l=5b(u-QGP?7HLL5alPvu2id~`#_Sbs~PYbZ=~h= zg7IDpJ>*KPORc;~J6-hB7% K_uqO)002A6r1(n! literal 0 HcmV?d00001 diff --git a/crawler/kiss/docs/content/xdocs/images/group.svg b/crawler/kiss/docs/content/xdocs/images/group.svg new file mode 100644 index 00000000..584cedb8 --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/images/group.svg @@ -0,0 +1,82 @@ + + + + + + + + Anteater logo + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/crawler/kiss/docs/content/xdocs/images/icon.png b/crawler/kiss/docs/content/xdocs/images/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3be8bbbe65c73bfdd555f521844f5e343d789954 GIT binary patch literal 696 zcmWkqZAepL6h1@Et7fdoSZ1&*k_;oZCCY?8cHPKXt~qU_Mt)2)9X4qrqDhh52x}6= zP=8F4=%PQm!lG3_x|NtqByOoVSK<0Vy!az;1$O_Wr`HG0*TeH1IH%8HKari8n+X8f zwhD`r)LasKs1%Y{T|Ku+De_y-`pYl3HTyffm$bDVU2Sl!S!*z8yV^RmM!nvsH6AWA zmXsBjYK!y+z5e8jBRsLC`)yU$^trUGoVz{WjsolZx*CX)$i8bO1Qj6qCL zi(!gqSr&CV1V9MNpi}|}z&dp-(u52tASNN{hNuQYGzdv5gglQ>kAOZ9;vge1=ydYH zGr*aE6CjQu4%KP|p8|*!g&Zes$!H9R5p;1P013f_p%9YZ?Z#*n!61WF4^b0@LqPTm z7zm)EAj2T=P6#-Gmmz>mKo&(AG&1lsFdUKT7z_q^LuDAqa*rs6;sV8+e6q$TS9(yC z1c6axiZ!sZ9FN6lL|PIhMNulR+g;=%D!2+x zE!7&azFi~ui#N<)>)P{__4i9dIn?IkFB`vmCJM?L#}k8zE6or%zVze9{_qd5asmE}l0uJnY+DGY$jOE7Oiw>h)h4)zt?lxRGdYUNf3Tsa3tlhm`!lz_CX>@2HRA^-&M@dak04x9i007(oK>z>* z{t(DXtGzhu&Ab0#D2`-lo@lDBZ0o*oEYEap-*~R?-BA3zpl~QF9FD}Kaw#$*nb4>d z;5LfdF-d z7jAGMRY!9ON0tW$h8B{O00f)}S``EdmzN2O6=$ZGZyE-brU`Z$0j08^ofJN|2!6k= zkQ1P+mI#^@oCkHWtfCUD#YfK*(Z#_Q1kKkO)~2z@63WHGo6^2Nw+F`+%94Mvt^}uq z0+O`V(w5j1+QxrBS~)rekdrxmmdas}L~T*51Q|FL(4-BYgkBaU_&XA=TNn-gRT}2f zHDTTn1gSJOvmnR7ky(slD!dSK;E|NcE{RlS31`Vz20A>#5WrH#VJ|DVT-Q-T(I*y$ z&g9?(B8H{>s2HVsBxr`GRyattu+%CBOW|TQq!7#JqK{L#F8g|N;j|8IH{{(gw!%YT zz+&M83(}X{zHw=iypT}wTn>#vF2;a(0>WbWDtpkJ80q7)P}@xg9ai#Zk7zPnW|bN4 z2+p0gp04l|f!*1p-LkzY*0lwrF@wiMcE+p-*qy6pz-Df^Bs zdNcsAx}7+WiZ(+$q1$(zY}zjqgu7^-?0(ffs1C}sXrg>F2hW?mTV z5wH|}VDU3RGe?F3+GU{}gphU6tVW+g;*EHTd%y8mi#p$or=5`9Y$J=6 zPMQMca_4+Gm3W@mlLdZ@2&X0o0T__Z4_5Yf0Fo@ZSwI4CqFGWOcoq=nD181wU^!%t z!QLu^auEA z4tTIyzyPn-kmH}9=88j?Tj}bn5Lna^NTI(LI|Q-DCaVLo%KkQM>!ywXgKHdip6P6+ z&{DwbNpwoE;y!Yif{g%LS|aAPP%wMJM*2*2K>+2RByM;51c+`F>RO=TqXNLP4@*4$ zJHY_0F!C)^_okaI!6X_<4ZDCqLnSs6mg?iB2_KuSxpLYz!H7pyfsGR$+jKy!8Pkw& zKI`a3l3MGYS3ys&n3(di&@Q-v&fnE_)poUQ5cJI&i|W~*Lvhv@asWt2bQjRB%yJq^ zZ^yLLPv;=DY)g{W@X!}9cVf%6_?$J=Mkh)3fuF&gjm#9#3?`Omm!Ld( z2?68A?l}p@>x<2yW_x-HsXM2jK3%I~=>T}x3;^fFSUkH7Y8H + + + + + + + Anteater logo + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/crawler/kiss/docs/content/xdocs/images/usemap.gif b/crawler/kiss/docs/content/xdocs/images/usemap.gif new file mode 100644 index 0000000000000000000000000000000000000000..c10732ca6841cdc9e821aec5c64fa3641456a2f0 GIT binary patch literal 951 zcmV;o14#TwNk%w1VE_RD0fYbmDMe%MP$ND@Tx>~AlS@IfO*YL=F5gcm>QE#_M_P$W zM8-}qUPw}~O*d0VRZvG(dP+(E|NsC0|NsC0|NsC0|NsC0|NsC0|NsC0|NsC0|NsC0 z|NsC0|NsC0|NsC0A^sIZa%Ew3Wn>_CX>@2HRA^-&M@dak04x9i0000100966{vaTZ zWNDsgs;+G7zHlthbZy^wuJ3&B|G=PdNGuwU$fR<~Y&xINsB}uLTCdowcFXO0zu>TV zOfH+x=(KvxZoA*`xO`5p+hc*ee$Vgw|A2vl0e6KigNTWWh=z?Si;$6vj+7>nmzaK) znnVg%SqmiMNq^OCel&P(OtB$U+eXxzQw|TXOxVO56ytBS{z_P-2#IDA5$gRqB z%&E?E(5TXK)TGvN*rVET+@IcW;GW`clVh{EGaY z0T@tV8G@<|l0nEw;TVR496p5jN@5s_6)k?j2uLFsj(RNSMaC($ZKk4{OdGz!zEPo6?;B6aGLs#cR=&3a@j z*CJlO4hbtZ2-&h|)2dy|wyoQ@aO29IOSi7wyLj{J-OIPH-@kwZ3m#0ku;Igq6DwZK zxUu8MkRwZ;Ou4e<%a}83-pskP=g*)+iylq7wCU5RQ>$Lhy0z=quw%=fO}n=3+qiS< z-p#wW@87_K3m;Crxbfr2DG3-rpn!n`2m&BDV4whj0Rn_4P_RJJ0tE?rGiZRR0fXEQ z3XCe?z&3$a1ZF?z?rOmU*aM=^LNLHJ1Y!`d_8&3+G}8Ml0>K)FxJI?X}outL?VjcI)l8;D#&i Zxa5{=?z!lutM0n&w(IV@@P-xw06Sf<>M{TT literal 0 HcmV?d00001 diff --git a/crawler/kiss/docs/content/xdocs/index.xml b/crawler/kiss/docs/content/xdocs/index.xml new file mode 100644 index 00000000..26bdd02a --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/index.xml @@ -0,0 +1,49 @@ + + + + +
+ Welcome to MyProj +
+ +
+ Congratulations +

You have successfully generated and rendered an Apache Forrest site. + This page is from the site template. It is found in + src/documentation/content/xdocs/index.xml + Please edit it and replace this text with content of your own.

+
+ +
+ Using examples as templates +

+ This demo site has many examples. See the menu at the left. + The sources for these examples are in the directory + src/documentation/content/xdocs/ +

+

+ The sources for the Apache Forrest website are also included + in your distribution at $FORREST_HOME/site-author/ +

+

You can also extend the functionality of Forrest via + plugins, + these will often come with more samples for you to out.

+
+ + diff --git a/crawler/kiss/docs/content/xdocs/samples/ascii-art.xml b/crawler/kiss/docs/content/xdocs/samples/ascii-art.xml new file mode 100644 index 00000000..4f984d07 --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/ascii-art.xml @@ -0,0 +1,56 @@ + + + + +
+ Ascii Art sample +
+ +
+ Sample Ascii Art +

To create a .png image like the one below with ASCII art, just save + the text file with the .aart extension and then link from any page + as an image (<image src="asci-art-file.png"/>).

+

cocoon pyramid of management-(logic-content-style)

+

Here is the source file that has created the above image.

+ + + +-------------------+ + | Management | + +-+-------+-------+-+ + | | | + | | | + +-------+ +----+----+ +-------+ + | logic +--+ content +--+ style | + +-------+ +---------+ +-------+ + + +

An ascii art pad recognized following ascii characters:

+
    +
  • '-' horizontal SVG line
    • +
  • '|' vertical SVG line
    • +
  • '+' corner
    • +
  • \ oblique line
    • +
  • String starting with letter, digit, or '_' is converted to a SVG text.
    • +
+
+ +
+ Copyright 2002-2004 The Apache Software Foundation or its licensors, as applicable. +
+ diff --git a/crawler/kiss/docs/content/xdocs/samples/cocoon-pyramid.aart b/crawler/kiss/docs/content/xdocs/samples/cocoon-pyramid.aart new file mode 100644 index 00000000..090a0e0e --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/cocoon-pyramid.aart @@ -0,0 +1,11 @@ + + +-------------------+ + | Management | + +-+-------+-------+-+ + | | | + | | | + +-------+ +----+----+ +-------+ + | logic +--+ content +--+ style | + +-------+ +---------+ +-------+ + + diff --git a/crawler/kiss/docs/content/xdocs/samples/custom.xml b/crawler/kiss/docs/content/xdocs/samples/custom.xml new file mode 100644 index 00000000..dff5776e --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/custom.xml @@ -0,0 +1,21 @@ + + + + +Hello XML Custom World!! + diff --git a/crawler/kiss/docs/content/xdocs/samples/customSchema.xml b/crawler/kiss/docs/content/xdocs/samples/customSchema.xml new file mode 100644 index 00000000..81c7c1a9 --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/customSchema.xml @@ -0,0 +1,39 @@ + + + + +
+ Custom Schema +
+ +

Forrest comes with a set of schemas for common documents, however, if you have existing documents + that use a different schema you will want to tell Forrest how to work with them. The best way of doing + this is to build a plugin + so that you can easily reuse the functionality on different projects. Plugins also allow you to share + this new functionality with other users, and to benefit from their contributions to your work.

+ +

If you don't want to build a plugin you can make Forrest process them within your project sitemap + (but this won't really save you any work since the process is almost the same). This sample site has + a demonstration of using a custom DTD. If you request <a href="custom.html"> + you can see the results. Take a look at the project sitemap.xmap to see how it is done.

+ + Adding custom schemas with a plugin has the added benefit of being able to add the schema + definition to the catalog file rather than having to reference it directly from within the XML + document. + + diff --git a/crawler/kiss/docs/content/xdocs/samples/document-v13.xml b/crawler/kiss/docs/content/xdocs/samples/document-v13.xml new file mode 100644 index 00000000..9ca3809f --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/document-v13.xml @@ -0,0 +1,381 @@ + + + + +
+ The Apache Forrest xdocs document-v1.3 DTD + The content of this document doesn't make any sense at all. + This is a demonstration document using all possible elements in + the current Apache Forrest xdocs document-v13.dtd + +
+ + + This is a demonstration document using all possible elements in the + current Apache Forrest xdocs document-v13.dtd + (See the DTD changes section at the bottom.) + +
+ Sample Content +

Hint: See the xml source to see how the various + elements are used and see the + + DTD reference documentation. +

+
+ Block and inline elements +

This is a simple paragraph. Most documents contain a fair amount of + paragraphs. Paragraphs are called <p>.

+

With the <p xml:space="preserve"> attribute, you can declare + that whitespace should be preserved, without implying it is in any other + way special.

+

+ This next paragraph has a class attribute of 'quote'. CSS can + be used to present this <p class='quote'> in + a different style than the other paragraphs. The handling of + this quoted paragraph is defined in the <extra-css> + element in the skinconf.xml. +

+

+ Anyway, like I was sayin', shrimp is the fruit of the sea. You can + barbecue it, boil it, broil it, bake it, sautee it. Dey's uh, + shrimp-kabobs, shrimp creole, shrimp gumbo. Pan fried, deep fried, + stir-fried. There's pineapple shrimp, lemon shrimp, coconut shrimp, + pepper shrimp, shrimp soup, shrimp stew, shrimp salad, shrimp and + potatoes, shrimp burger, shrimp sandwich. That- that's about it. +

+

A number of in-line elements are available in the DTD, we will show them + inside an unordered list (<ul>):

+
    +
  • Here is a simple list item (<li>).
    • +
  • Have you seen the use of the <code> element in the + previous item?
    • +
  • Also, we have <sub> and <sup> + elements to show content above or below the text + baseline.
    • +
  • There is a facility to emphasize certain words using the + <em> <strong> + elements.
    • +
  • We can use + + <icon>s too.
    • +
  • Another possibility is the <img> element: + another feather, + which offers the ability to refer to an image map.
    • +
  • We have elements for hyperlinking: +
    +
    <link href="faq.html">
    +
    Use this to + link + to another document. As per normal, this will open the new document + in the same browser window.
    + +
    <link href="#section">
    +
    Use this to + link + to the named anchor in the current document. +
    + +
    <link href="faq.html#forrest">
    +
    Use this to + link + to another document and go to the named anchor. This will open + the new document in the same browser window. +
    + +
    <jump href="faq.html">
    +
    Use this to + jump + to another document and optionally go to a named + anchor + within that document. This will open the new document in the same + browser window. So what is the difference between link and jump? + The jump behaves differently, in that it will replace any frames + in the current window. + This is the equivalent of + <a ... target="_top"> +
    + +
    <fork href="faq.html">
    +
    Use this to + fork + your webbrowser to another document. This will open the document + in a new, unnamed browser window. + This is the equivalent of + <a ... target="_blank"> +
    +
    • + +
  • Oh, by the way, a definition list <dl> was used inside + the previous list item. We could put another +
      +
    • unordered list
      • +
    • inside the list item
      • +
    + + + + +
    A sample nested table
    Or even tables.. +
    inside tables..
    +
    or inside lists, but I believe this liberty gets quickly quite + hairy as you see.
    +
    • +
+

So far for the in-line elements, let's look at some paragraph-level + elements.

+ The <fixme> element is used for stuff + which still needs work. Mind the author attribute! + Use the <note> element to draw attention to something, e.g. ...The <code> element is used when the author can't + express himself clearly using normal sentences ;-) + Sleep deprivation can be the result of being involved in an open + source project. (a.k.a. the <warning> element). + + If you want your own labels for notes and + warnings, specify them using the label attribute. + +

Apart from unordered lists, we have ordered lists too, of course.

+
    +
  1. Item 1
    2. +
  2. Item 2
    3. +
  3. This should be 3 if my math is still OK.
    4. +
+
+ +
+ Various presentation formats + +

This sample document, written in document-v13 XML can be presented + via Forrest in a number of different formats. The links in the + following list show this document in each of the currently available + formats.

+ +

Each of the formats can be made available as a link near the top of + the page. Actual placement of those links depends on the skin + currently in use. Those links are enabled in the skinconf.xml via the + <disable-XXX-link> elements in the skinconf.xml

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Presentation FormatDescriptionskinconf.xml Element
HTMLThis document in HTML format. Always generated by default. Cannot be turned off.
XMLThis document in its raw XML format.<disable-xml-link>. By default, set to true, meaning + that this link will not be shown.
PDFThis document as Adobe PDF<disable-pdf-link>. By default, set to false, meaning + that this link will be shown.
Text

This document as straight text.

+

For additional information see the Forrest text-output + plugin.

<disable-txt-link>. By default, set to true, meaning + that this link will not be shown.
POD

This document as Perl POD (Plain Old Documentation). Text + with minimal formatting directives. If on a *nix system with perl + installed, see "man perlpod".

+

For additional information see the Forrest pod-output + plugin.

<disable-pod-link>. By default, set to true, meaning + that this link will not be shown.
+
+
+ Using sections +

You can use sections to put some structure in your document. For some + strange historical reason, the section title is an attribute of the + <section> element.

+
+
+ Sections, the sequel +

Just some second section.

+
+ Section 2.1 +

Which contains a subsection (2.1).

+
+
+ +
+ Showing preformatted source code +

Enough about these sections. Let's have a look at more interesting + elements, <source> for instance:

+ +// This example is from the book _Java in a Nutshell_ by David Flanagan. +// Written by David Flanagan. Copyright (c) 1996 O'Reilly & Associates. +// You may study, use, modify, and distribute this example for any purpose. +// This example is provided WITHOUT WARRANTY either expressed or implied. + +import java.applet.*; // Don't forget these import statements! +import java.awt.*; + +public class FirstApplet extends Applet { + // This method displays the applet. + // The Graphics class is how you do all drawing in Java. + public void paint(Graphics g) { + g.drawString("Hello World", 25, 50); + } +} +

CDATA sections are used within + <source> elements so that you can write pointy + brackets without needing to escape them with messy + &lt; entities ... +

+ + easy + +]]> +

Please take care to still use a sensible line-length within your + source elements.

+
+ +
+ Using tables +

And now for a table:

+ + + + + + + + + + + + + + + + +
Table caption
heading cell 1heading cell 2heading cell 3
data cellthis data cell spans two columns
+ Tables can be nested: + + + + + + + + + + +
column 1column 2
cell Acell B
+ 		+
  • and can include most other elements
  • such as lists
+
+
+ + +
+ Using figures +

And a <figure> to end all of this. + Note that this can also be implemented with an + <img> element. +

+
+
+
+ +
+ DTD changes +

See the generated + + DTD reference documentation. +

+
+ Changes since document-v12 +

+ All v1.2 docs will work fine as v1.3 DTD. The main change is the + addition of a @class attribute to every element, which enables the + "extra-css" section in the skinconf to be put to good use. +

+
+
+ Changes since document-v11 +

+ doc-v12 enhances doc-v11 by relaxing various restrictions that were + found to be unnecessary. +

+
    +
  • + Links ((link|jump|fork) and inline elements (br|img|icon|acronym) are + allowed inside title. +
    • +
  • + Paragraphs (p|source|note|warning|fixme), table and figure|anchor are + allowed inside li. +
    • +
  • + Paragraphs (p|source|note|warning|fixme), lists (ol|ul|dl), table, + figure|anchor are allowed inside definition lists (dd) and tables (td + and dh). +
    • +
  • + Inline content + (strong|em|code|sub|sup|br|img|icon|acronym|link|jump|fork) is + allowed in strong and em. +
    • +
+
+
+ +
+ This is a legal notice, so it is important. +
+ diff --git a/crawler/kiss/docs/content/xdocs/samples/embedded_html.html b/crawler/kiss/docs/content/xdocs/samples/embedded_html.html new file mode 100644 index 00000000..29b2d6a5 --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/embedded_html.html @@ -0,0 +1,111 @@ + + + + + Embedded HTML demonstration page + + + +

Embedded HTML demonstration page

+ +

An HTML document is used as the source for this page, and translated +to the intermediate Apache Forrest xdocs document structure. The sitemap then +does the normal aggregation with the navigation content and application of +the skin. +

+ +

+The html is being interpreted by Forrest and transformed to the +intermediate Apache xdocs document structure. That stylesheet cannot deal +with every possibility in unstructured html, so it tries to guess how to +build <section> elements and such. +It needs <h1> (<h2> etc.) headings in the source html +in order to identify sections. Patches are welcome to enhance +that transformer. +

+ +

+You can still take advantage of Forrest's +"site:" +method of linking, for example: +<a href="site:index"> +

+ +
+XHTML can also be used, but it is just treated as interpreted +html. Future versions of Forrest will take much more advantage of XHTML. + +
+ +

Some example uses of HTML

+

+There are situations when the Apache Forrest xdocs DTD is not sufficient. +The use of embedded HTML enables you to use HTML code in these situations. +

+ +

Embedded applets and Javascript

+ +

+See the +Javascript alert pop-up +

+ +

HTML forms for user interaction

+

+Search the Forrest website via Google: + +

+ + + + +Google Search + +  + +
+ +

+ +

+See a demonstration of "html" and "html forms" with our +Forrest download mirror +facility and the +explanation howto document. +

+ +

Invalid HTML

+

+This paragraph has a missing closing tag for the <p> element. If you look +at the XML created by Forrest you'll notice that +Forrest has fixed this. + +

Potentially Invalid XDocs

+ +However, it should also be noted that the resultant XML is not a valid document +since it contains the additional HTML elements. If you are intending to use +the intermediate XDocs for any purpose be aware of this fact. + +

Other non-standard html-type abilities

+

+Use other HTML delights (???) and tricks. +

+ + diff --git a/crawler/kiss/docs/content/xdocs/samples/faq.xml b/crawler/kiss/docs/content/xdocs/samples/faq.xml new file mode 100644 index 00000000..62b41ca5 --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/faq.xml @@ -0,0 +1,42 @@ + + + + + + Frequently Asked Questions + + + Documentation + + + How can I help write documentation? + + +

+ This project uses Apache Forrest to + generate documentation from XML. Please download a copy of Forrest, + which can be used to validate, develop and render a project site. +

+ + + + + + diff --git a/crawler/kiss/docs/content/xdocs/samples/hello-v10.dtd b/crawler/kiss/docs/content/xdocs/samples/hello-v10.dtd new file mode 100644 index 00000000..ee62644d --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/hello-v10.dtd @@ -0,0 +1,49 @@ + + + + + + + + diff --git a/crawler/kiss/docs/content/xdocs/samples/helloAgain.pdf b/crawler/kiss/docs/content/xdocs/samples/helloAgain.pdf new file mode 100644 index 00000000..5ca4f313 --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/helloAgain.pdf @@ -0,0 +1,70 @@ +%PDF-1.3 +%ª«¬­ +4 0 obj +<< /Type /Info +/Producer (FOP 0.20.4) >> +endobj +5 0 obj +<< /Length 203 /Filter [ /ASCII85Decode /FlateDecode ] + >> +stream +Gar'!]afWZ&;9q-MRA)RFnblL2&]tQSZsjOOT[ck2SQkp(bfQ[R7ZPq=U24c0dqq_i?B[A.0s\)5f5 +endstream +endobj +6 0 obj +<< /Type /Page +/Parent 1 0 R +/MediaBox [ 0 0 595 842 ] +/Resources 3 0 R +/Contents 5 0 R +>> +endobj +7 0 obj +<< /Type /Font +/Subtype /Type1 +/Name /F1 +/BaseFont /Helvetica +/Encoding /WinAnsiEncoding >> +endobj +8 0 obj +<< /Type /Font +/Subtype /Type1 +/Name /F5 +/BaseFont /Times-Roman +/Encoding /WinAnsiEncoding >> +endobj +1 0 obj +<< /Type /Pages +/Count 1 +/Kids [6 0 R ] >> +endobj +2 0 obj +<< /Type /Catalog +/Pages 1 0 R + >> +endobj +3 0 obj +<< +/Font << /F1 7 0 R /F5 8 0 R >> +/ProcSet [ /PDF /ImageC /Text ] >> +endobj +xref +0 9 +0000000000 65535 f +0000000687 00000 n +0000000745 00000 n +0000000795 00000 n +0000000015 00000 n +0000000071 00000 n +0000000365 00000 n +0000000471 00000 n +0000000578 00000 n +trailer +<< +/Size 9 +/Root 2 0 R +/Info 4 0 R +>> +startxref +883 +%%EOF diff --git a/crawler/kiss/docs/content/xdocs/samples/index.xml b/crawler/kiss/docs/content/xdocs/samples/index.xml new file mode 100644 index 00000000..41f7ac5c --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/index.xml @@ -0,0 +1,29 @@ + + + + +
+ Samples +
+ +
+ If something goes wrong.. +

Patches are welcome: Forrest FAQ

+
+ + diff --git a/crawler/kiss/docs/content/xdocs/samples/linking.xml b/crawler/kiss/docs/content/xdocs/samples/linking.xml new file mode 100644 index 00000000..31b82af9 --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/linking.xml @@ -0,0 +1,353 @@ + + + + +
+ Demonstration of linking +
+ + +
+ Overview +

Forrest has many powerful techniques for linking between documents + and for managing the site navigation. This document demonstrates those + techniques. + The document "Menus and Linking" + has the full details. +

+
+ +
+ Building and maintaining consistent URI space +

+ When Forrest builds your site, it starts from the front page. Like + a robot, it traverses all of the links that it finds in the documents + and builds the corresponding pages. Any new links are further traversed. +

+

+ Sometimes those links lead to documents that are generated directly + from xml source files, sometimes they are generated from other source + via an intermediate xml format. Other times the links lead to raw + un-processed content. +

+

+ The site navigation configuration file "site.xml" provides + a way to manage this URI space. In the future, when documents are + re-arranged and renamed, the site.xml configuration will enable this + smoothly. +

+
+ +
+ Mapping the local resource space to the final URI space +

+ For both generated and raw (un-processed) files, the top-level of the + URI space corresponds to the "content/xdocs/" directory, + i.e. the location of the "site.xml" configuration file. +

+ + In versions prior to 0.7 raw un-processed content was stored in + the "content/" directory. In 0.7 onwards, raw + un-processed data is stored alongside the xdocs. In addition, + in 0.6 and earlier, HTML documents could be stored in the xdocs + directory and served without processing. If you + you wish to emulate the behaviour of 0.6 and earlier see the + next section. + +

+ A diagram will help. +

+ The final URI space +------------------ ------------------- +Generated content ... + content/xdocs/index.xml index.html + content/xdocs/samples/index.xml samples/index.html + content/xdocs/samples/faq.xml samples/faq.html + content/xdocs/test1.html test1.html + content/xdocs/samples/test3.html samples/test3.html + content/xdocs/samples/subdir/test4.html samples/subdir/test4.html + +Raw un-processed content ... + content/xdocs/hello.pdf hello.pdf + content/xdocs/hello.sxw hello.sxw + content/xdocs/subdir/hello.sxw subdir/hello.sxw +]]> + +
+ How Plugins May Affect The URI Space +

By using Forrest Input Plugins + you can process some file formats, such as + OpenOffice.org documents and produce processed content from them. For example, + the file content/xdocs/hello.sxw can be used to produce a + skinned version of the document at with the name hello.html. + Similarly, you can use Forrest Output + Plugins to create different output formats such as PDF, in this + case content/xdocs/hello.sxw can produce + hello.pdf.

+ +

However, this does not affect the handling of raw content. That is, you + can still retrieve the raw un-processed version with, for example, + hello.sxw. If you want to prevent the user retrieving the + un-processed version you will have to create matchers that intercept + these requests within your project sitemap.

+
+ +
+ +
+ Basic link to internal generated pages +

+ When this type of link is encountered, Forrest will look for a + corresponding xml file, relative to this document (i.e. in + content/xdocs/samples/). +

+

A generated document in the current directory, which corresponds to + content/xdocs/samples/sample.html ... +

+ ]]>sample.html]]> +

In a sub-directory, which corresponds to + content/xdocs/samples/subdir/index.html ... +

+ ]]>subdir/index.html]]> +
+ +
+ Basic link to raw un-processed content +

+ Raw content files are not intended for any processing, they are just + linked to (e.g. pre-prepared PDFs, zip archives). + These files are placed alongside your normal content in the + "content/xdocs" directory. +

+

A raw document in the current directory, which corresponds to + content/xdocs/samples/helloAgain.pdf ... +

+ ]]>helloAgain.pdf]]> +

A raw document in a sub-directory, which corresponds to + content/xdocs/samples/subdir/hello.zip ... +

+ ]]>subdir/hello.zip]]> +

A raw document at the next level up, which corresponds to + content/hello.pdf ... +

+ ]]>../hello.pdf]]> + +
+ Serving (X)HTML content without Skinning + +

Prior to version 0.7, the raw un-processed content was stored in + the "content/" directory. In 0.7 onwards, raw + un-processed data is stored alongside the xdocs. In addition + in 0.6 and earlier, HTML files could be stored in the xdocs + directory and they would be served without further processing. + As described above, this is not the case in 0.7 where HTML files + are, by default, skinned by Forrest.

+ +

If you + you wish to emulate the behaviour of 0.6 and earlier then you + must add the following to your project sitemap.

+ + +<map:match pattern="**.html"> + <map:select type="exists"> + <map:when test="{project:content}{0}"> + <map:read src="{project:content}/{0}" mime-type="text/html"/> + <!-- + Use this instead if you want JTidy to clean up your HTML + <map:generate type="html" src="{project:content}/{0}" /> + <map:serialize type="html"/> + --> + </map:when> + <map:when test="{project:content.xdocs}{0}"> + <map:read src="{project:content.xdocs}/{0}" mime-type="text/html"/> + <!-- + Use this instead if you want JTidy to clean up your HTML + <map:generate type="html" src="{project:content.xdocs}/{0}" /> + <map:serialize type="html"/> + --> + </map:when> + </map:select> +</map:match> + + +

The above allows us to create links to un-processed skinned files stored + in the {project:content} or {project:content.xdocs} + directory. For example: + <a href="/test1.html">HTML content</a>. However, it will + break the 0.7 behaviour of skinning HTML content. For this reason the old + ".ehtml" extension can be used to embed HTML content in a Forrest skinned + site

+ +

Note that you can change the matchers above to selectively serve some + content as raw un-processed content, whilst still serving other content + as skinned documents. For example, the following snippet would allow + you to serve the content of an old, deprecated site without processing + from Forrest, whilst still allowing all other content to be processed + by Forrest in the normal way:

+ + +<map:match pattern="old_site/**.html"> + <map:select type="exists"> + <map:when test="{project:content}{1}.html"> + <map:read src="{project:content}/{1}.html" mime-type="text/html"/> + <!-- + Use this instead if you want JTidy to clean up your HTML + <map:generate type="html" src="{project:content}/{0}" /> + <map:serialize type="html"/> + --> + </map:when> +</map:match> + + +

For example, HTML content.

+
+
+ +
+ Full URL to external documents +

A full URL ...

+ ]]>http://forrest.apache.org/]]> +

A full URL with a fragment identifier ...

+ ]]>http://forrest.apache.org/faq.html#link_raw]]> +

+ Note that Forrest does not traverse external links to look for + other links. +

+
+ +
+ Using site.xml to manage the links +

As you will have discovered, using pathnames with ../../ etc. will + get very nasty. Real problems occur when you use a smart text editor + that tries to manage the links for you. For example, it will have + trouble linking to the raw content files which are not yet in their + final location. +

+

+ Links and filenames are bound to change and re-arrange. It is + essential to only change those links in one central place, not in every + document. +

+

+ The "site.xml" configuration file to the rescue. It maps + symbolic names to actual resources. +

+ +
+ Basic link to internal generated pages +

This single entry ...

+ ]]> +

+ enables a simple link to a generated document, which corresponds to + content/xdocs/index.xml ... +

+ ]]>site:index]]> +
+ +
+ Group some items +

This compound entry ...

+ + + ... + +]]> +

+ enables a link to a generated document, which corresponds to + content/xdocs/samples/index.xml ... +

+ ]]>site:samples]]> +

+ and a link to a generated document, which corresponds to + content/xdocs/samples/faq.xml ... +

+ +]]>site:faq]]> +which can also be a complete reference +]]>site:samples/faq]]> + +
+ +
+ Fragment identifiers +

This compound entry ...

+ + + +
+ + ... + +]]> +

+ enables a link to a fragment identifier within the + samples/sample.html document ... +

+ ]]>site:samples/sample/section]]> +
+ +
+ Define items for raw content +

This entry ...

+ ]]> +

+ enables a link to a raw document, which corresponds to + content/hello.pdf ... +

+ ]]>site:hello_print]]> + +
+ +
+ External links +

This compound entry ...

+ + + + + + +]]> +

+ enables a link to an external URL ... +

+ ]]>ext:forrest]]> +

+ and a link to another external URL ... +

+ +]]>ext:linking]]> +which can also be a complete reference +]]>ext:forrest/linking]]> + +

+ and a link to another external URL with a fragment identifier ... +

+ +]]>ext:webapp]]> +which can also be a complete reference +]]>ext:forrest/webapp]]> + +
+
+ + diff --git a/crawler/kiss/docs/content/xdocs/samples/sample.xml b/crawler/kiss/docs/content/xdocs/samples/sample.xml new file mode 100644 index 00000000..52774f7d --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/sample.xml @@ -0,0 +1,407 @@ + + + + +
+ The Apache Forrest xdocs document-v2.0 DTD + The content of this document doesn't make any sense at all. + This is a demonstration document using all possible elements in + the current Apache Forrest xdocs document-v20.dtd + +
+ + + This is a demonstration document using all possible elements in the + current Apache Forrest xdocs document-v20.dtd + (See the DTD changes section at the bottom.) + +
+ Sample Content +

Hint: See the xml source to see how the various + elements are used and see the + + DTD reference documentation. +

+
+ Block and inline elements +

This is a simple paragraph. Most documents contain a fair amount of + paragraphs. Paragraphs are called <p>.

+

With the <p xml:space="preserve"> attribute, you can declare + that whitespace should be preserved, without implying it is in any other + way special.

+

+ This next paragraph has a class attribute of 'quote'. CSS can + be used to present this <p class='quote'> in + a different style than the other paragraphs. The handling of + this quoted paragraph is defined in the <extra-css> + element in the skinconf.xml. +

+

+ Anyway, like I was sayin', shrimp is the fruit of the sea. You can + barbecue it, boil it, broil it, bake it, sautee it. Dey's uh, + shrimp-kabobs, shrimp creole, shrimp gumbo. Pan fried, deep fried, + stir-fried. There's pineapple shrimp, lemon shrimp, coconut shrimp, + pepper shrimp, shrimp soup, shrimp stew, shrimp salad, shrimp and + potatoes, shrimp burger, shrimp sandwich. That- that's about it. +

+

A number of in-line elements are available in the DTD, we will show them + inside an unordered list (<ul>):

+
    +
  • Here is a simple list item (<li>).
    • +
  • Have you seen the use of the <code> element in the + previous item?
    • +
  • Also, we have <sub> and <sup> + elements to show content above or below the text + baseline.
    • +
  • There is a facility to emphasize certain words using the + <em> <strong> + elements.
    • +
  • We can use + + <icon>s too.
    • +
  • Another possibility is the <img> element: + another feather, + which offers the ability to refer to an image map.
    • +
  • We have elements for hyperlinking: +
    +
    <a href="faq.html">
    +
    Use this to + link + to another document. As per normal, this will open the new document + in the same browser window.
    + +
    <a href="#section">
    +
    Use this to + link + to the named anchor in the current document. +
    + +
    <a href="faq.html#forrest">
    +
    Use this to + link + to another document and go to the named anchor. This will open + the new document in the same browser window. +
    +
    Targetted window control with jump and fork.
    +
    See demonstration + using class attribute on links. +
    +
    • + +
  • Oh, by the way, a definition list <dl> was used inside + the previous list item. We could put another +
      +
    • unordered list
      • +
    • inside the list item
      • +
    + + + + +
    A sample nested table
    Or even tables.. +
    inside tables..
    +
    or inside lists, but I believe this liberty gets quickly quite + hairy as you see.
    +
    • +
+

So far for the in-line elements, let's look at some paragraph-level + elements.

+ The <fixme> element is used for stuff + which still needs work. Mind the author attribute! + Use the <note> element to draw attention to something, e.g. ...The <code> element is used when the author can't + express himself clearly using normal sentences ;-) + Sleep deprivation can be the result of being involved in an open + source project. (a.k.a. the <warning> element). + + If you want your own labels for notes and + warnings, specify them using the label attribute. + +

Apart from unordered lists, we have ordered lists too, of course.

+
    +
  1. Item 1
    2. +
  2. Item 2
    3. +
  3. This should be 3 if my math is still OK.
    4. +
+
+ +
+ Various presentation formats + +

This sample document, written in document-v20 XML can be presented + via Forrest in a number of different formats. The links in the + following list show this document in each of the currently available + formats.

+ +

Each of the formats can be made available as a link near the top of + the page. Actual placement of those links depends on the skin + currently in use. Those links are enabled in the skinconf.xml via the + <disable-XXX-link> elements in the skinconf.xml

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Presentation FormatDescriptionskinconf.xml Element
HTMLThis document in HTML format. Always generated by default. Cannot be turned off.
XMLThis document in its raw XML format.<disable-xml-link>. By default, set to true, meaning + that this link will not be shown.
PDFThis document as Adobe PDF<disable-pdf-link>. By default, set to false, meaning + that this link will be shown.
Text

This document as straight text.

+

For additional information see the Forrest text-output + plugin.

<disable-txt-link>. By default, set to true, meaning + that this link will not be shown.
POD

This document as Perl POD (Plain Old Documentation). Text + with minimal formatting directives. If on a *nix system with perl + installed, see "man perlpod".

+

For additional information see the Forrest pod-output + plugin.

<disable-pod-link>. By default, set to true, meaning + that this link will not be shown.
+
+
+ Using sections +

You can use sections to put some structure in your document. For some + strange historical reason, the section title is an attribute of the + <section> element.

+
+
+ Sections, the sequel +

Just some second section.

+
+ Section 2.1 +

Which contains a subsection (2.1).

+
+
+ +
+ Showing preformatted source code +

Enough about these sections. Let's have a look at more interesting + elements, <source> for instance:

+ +// This example is from the book _Java in a Nutshell_ by David Flanagan. +// Written by David Flanagan. Copyright (c) 1996 O'Reilly & Associates. +// You may study, use, modify, and distribute this example for any purpose. +// This example is provided WITHOUT WARRANTY either expressed or implied. + +import java.applet.*; // Don't forget these import statements! +import java.awt.*; + +public class FirstApplet extends Applet { + // This method displays the applet. + // The Graphics class is how you do all drawing in Java. + public void paint(Graphics g) { + g.drawString("Hello World", 25, 50); + } +} +

CDATA sections are used within + <source> elements so that you can write pointy + brackets without needing to escape them with messy + &lt; entities ... +

+ + easy + +]]> +

Please take care to still use a sensible line-length within your + source elements.

+
+ +
+ Using tables +

And now for a table:

+ + + + + + + + + + + + + + + + +
Table caption
heading cell 1heading cell 2heading cell 3
data cellthis data cell spans two columns
+ Tables can be nested: + + + + + + + + + + +
column 1column 2
cell Acell B
+ 		+
  • and can include most other elements
  • such as lists
+
+
+ + +
+ Using figures +

And a <figure> to end all of this. + Note that this can also be implemented with an + <img> element. +

+
+
+ +
+ +
+ DTD changes +

See the generated + + DTD reference documentation. +

+
+ Changes between document-v13 and document-v20 + +
+
+ Changes between document-v12 and document-v13 +

+ All v1.2 docs will work fine as v1.3 DTD. The main change is the + addition of a @class attribute to every element, which enables the + "extra-css" section in the skinconf to be put to good use. +

+
+
+ Changes between document-v11 and document-v12 +

+ doc-v12 enhances doc-v11 by relaxing various restrictions that were + found to be unnecessary. +

+
    +
  • + Links ((link|jump|fork) and inline elements (br|img|icon|acronym) are + allowed inside title. +
    • +
  • + Paragraphs (p|source|note|warning|fixme), table and figure|anchor are + allowed inside li. +
    • +
  • + Paragraphs (p|source|note|warning|fixme), lists (ol|ul|dl), table, + figure|anchor are allowed inside definition lists (dd) and tables (td + and dh). +
    • +
  • + Inline content + (strong|em|code|sub|sup|br|img|icon|acronym|link|jump|fork) is + allowed in strong and em. +
    • +
+
+
+ +
+ This is a legal notice, so it is important. +
+ diff --git a/crawler/kiss/docs/content/xdocs/samples/static.xml b/crawler/kiss/docs/content/xdocs/samples/static.xml new file mode 100644 index 00000000..9553525c --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/static.xml @@ -0,0 +1,62 @@ + + + + +
+ Static content - including raw un-processed files and documents +
+ +
+ Linking to static content +

+ You can place some types of raw content into the xdocs directory. For example, + you can place a PDF file in src/documentation/content/xdocs and link + to it normally, + <a href="../hello.pdf">hello.pdf</a> + However, note that if the file is one that Forrest is able to process, for example + an HTML file, these files will be processed accordingly.

+ +

+ It is also worth noting that files in the xdocs directory will only be copied + into your final site if there is a link to them somewhere in the site. See the next + section for details of how to include content that is not linked.

+ +

+ For more information see the + Linking demonstration.

+
+ +
+ Including Static Content that is Not Linked + +

+ You can include raw HTML, PDFs, plain-text, and other files. In your final site by + placing them in the src/documentation/content directory. Files in this + directory will be copied over automatically but will not be processed in any way by + Forrest, that is they will be linked to as raw files.

+ +

+ You can also have sub-directories such as + src/documentation/content/samples/subdir/ which + reflects your main + xdocs/ tree. The raw files will then end up + beside your documents. +

+
+ + diff --git a/crawler/kiss/docs/content/xdocs/samples/subdir/book-sample.xml b/crawler/kiss/docs/content/xdocs/samples/subdir/book-sample.xml new file mode 100644 index 00000000..f5396c66 --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/subdir/book-sample.xml @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/crawler/kiss/docs/content/xdocs/samples/subdir/hello.zip b/crawler/kiss/docs/content/xdocs/samples/subdir/hello.zip new file mode 100644 index 0000000000000000000000000000000000000000..b4fb6aae96a08cabd05f36d50ce01ef54df44519 GIT binary patch literal 743 zcmWIWW@Zs#U|`^2$lkES=-Zk!-C`yNh9VXQ22P-8Mruw@zFt8}+SHKSVYeJaYUi)F z*d?aqI#Yl{Wzm*9L6Kc80{X0xR-DW(&c{@or@wW!UopM@jmn}8VKo_(r(0H^v#UNg z&-+-$>-M8goT+vHe*I;i>d2I4zu=ASMffENG--|vHjfFBnpymyebP_>MLs|np)alu!~PkW1Yyy36oTR z`5bz4uI0=+_i9sJi#IcS=dAp_tz7TD?~eqFF1cT|*>7x49X|N@@;+PXp0lq`aQNvx z-K6Z>{NUW*8#3lxK_#<;(@qs`pZGPWGpOwTsr&5P@2cn6UgF=Gb?lV5*t9AWi5-`v z)8@?Ytzv(6c6#jX6W6Wg8?i5*eJgaE;FId8ie0;n?RN&~bZ@QJd2!KuyK`~tySt^D z0ZSLN+s2>H`W8Cf%(wbdT*;QjeL2BD-5;IZwQ{TX)G52!W(Ggh<6L=up~f=bmgha{VGk>*dAy z->&X32Vb|ZRx0L4B!lGSOAD7C*&ErlN_U~_{K`!N6>ERXT#}sR;C$&eyQr(Cra^P~ znnhd_Q;yXiUX`lao0;jOwXZp}TXRi_=kuxePX@1g#r9aS&{m2o_z2(b`zte;XZI9N zi1$nR6XWpntBKp37Mqvhp+|)$zx-1AMLfWpkx7IBciIFdPX + + + +
+ Page generated from a sub-directory + + + + +
+ + +
+ A sub-directory +

This was generated from a sub-directory.

+

When creating new subdirectories, remember that these must + be declared in site.xml or each directory must have a book.xml file. +

+
+ + + diff --git a/crawler/kiss/docs/content/xdocs/samples/usemap.xml b/crawler/kiss/docs/content/xdocs/samples/usemap.xml new file mode 100644 index 00000000..50bf2afa --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/samples/usemap.xml @@ -0,0 +1,61 @@ + + + + +
+ Interactive client-side imagemaps - the usemap attribute +
+ +
+ Imagemap demo +

+ usemap demo +

+

+ + Rectangle + Circle + Default + +

+
+
+ Source code + + usemap demo +

+

+ + Rectangle + Circle + Default + +

+]]> +
+ + diff --git a/crawler/kiss/docs/content/xdocs/site.xml b/crawler/kiss/docs/content/xdocs/site.xml new file mode 100644 index 00000000..8e17226c --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/site.xml @@ -0,0 +1,103 @@ + + + + + + + + + + + + + + + +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/crawler/kiss/docs/content/xdocs/tabs.xml b/crawler/kiss/docs/content/xdocs/tabs.xml new file mode 100644 index 00000000..abbc7ebc --- /dev/null +++ b/crawler/kiss/docs/content/xdocs/tabs.xml @@ -0,0 +1,51 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/crawler/kiss/docs/resources/schema/catalog.xcat b/crawler/kiss/docs/resources/schema/catalog.xcat new file mode 100644 index 00000000..91da4103 --- /dev/null +++ b/crawler/kiss/docs/resources/schema/catalog.xcat @@ -0,0 +1,29 @@ + + + + + + + + + + + diff --git a/crawler/kiss/docs/resources/schema/hello-v10.dtd b/crawler/kiss/docs/resources/schema/hello-v10.dtd new file mode 100644 index 00000000..4fab270f --- /dev/null +++ b/crawler/kiss/docs/resources/schema/hello-v10.dtd @@ -0,0 +1,51 @@ + + + + + + + + + + + + diff --git a/crawler/kiss/docs/resources/stylesheets/hello2document.xsl b/crawler/kiss/docs/resources/stylesheets/hello2document.xsl new file mode 100644 index 00000000..1a8e453b --- /dev/null +++ b/crawler/kiss/docs/resources/stylesheets/hello2document.xsl @@ -0,0 +1,39 @@ + + + + + + + + + +
+ + <xsl:value-of select="greeting"/> + +
+ + + + + + + diff --git a/crawler/kiss/docs/sitemap.xmap b/crawler/kiss/docs/sitemap.xmap new file mode 100644 index 00000000..f32221a4 --- /dev/null +++ b/crawler/kiss/docs/sitemap.xmap @@ -0,0 +1,72 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/crawler/kiss/docs/skinconf.xml b/crawler/kiss/docs/skinconf.xml new file mode 100644 index 00000000..c427b579 --- /dev/null +++ b/crawler/kiss/docs/skinconf.xml @@ -0,0 +1,441 @@ + + + + + + + + + + + + true + + false + + true + + true + + + true + + + true + + + false + + + true + .at. + + + true + + + MyProject + MyProject Description + http://myproj.mygroup.org/ + images/project.png + + + + MyGroup + MyGroup Description + http://mygroup.org + images/group.png + + + + + + + + + + + 2005 + The Acme Software Foundation. + + + + + + + + + + + + + + + + + + Send feedback about the website to: + + + + + + + + + p.quote { + margin-left: 2em; + padding: .5em; + background-color: #f0f0f0; + font-family: monospace; + } + + #footer a { color: #0F3660; } + #footer a:visited { color: #009999; } + + + + + + + + + + + + + + + + + + + + + + + + Page 1 + + + + 1in + 1in + 1.25in + 1in + + + + false + + + false + + + + + + Built with Apache Forrest + http://forrest.apache.org/ + images/built-with-forrest-button.png + 88 + 31 + + + + + + diff --git a/crawler/kiss/docs/translations/langcode.xml b/crawler/kiss/docs/translations/langcode.xml new file mode 100644 index 00000000..ed09f417 --- /dev/null +++ b/crawler/kiss/docs/translations/langcode.xml @@ -0,0 +1,26 @@ + + + + + English + Espanol + Italiano + diff --git a/crawler/kiss/docs/translations/languages_en.xml b/crawler/kiss/docs/translations/languages_en.xml new file mode 100644 index 00000000..1037e0e4 --- /dev/null +++ b/crawler/kiss/docs/translations/languages_en.xml @@ -0,0 +1,22 @@ + + + + English + Spanish + Dutch + diff --git a/crawler/kiss/docs/translations/languages_es.xml b/crawler/kiss/docs/translations/languages_es.xml new file mode 100644 index 00000000..a5d17dd0 --- /dev/null +++ b/crawler/kiss/docs/translations/languages_es.xml @@ -0,0 +1,22 @@ + + + + Inglés + Español + Holandés + diff --git a/crawler/kiss/docs/translations/menu.xml b/crawler/kiss/docs/translations/menu.xml new file mode 100644 index 00000000..003da620 --- /dev/null +++ b/crawler/kiss/docs/translations/menu.xml @@ -0,0 +1,33 @@ + + + + About + Index + Changes + Todo + Samples + Apache document + Static content + Linking + Wiki page + Ihtml page + Ehtml page + FAQ + Simplifed Docbook + XSP page + diff --git a/crawler/kiss/docs/translations/menu_af.xml b/crawler/kiss/docs/translations/menu_af.xml new file mode 100644 index 00000000..108faa75 --- /dev/null +++ b/crawler/kiss/docs/translations/menu_af.xml @@ -0,0 +1,33 @@ + + + + Aangaande + Inhoud + Veranderinge + Om te doen + Voorbeelde + Apache dokument + Statise Inhoud + Linking + Wiki bladsy + Ihtml bladsy + Ehtml bladsy + FAQ + Vereenvoudigde Docbook + XSP bladsy + diff --git a/crawler/kiss/docs/translations/menu_de.xml b/crawler/kiss/docs/translations/menu_de.xml new file mode 100644 index 00000000..3cb39f49 --- /dev/null +++ b/crawler/kiss/docs/translations/menu_de.xml @@ -0,0 +1,33 @@ + + + + Über + Index + Änderungen + Todo + Beispiele + Apache Dokumentationsseite + Statischer Inhalt + Linking + Wiki Seite + ihtml Seite + ehtml Seite + FAQ + Vereinfachte Docbook + XSP Seite + diff --git a/crawler/kiss/docs/translations/menu_es.xml b/crawler/kiss/docs/translations/menu_es.xml new file mode 100644 index 00000000..690808dd --- /dev/null +++ b/crawler/kiss/docs/translations/menu_es.xml @@ -0,0 +1,33 @@ + + + + Acerca de + Indice + Cambios + Tareas pendientes + Ejemplos + Documento Apache + Contenido Estático + Linking + Página Wiki + Página ihtml + Página ehtml + Preguntas Frecuentes + Página Simplifed Docbook + Página XSP + diff --git a/crawler/kiss/docs/translations/menu_it.xml b/crawler/kiss/docs/translations/menu_it.xml new file mode 100644 index 00000000..fce8cccb --- /dev/null +++ b/crawler/kiss/docs/translations/menu_it.xml @@ -0,0 +1,33 @@ + + + + Riguardo a + Indice + Cambiamenti + Cose da fare + Esempi + Apache document + Contenuto Statico + Linking + Pagina Wiki + Pagina ihtml + Pagina ehtml + Domande frequenti + Simplifed Docbook + Pagina XSP + diff --git a/crawler/kiss/docs/translations/menu_no.xml b/crawler/kiss/docs/translations/menu_no.xml new file mode 100644 index 00000000..7b094ed2 --- /dev/null +++ b/crawler/kiss/docs/translations/menu_no.xml @@ -0,0 +1,33 @@ + + + + Om + Indeks + Endringer + Oppgave liste + Eksempler + Apache Dokument + Statisk innhold + Linking + Wiki side + ihtml side + ehtml side + FAQ + Simplifed Docbook + XSP side + diff --git a/crawler/kiss/docs/translations/menu_ru.xml b/crawler/kiss/docs/translations/menu_ru.xml new file mode 100644 index 00000000..7454faca --- /dev/null +++ b/crawler/kiss/docs/translations/menu_ru.xml @@ -0,0 +1,33 @@ + + + + О проекте + Содержание + Изменения + План + Примеры + Страница документа Apache + Статическое содержание + Linking + Страница Wiki + Страница ihtml + Страница ehtml + Вопросы/Ответы + Docbook страница + XSP страница + diff --git a/crawler/kiss/docs/translations/menu_sk.xml b/crawler/kiss/docs/translations/menu_sk.xml new file mode 100644 index 00000000..801c5e27 --- /dev/null +++ b/crawler/kiss/docs/translations/menu_sk.xml @@ -0,0 +1,33 @@ + + + + O programe + Zoznám + Zmeny + Úlohy + Príklady + Apache Document + Statický Obsah + Linking + Wiki stránka + ihtml stránka + ehtml stránka + Casté Otázky + Simplifed Docbook stránka + XSP stránka + diff --git a/crawler/kiss/docs/translations/tabs.xml b/crawler/kiss/docs/translations/tabs.xml new file mode 100644 index 00000000..1cfbca61 --- /dev/null +++ b/crawler/kiss/docs/translations/tabs.xml @@ -0,0 +1,22 @@ + + + + Home + Samples + Apache XML Projects + diff --git a/crawler/kiss/docs/translations/tabs_es.xml b/crawler/kiss/docs/translations/tabs_es.xml new file mode 100644 index 00000000..adf5a65a --- /dev/null +++ b/crawler/kiss/docs/translations/tabs_es.xml @@ -0,0 +1,22 @@ + + + + Inicio + Ejemplos + Projectos XML Apache + -- 2.31.1