Skip to content

Commit

Permalink
Fix typos (#352)
Browse files Browse the repository at this point in the history
* Fix typos and add identifier parameter information

* Revert "Merge branch 'main' of https://github.com/dasch-swiss/sipi into main"

This reverts commit d0c06cb, reversing
changes made to 5e3db65.

* Revert "Revert "Merge branch 'main' of https://github.com/dasch-swiss/sipi into main""

This reverts commit 5c68caa.
  • Loading branch information
julsraemy authored Mar 12, 2021
1 parent a24b319 commit 0f45ad2
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If you must build sipi, the preferred way is to build it inside a docker image.
Then, in the top directory of the source tree, do

- ```make compile``` will download and compile SIPI within a docker container
- ```make test`` to run the full test suite
- ```make test``` to run the full test suite
- ```make run``` to run SIPI in docker image

### macOS
Expand Down
8 changes: 4 additions & 4 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
JPEG2000 implementation, it relies on the commercial [kakadu-library](https://kakadusoftware.com), but otherwise it is
completely open source on [github](https://github.com/dasch-swiss/sipi). It offers special support for multipage PDF's
(through a SIPI-specific extensions to the IIIF Image API).
- SIPI has been designed with long term preservation for images regarded as culutral heritage in mind. Thus it offers
some unique features fpr this purpose:
- SIPI has been designed with long term preservation for images regarded as cultural heritage in mind. Thus it offers
some unique features for this purpose:
- all file format conversions try to preserve all metadata (EXIF, XMP, IPTC etc.). These functionality is based
on the open source [exiv2 library](https://www.exiv2.org).
- SIPI can deal with and convert ICC color profiles based on the [littlecms library](http://www.littlecms.com).
Expand Down Expand Up @@ -38,7 +38,7 @@
preservation and include the following information:
- `original filename`: The original file name before conversion
- `original mimetype`: The mimetype of the original image before conversion
- `pixel checksum`: A checksum (e.g. SH256) of the original pixel values. This checksum can be used to verify that
- `pixel checksum`: A checksum (e.g. SHA-256) of the original pixel values. This checksum can be used to verify that
a format conversion didn't alter the image content.
- `icc profile`: (optional) The raw ICC profile as binary string. This field is added if the fileformat has no
standard way to embed ICC color profiles (e.g. JPEG).
Expand All @@ -50,7 +50,7 @@ images, user data etc.

## Who is behind SIPI?
SIPI is developed and maintained by the "Data and Service Center for the Humanities" [(DaSCH)](https://dasch.swiss),
a Swiss national research infrastructure financed by the Swiss National Science Foundation with contributions by the
a Swiss national research infrastructure financed by the Swiss National Science Foundation [(SNSF)](http://www.snf.ch/) with contributions by the
Universities of Basel and Lausanne.

## How to get SIPI?
Expand Down
1 change: 1 addition & 0 deletions docs/sipi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The parts do have the following meaning:

- `{server}`: The DNS name of the server, eg. `iiif.dasch.swiss`. The server may include a portnumber,
eg. `iiif2.dasch.swiss:8080`.
- `{identifier}`: The identifier of the requested image. By default, it is the filename and its extension.
- `{prefix}`: A path (that may include `/`'s) to organize the assets. Usually the prefix reflect the internal
directory or folder hierarchy. However this can be overridden using special features of SIPI (see pre-flight-script
and sipi configuration file).
Expand Down

0 comments on commit 0f45ad2

Please sign in to comment.