You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by ij...@apache.org on 2012/01/12 15:57:46 UTC
svn commit: r1230575 - in
/incubator/jena/site/trunk/content/jena/documentation/serving_data:
index.mdtext soh.mdtext
Author: ijd
Date: Thu Jan 12 14:57:45 2012
New Revision: 1230575
URL: http://svn.apache.org/viewvc?rev=1230575&view=rev
Log:
Applied some more user-suggested tweaks to Fuseki documentation
Modified:
incubator/jena/site/trunk/content/jena/documentation/serving_data/index.mdtext
incubator/jena/site/trunk/content/jena/documentation/serving_data/soh.mdtext
Modified: incubator/jena/site/trunk/content/jena/documentation/serving_data/index.mdtext
URL: http://svn.apache.org/viewvc/incubator/jena/site/trunk/content/jena/documentation/serving_data/index.mdtext?rev=1230575&r1=1230574&r2=1230575&view=diff
==============================================================================
--- incubator/jena/site/trunk/content/jena/documentation/serving_data/index.mdtext (original)
+++ incubator/jena/site/trunk/content/jena/documentation/serving_data/index.mdtext Thu Jan 12 14:57:45 2012
@@ -16,7 +16,7 @@ track the draft standards.
See also:
-- [SPARQL Over HTTP](soh.html "SOH") â command line tools for working with any SPARQL 1.1 system
+- [SPARQL Over HTTP](soh.html "SOH") â command-line tools for working with any SPARQL 1.1 system
## Contents
@@ -39,8 +39,8 @@ Fuseki builds will be migrating to the A
Snapshot builds are
available via Apache Maven or can be [downloaded from here](https://repository.apache.org/content/repositories/snapshots/org/apache/jena/jena-fuseki/).
-Choose the version directory then look for the file
-fuseki-*VER*.zip. For snapshots, `VER` includes the timestamp and increment
+Choose the version directory, then look for the file
+`fuseki-*VER*.zip`. For snapshots, `VER` includes the timestamp and increment
number as generated by Maven. The most recent build at the time of writing
(January 2012) is Fuseki 0.21-SNAPSHOT.
@@ -56,12 +56,12 @@ Filename | Description
This section provides a brief guide to getting up and running with
a simple server installation. It uses the
-[SOH (SPARQL over HTTP)](soh.html "SOH") scripts included in the
+[SOH (SPARQL over HTTP)](soh.html) scripts included in the
download.
1. Download (this includes the server and the SOH scripts)
2. Unzip
-3. (Linux) chmod +x fuseki-server s-\*
+3. (Linux) `chmod +x fuseki-server s-\*`
4. Run a server
fuseki-server --update --mem /dataset
@@ -88,7 +88,7 @@ The Fuseki download includes a number of
For the control panel:
1. In a browser, go to
- [http://localhost:3030/](http://localhost:3030/ "http://localhost:3030/")
+ [`http://localhost:3030/`](http://localhost:3030/)
2. Click on "Control Panel
3. Select the dataset (if set up above, there is only one choice).
@@ -120,17 +120,17 @@ Update it with SPARQL using the .../upda
Fuseki does not have any security yet. This will change.
Data can be updated without access control if the server is started
-with the --update argument. If started without that argument, data
+with the `--update` argument. If started without that argument, data
is read-only.
## Logging
Fuseki uses
-[Log4J](http://logging.apache.org/log4j/ "http://logging.apache.org/log4j/")
+[Log4J](http://logging.apache.org/log4j/)
for logging. There are two main logging channels:
-1. The general server messages : org.openjena.fuseki.Server
-2. A channel for all request messages: org.openjena.fuseki.Fuseki
+1. The general server messages : `org.openjena.fuseki.Server`
+2. A channel for all request messages: `org.openjena.fuseki.Fuseki`
The default settings are (this is an extract of a log4j properties
file):
@@ -147,19 +147,19 @@ file):
This details the service URIs for Fuseki:
-- http://host/*dataset*/query -- the SPARQL query endpoint.
-- http://host/*dataset*/update -- the SPARQL Update language
+- `http://host/`* dataset *`/query` -- the SPARQL query endpoint.
+- `http://host/`* dataset *`/update` -- the SPARQL Update language
endpoint.
-- http://host/*dataset*/data -- the SPARQL Graph Store Protocol
+- `http://host/`* dataset *`/data` -- the SPARQL Graph Store Protocol
endpoint.
-- http://host/*dataset*/upload -- the file upload endpoint.
+- `http://host/`* dataset *`/upload` -- the file upload endpoint.
where *dataset* is a URI path. Note that Fuseki defaults to using
port 3030 so *host* is often *localhost:3030*.
The URI
-[http://host/dataset/sparql](http://host/dataset/sparql "http://host/dataset/sparql")
-is currently mapped to /query but this may change to being a
+[`http://host/dataset/sparql`](http://host/dataset/sparql)
+is currently mapped to `/query` but this may change to being a
general purpose SPARQL query endpoint.
## Fuseki assumptions
@@ -167,11 +167,11 @@ general purpose SPARQL query endpoint.
Where the standards allow variability or are not yet precisely
defined, Fuseki makes certain assumptions.
-1. ?default names the default graph for SPARQL HTTP Update.
+1. `?default` names the default graph for SPARQL HTTP Update.
2. SPARQL Updates are sent by POSTing the SPARQL update request as
- the body of the POST with content type application/sparql-update
+ the body of the POST with content type `application/sparql-update`
3. SPARQL Update over HTML Forms is supported with parameter
- request=
+ `request=`
## Running a Fuseki Server
@@ -192,7 +192,7 @@ defaults to 3030.
`/DatasetPathName` is the name under which the dataset will be
accessible over HTTP.
-The server will service read requests only unless the --update
+The server will service read requests only unless the `--update`
argument is used.
The full choice of dataset forms is:
@@ -225,7 +225,7 @@ Fuseki does not offer any security and a
Authentication and control of the number of concurrent request can
be added using an Apache server and either blocking the Fuseki port
to outside traffic (e.g. on Amazon's EC2) or by listening only the
-"localhost" network interface. This is especially import for update
+`localhost` network interface. This is especially import for update
endpoints (SPARQL Update, SPARQL Graph Store protocol with
PUR/POST/DELETE enabled).
@@ -240,7 +240,7 @@ accessed via the appropriate protocol at
- SPARQL update: `http://localhost:3030/dataset/update`
- SPARQL HTTP update: `http://localhost:3030/dataset/data`
-The [SPARQL Over HTTP](soh.html "SOH") scripts take care of naming
+The [SPARQL Over HTTP](soh.html) scripts take care of naming
and protocol details. For example, to load in a file `data.rdf`:
s-put http://localhost:3030/dataset/data default data.rdf
@@ -271,7 +271,7 @@ The form:
fuseki-server --loc=DB /dataset
-is a shorthand for such an assembler with location "DB".
+is a shorthand for such an assembler with location `DB`.
To make triples from all the named graphs appear as the default,
unnamed graph, use:
@@ -284,13 +284,13 @@ unnamed graph, use:
## Fuseki Server and general dataset descriptions
The Fuseki server can be given an
-[assembler description](assembler.html "http://openjena.org/assembler/index.html")
+[assembler description](assembler.html)
to build a variety of model and datasets types.
fuseki-server --desc assembler.ttl /dataset
Full details of setting up models assembler is given in the
-[assembler documentation](assembler.html "http://openjena.org/assembler/index.html").
+[assembler documentation](assembler.html).
A general dataset is described by:
@@ -316,7 +316,7 @@ The models can be
## Fuseki Configuration File
A Fuseki server can be setup using a configuration file. The
-command line arguments for publishing a single dataset are a short
+command-line arguments for publishing a single dataset are a short
cut that, internally, builds a default configuration based on the
dataset name given.
@@ -365,7 +365,7 @@ with its datasets.
### Assembler Initialization
All datasets are described by
-[assembler descriptions](assembler.html "http://openjena.org/assembler/index.html").
+[assembler descriptions](assembler.html).
Assemblers provide an extensible way of describing many kinds of
objects. Set up any assembler extensions - here, the TDB assembler
support.
@@ -448,11 +448,11 @@ or making the default graph the union of
## SPARQL Over HTTP
-"SOH" (SPARQL Over HTTP) is a set of command line scripts for
-working with SPARQL 1.1. It is server-independent and will work
+**SOH** (SPARQL Over HTTP) is a set of command-line scripts for
+working with SPARQL 1.1. SOH is server-independent and will work
with any compliant SPARQL 1.1 system offering HTTP access.
-See the [SPARQL Over HTTP](soh.html "SOH") page.
+See the [SPARQL Over HTTP](soh.html) page.
### Examples
@@ -500,5 +500,5 @@ This creates a standalone jar for the Fu
target/fuseki-version-server.jar
-See the file SETUP.txt for working with Eclipse.
+See the file `SETUP.txt` for working with Eclipse.
Modified: incubator/jena/site/trunk/content/jena/documentation/serving_data/soh.mdtext
URL: http://svn.apache.org/viewvc/incubator/jena/site/trunk/content/jena/documentation/serving_data/soh.mdtext?rev=1230575&r1=1230574&r2=1230575&view=diff
==============================================================================
--- incubator/jena/site/trunk/content/jena/documentation/serving_data/soh.mdtext (original)
+++ incubator/jena/site/trunk/content/jena/documentation/serving_data/soh.mdtext Thu Jan 12 14:57:45 2012
@@ -1,30 +1,30 @@
Title: SOH - SPARQL over HTTP
-"SOH" (SPARQL Over HTTP) is a set of command line scripts for
-working with SPARQL 1.1. It is server-independent and will work
+**SOH** (SPARQL Over HTTP) is a set of command-line scripts for
+working with SPARQL 1.1. SOH is server-independent and will work
with any compliant SPARQL 1.1 system offering HTTP access.
SOH is written in ruby.
Commands:
-- s-http â SPARQL 1.1 HTTP Protocol
-- s-get, s-put, s-delete, s-post, s-head â abbreviation for
- "s-http get ..." etc.
-- s-query â SPARQL 1.1 Query, both GET and POST of queries.
-- s-update â SPARQL 1.1 Update
-- s-update-form â SPARQL 1.1 Update using the HTML form and a
- parameter of "request=" (compatible with Joseki).
+- `s-http` â SPARQL 1.1 HTTP Protocol
+- `s-get`, `s-put`, `s-delete`, `s-post`, `s-head` â abbreviation for
+ `s-http get ...` etc.
+- `s-query` â SPARQL 1.1 Query, both GET and POST of queries.
+- `s-update` â SPARQL 1.1 Update
+- `s-update-form` â SPARQL 1.1 Update using the HTML form and a
+ parameter of `request=` (compatible with Joseki).
-Each command supports the "-v" flag to print out details of the
+Each command supports the `-v` flag to print out details of the
HTTP interaction.
## Contents
-- [SOH SPARQL HTTP](#SOH_SPARQL_HTTP)
-- [SOH SPARQL Query](#SOH_SPARQL_Query)
-- [SOH SPARQL Update](#SOH_SPARQL_Update)
-- [Service endpoints](#Service_endpoints)
+- [SOH SPARQL HTTP](#soh_sparql_http)
+- [SOH SPARQL Query](#soh_sparql_query)
+- [SOH SPARQL Update](#soh_sparql_update)
+- [Service endpoints](#service_endpoints)
## SOH SPARQL HTTP
@@ -36,10 +36,10 @@ The syntax of the commands is:
where graph name is a URI or the work *default* for the default
graph.
-s-get, s-put, s-delete, s-post abbreviations for "s-http get",
-"s-http put", "s-http delete", "s-http post" respectively.
+`s-get`, `s-put`, `s-delete`, `s-post` are abbreviations for `s-http get`,
+`s-http put`, `s-http delete` and `s-http post` respectively.
-file is needed for PUT and POST. The file name extension determines
+`file` is needed for PUT and POST. The file name extension determines
the HTTP content type.
s-put http://localhost:3030/dataset default data.ttl
@@ -74,31 +74,31 @@ If you have details for other servers, (
### Fuseki
-If a [Fuseki](fuseki.html "Fuseki") server is run with the
+If a [Fuseki](fuseki.html) server is run with the
command:
fuseki-server --mem /dataset
then the service endpoints are:
-- HTTP: http://localhost:3030/dataset/data
-- Query: http://localhost:3030/dataset/query
-- Update: http://localhost:3030/dataset/update
+- HTTP: `http://localhost:3030/dataset/data`
+- Query: `http://localhost:3030/dataset/query`
+- Update: `http://localhost:3030/dataset/update`
### Joseki
-[Joseki](http://www.joseki.org/ "http://www.joseki.org/") allows a
+[Joseki](http://www.joseki.org/) allows a
choice of server endpoint names in the configuration file.
Used with the default configuration file joseki-config.ttl:
- Query:
- - http://localhost:2020/books -- example books database
- - http://localhost:2020/sparql -- general purpose SPARQL query
+ - `http://localhost:2020/books` -- example books database
+ - `http://localhost:2020/sparql` -- general purpose SPARQL query
engine
- - http://localhost:2020/sparql/read -- companion to updatable
+ - `http://localhost:2020/sparql/read` -- companion to updatable
dataset (if enabled)
-- Update: http://localhost:2020/update/service (if enabled)
+- Update: `http://localhost:2020/update/service` (if enabled)
- HTTP: Not supported