"Fossies" - the Fresh Open Source Software Archive

Member "daisy-2.4.2/applications/daisywiki/README.txt" (28 Jan 2010, 6468 Bytes) of package /linux/www/old/daisy-2.4.2-src.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1                                 Daisy CMS
    2                         http://www.daisycms.org
    3 
    4                  === DAISY WIKI BUILD PROFILES ===
    5 
    6 Like for the repository server, there are two scenarios:
    7 
    8  1. Only build the wiki (e.g. when you're building a binary dist)
    9 
   10  2. Set up a development environment for running/building the wiki
   11 
   12 In both cases, first build the repository server as outlined in
   13 ../../README.txt
   14 
   15 >> Maven used 'profiles' to influence the build process.
   16    You can activate build profiles using -P<profileId>.
   17    Below are the profiles defined in the daisywiki buildfiles (pom.xml) and their function.
   18    
   19      -Pcocoon.download : This profile makes sure the cocoon source code is present by downloading it
   20                          You only  need to do this once (and if you deleted the directory <daisy-src>/../daisy-deps/cocoon.version)
   21      -Pcocoon.get      : This profile-Pwebapp -Pdev (you can also do this from <daisy-src>)
   22                          You need to do this only, or if you deleted the 'target' directory under
   23                          <daisy-src>/applications/daisywiki/runtime/target
   24      -Pwebapp          : Prepares the cocoon environment built with -Pcocoon.get to run the Daisy wiki
   25      -PdeployResources : Copies the resources needed to run the Daisy wiki
   26      -Pdev             : Signs the parteditor-applet artifact.  This flag is always needed
   27                          when building the parteditor-applet module.  If you omit it, it implies
   28                          that you are performing an official build, and that you will provide a keystore password
   29                          using -Dmystorepass=....
   30 
   31 If you are behind a proxy you will need to download cocoon manually.  The location to save cocoon can be found in the runtime/project.properties file.
   32 
   33     +---------------------------------------------------------------+
   34     |       If you want to use a different Cocoon version           |
   35     |                                                               |
   36     |        This replaces using "-Pcocoon.download"                |
   37     |                                                               |
   38     |           (Skip this unless you want to do so)                |
   39     +---------------------------------------------------------------+
   40 
   41 >> Download Cocoon 2.1 and extract it somewhere (no need to build it)
   42 
   43 Note: - the exact Cocoon version required for the Daisy Wiki varies
   44         from time to time, as of now at least a 2.1.11-dev is required
   45       - newer Cocoon versions from the 2.1 series might work, older
   46         ones (such as 2.1.10) won't
   47       - Cocoon 2.2 is a major new release, and won't work with Daisy
   48 
   49 >> Create an empty text file named:
   50 
   51      <daisy-src>/applications/daisywiki/runtime/build.properties
   52 
   53 and define a property named cocoon.dist.home in it pointing to the
   54 location where you extracted Cocoon. On Windows, you need to escape
   55 backslashes by entering them double. Examples:
   56 
   57 cocoon.dist.home=/path/to/cocoon-<version>
   58 cocoon.dist.home=e:\\path\\to\\cocoon-<version>
   59 
   60 >> Continue building with mvn -Pcocoon.get -Pwebapp
   61 
   62     +---------------------------------------------------------------+
   63     |    Seeding the repository server with required wiki things    |
   64     |                [skip when building dist only]                 |
   65     +---------------------------------------------------------------+
   66 
   67 >> The repository server should be running
   68 
   69 >> Go to the <daisy-src>/install/target directory and execute:
   70 
   71      daisy-wiki-init-dev
   72      (linux: sh daisy-wiki-init-dev if not executable)
   73 
   74    Note the "-dev" suffix !!!
   75 
   76 >> You will be asked for the address of the repository server,
   77    just press enter.
   78 
   79 >> Next you're asked for a user, enter "testuser", password "testuser".
   80 
   81 The install program continues its work and finishes.
   82 
   83 
   84     +---------------------------------------------------------------+
   85     |               Creating a wiki data directory                  |
   86     |                [skip when building dist only]                 |
   87     +---------------------------------------------------------------+
   88 
   89 Now we'll create a "wikidata directory". This is a directory where
   90 configuration (skins etc.) and data (e.g. the bookstore) for the wiki
   91 are stored.
   92 
   93 >> Go to the the <daisy-src>/install/target directory and execute:
   94 
   95      daisy-wikidata-init-dev
   96      (linux: sh daisy-wikidata-init-dev)
   97 
   98    Note the "-dev" suffix !!!
   99 
  100 The script will ask where to create the wikidata directory. As default
  101 it will suggest to use "devwikidata" as sibling of <daisy-src>.
  102 
  103    If you opt for another location you'll need to add that path as a
  104    property 'daisywiki.data' in a file called build.properties in
  105    <daisy-src>/applications/daisywiki/runtime   
  106    For this change to have effect, you need to re-execute "mvn -Pcocoon.get"
  107    in <daisy-src>/applications/daisywiki/runtime
  108 
  109 When the script asks for a user, enter "testuser", password "testuser".
  110 
  111 The script finishes.
  112 
  113 
  114     +---------------------------------------------------------------+
  115     |                        Creating a site                        |
  116     |                [skip when building dist only]                 |
  117     +---------------------------------------------------------------+
  118 
  119 >> Now again in <daisy-src>/install/target, execute:
  120 
  121 daisy-wiki-add-site-dev <daisy-src>/../devwikidata
  122 
  123 (thus, the location of the wikidata directory should be specified
  124 as an argument)
  125 
  126 Use again testuser/testuser to login, and enter when asked for the address of
  127 the repository server.
  128 
  129 Then you're asked for the name of the site to create. Choose something,
  130 for example "testsite".
  131 
  132 
  133 
  134     +---------------------------------------------------------------+
  135     |                    Running the Daisy Wiki                     |
  136     |                [skip when building dist only]                 |
  137     +---------------------------------------------------------------+
  138 
  139 To run the Daisy Wiki, execute:
  140 
  141 cd <daisy-src>/applications/daisywiki/runtime
  142 
  143 (On linux/unix)
  144 sh target/cocoon/runc2.sh
  145 
  146 (On Windows)
  147 target\cocoon\runc2
  148 
  149 You can view the app by surfing to:
  150 
  151 http://localhost:8888/daisy/
  152 
  153 (hint: you do need the slash on the end!)
  154 (hint: the repository server needs to be up and running)
  155 
  156 To view your created site, go to:
  157 
  158 http://localhost:8888/daisy/testsite/
  159 
  160 By default, you're guest user, so you won't be able to edit or create
  161 anything unless you change the login. You can login with testuser/testuser.