search

jamescheney / database-wiki

Automatically exported from code.google.com/p/database-wiki
GNU General Public License v3.0
2 stars 0 forks source link

readme

DEPRECATED VERSION

Database Wiki

A wiki lets users collaborate on Web content easily through a Web browser, and wikis also make it easier to understand the process by which some data was created by recording detailed history records. A Database Wiki is a wiki for structured data, providing both database-like capabilities to structure and query data and wiki-like capabilities for collaboration and transparency.

Entry points

The entry points are defined as main methods of classes in org.dbwiki.main:

CreateServer DatabaseImport DatabasePackageExport DatabasePackageImport DropDatabaseWiki DropServer ImportPresentationFiles StartServer

For convenience, various wrapper scripts are included in the root directory for invoking the various entry points with appropriate classpaths using configuration files in ./resources/configuration/. Those ending with a .sh suffix are suitable for UNIX platforms (including Linux and Mac OS X). Those ending with a .cmd suffix are suitable for Windows.

Initialising a server

Java class:

CreateServer

Scripts:

create-server.sh create-server.cmd

This creates the following tables in the relational database:

_database _presentation _user

The first argument is a server configuration file. The second argument is a user configuration file.

Example files are currently in:

./resources/configuration/server/config.sample ./resources/configuration/server/users.sample

We recommend copying these into

./resources/configuration/server/config ./resources/configuration/server/users

and editing according to your local configuration, then the script can be used.

Starting a server

Java class:

StartServer

Scripts:

start-server.sh start-server.cmd

You should now be able to access your Database Wiki server through your web browser by going to:

http://localhost:8080/

Importing XML data into a new database wiki

Java class:

DatabaseImport <path> <xml-file> <user></p> <p>Scripts:</p> <p>database-import.sh <name> <title> <path> <xml-file> <user> database-import.cmd <name> <title> <path> <xml-file> <user></p> <p>The <name> is a short name for the database.</p> <p>The <title> is a descriptive name for the database.</p> <p>The <path> is the path from the root to the data entries (e.g. if the XML file is of the form</p> <things><item>...</item>...<item>...</item></things> <p>then a suitable path would be '/things').</p> <p>The <user> is the name of the user to use to record the import.</p> <h2>Importing presentation data</h2> <p>Java class:</p> <p>ImportPresentationFiles <config-file> <db-name> <path> <user></p> <p>Script:</p> <p>import-presentation-files.sh <db-name> <path> <user> import-presentation-files.cmd <db-name> <path> <user></p> <p>The <path> is the file path to the presentation files. The files should be named:</p> <path> + <db-name> + ".css" <path> + <db-name> + ".layout" <path> + <db-name> + ".template" Dropping a database wiki ------------------------ Java class: DropDatabaseWiki <config-file> Scripts: drop-database.sh drop-database.cmd You will be asked which database wiki you wish to drop. All data associated with that database wiki will be deleted. Dropping a server ----------------- Java class: DropWikiServer <config-file> Scripts: drop-wiki-server.sh drop-wiki-server.cmd You will be asked whether you also wish to drop all the database wikis. All of the tables created by CreateServer will be deleted. If you answer yes to the question, then the all the database wiki data will also be deleted. TODO: describe DatabasePackageExport and DatabasePackageImport</div> </div> <div class="footer"> <ul class="body"> <li>© <script> document.write(new Date().getFullYear()) </script> Githubissues.</li> <li>Githubissues is a development platform for aggregating issues.</li> </ul> </div> <script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js"></script> <script src="/githubissues/assets/js.js"></script> <script src="/githubissues/assets/markdown.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/highlight.min.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/languages/go.min.js"></script> <script> hljs.highlightAll(); </script> </body> </html>