diff --git a/README_SETUP.md b/README_SETUP.md index ad4dc1bfd087d235aa903dee9183b78bc6ff3094..ce6f03d7c287f3842eac6af2d017eed5a7d8bcb5 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -211,7 +211,7 @@ Stand-alone documentation is built using Sphinx: `make doc` (`l_` not found): ```sh -git clone git@github.com:simgrid/javasphinx.git +git clone https://github.com/simgrid/javasphinx.git cd javasphinx git checkout 659209069603a pip3 install . diff --git a/src/doc/CaosDB-Query-Language.md b/src/doc/CaosDB-Query-Language.md index ffa889c6b8acd0cd635049ed2aaceb748d56f2a9..0e05a56b259cb7f99cba7ad4d1dd6d1856117050 100644 --- a/src/doc/CaosDB-Query-Language.md +++ b/src/doc/CaosDB-Query-Language.md @@ -120,11 +120,11 @@ Examples: ##### `d1>d2`: Transitive, non-symmetric relation. Semantics depend on the flavors of d1 and d2. If both are... -###### [UTCDateTime](Datatype#datetime) +###### [UTCDateTime](specification/Datatype.html#datetime) * ''True'' iff the time of d1 is after the the time of d2 according to [UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). * ''False'' otherwise. -###### [SemiCompleteDateTime](Datatype#datetime) +###### [SemiCompleteDateTime](specification/Datatype.html#datetime) * ''True'' iff `d1.ILB>d2.EUB` is true or `d1.ILB=d2.EUB` is true. * ''False'' iff `d1.EUB<d2.ILB}} is true or {{{d1.EUB=d2.ILB` is true. * ''Undefined'' otherwise. @@ -142,11 +142,11 @@ Examples: ##### `d1<d2`: Transitive, non-symmetric relation. Semantics depend on the flavors of d1 and d2. If both are... -###### [UTCDateTime](Datatype#datetime) +###### [UTCDateTime](specification/Datatype.html#datetime) * ''True'' iff the time of d1 is before the the time of d2 according to [UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) * ''False'' otherwise. -###### [SemiCompleteDateTime](Datatype#datetime) +###### [SemiCompleteDateTime](specification/Datatype.html#datetime) * ''True'' iff `d1.EUB<d2.ILB` is true or `d1.EUB=d2.ILB` is true. * ''False'' iff `d1.ILB>d2.EUB}} is true or {{{d1.ILB=d2.EUB` is true. * ''Undefined'' otherwise. @@ -164,7 +164,7 @@ Examples: ##### `d1 IN d2`: Transitive, non-symmetric relation. Semantics depend on the flavors of d1 and d2. If both are... -###### [SemiCompleteDateTime](Datatype#datetime) +###### [SemiCompleteDateTime](specification/Datatype.html#datetime) * ''True'' iff (`d1.ILB>d2.ILB` is true or `d1.ILB=d2.ILB` is true) and (`d1.EUB<d2.EUB` is true or `d1.EUB=d2.EUB` is true). * ''False'' otherwise. @@ -177,7 +177,7 @@ Examples: ##### `d1 NOT IN d2`: Non-symmetric relation. Semantics depend on the flavors of d1 and d2. If both are... -###### [SemiCompleteDateTime](Datatype#datetime) +###### [SemiCompleteDateTime](specification/Datatype.html#datetime) * ''True'' iff `d1.ILB IN d2.ILB` is false. * ''False'' otherwise. diff --git a/src/doc/roles.md b/src/doc/roles.md index a036b8e4ee39290fcf4b82634bde799464e04c2e..838b3d9ec92626676c2ca16535496620bedd5842 100644 --- a/src/doc/roles.md +++ b/src/doc/roles.md @@ -32,4 +32,4 @@ There are some special roles, which are automatically assigned to users: Except for the `anonymous` role, these special roles are not returned by the server, but can nevertheless be used to define -[permissions](permissions). +[permissions](permissions.html#permissions). diff --git a/src/doc/specification/AbstractProperty.md b/src/doc/specification/AbstractProperty.md index dee88e665c1609224bdab185ea147b91c49dc8f3..3a2fe7583480c7467bccb0a2bf94850ea30d7be4 100644 --- a/src/doc/specification/AbstractProperty.md +++ b/src/doc/specification/AbstractProperty.md @@ -132,14 +132,13 @@ Any xml representation of an `AbstractProperty` that is to be posted to the Caos #### Get all *Request:* - GET http://localhost:8122/mpidsserver/AbstractProperty/ - GET http://localhost:8122/mpidsserver/AbstractProperty + GET http://localhost:8122/server/AbstractProperty/ + GET http://localhost:8122/server/AbstractProperty *Response:* <?xml version="1.0" encoding="UTF-8"?> <Response /> -[View Ticket #2](http://dev.bmp.ds.mpg.de/heartdb/ticket/2) #### Erroneous Requests ##### Non-existing *Request:* diff --git a/src/doc/specification/Datatype.md b/src/doc/specification/Datatype.md index ffc9794ea36cfe748e8c11cee2bcd32adc8ebe0a..6a169042dce2be2e6dc939d0935f3336de264308 100644 --- a/src/doc/specification/Datatype.md +++ b/src/doc/specification/Datatype.md @@ -43,7 +43,7 @@ ---- ## DATETIME -The DateTime data type exists in (currently) three flavors which are dynamically chosen during parsing on the the serverside. The flavors have different ranges, support of time zones and intended use cases. Only the first two flavors are actually implemented for storage and queries. The third one is implemented for queries exclusively. +The DateTime data type exists in (currently) three flavors which are dynamically chosen during parsing on the serverside. The flavors have different ranges, support of time zones and intended use cases. Only the first two flavors are actually implemented for storage and queries. The third one is implemented for queries exclusively. ### UTCDateTime * Description: This DATETIME flavor stores values which represent a single point of time according to [UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) with the format specified by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (Combined date and time). It does support [UTC Leap Seconds](https://en.wikipedia.org/wiki/Leap_second) and time zones. @@ -55,7 +55,7 @@ The DateTime data type exists in (currently) three flavors which are dynamically * It is allowed to ommit the nanosecond part of a UTCDateTime (`2016-01-01T13:23:00CEST`). This indicates a precision of seconds for a UTCDateTime value. ### Date - Description:: This DATETIME flavor stores values which represent a single date, month or year according to the [gregorian calendar](https://en.wikipedia.org/wiki/Gregorian_Calendar). A month/year is conceived as a single date with the presion of a month/year. This concept is useful if you try to understand the query semantics which are explained [elsewhere](./QueryLanguage#POVDateTime). + Description:: This DATETIME flavor stores values which represent a single date, month or year according to the [gregorian calendar](https://en.wikipedia.org/wiki/Gregorian_Calendar). A month/year is conceived as a single date with the presion of a month/year. This concept is useful if you try to understand the query semantics which are explained [elsewhere](../CaosDB-Query-Language.html#pov-property-operator-value). Format:: `Y[YYY][-MM[-dd]]` (where square brackets mean that the expression is optional). Range:: Any valid date according to the gregorian calendar from `-9999-01-01` to `9999-12-31` (and respective dates with lower precision. E.g. the year `-9999`). There is no year `0`. * Note: Date is a specialization of [#SemiCompleteDateTime]. @@ -73,7 +73,7 @@ Please file a new feature request as soon as you need them. ---- ## REFERENCE -* Description: REFERENCE values store the [Valid ID](./Glossary#valid-id) of an existing entity. The are useful to establish links between two entities. +* Description: REFERENCE values store the [Valid ID](../Glossary#valid-id) of an existing entity. The are useful to establish links between two entities. * Accepted Values: Any [Valid ID](./Glossary#valid-id) or [Valid Unique Existing Name](./Glossary#valid-unique-existing-name) or [Valid Unique Temporary ID](./Glossary#valid-unique-temporary-id) or [Valid Unique Prospective Name](./Glossary#valid-unique-prospective-pame). * Note: * After beeing processed successfully by the server the REFERENCE value is normalized to a [Valid ID](./Glossary#valid-id). I.e. it is guaranteed that a REFERENCE value of a valid property is a positive integer. diff --git a/src/doc/specification/RecordType.rst b/src/doc/specification/RecordType.rst index 0c196fea86e74f1014e34c0bd1e5b096acd1a5d9..53e8e1613dddeea901e1b8404f186d67ebc2be23 100644 --- a/src/doc/specification/RecordType.rst +++ b/src/doc/specification/RecordType.rst @@ -190,8 +190,6 @@ Get all <?xml version="1.0" encoding="UTF-8"?> <Response /> -[View Ticket #2](http://caosdb.example.com/caosdb/ticket/2) - POST Requests ~~~~~~~~~~~~~