495 Matching Annotations
  1. Feb 2021
  2. Jan 2021
    1. every document could disappear 6 months after it's published unless whoever uploaded or created it says otherwise in an email the system sends them after six months, documents shouldn't live rent free

      this is a great idea to ensure that documentation doesn't become stale.

    1. Reload the systemd manager configuration. This will rerun all generators (see systemd.generator(7)), reload all unit files, and recreate the entire dependency tree. While the daemon is being reloaded, all sockets systemd listens on behalf of user configuration will stay accessible.
  3. Nov 2020
  4. Oct 2020
    1. I'm afraid there's only so much the docs & tutorials can do about something like this actually. When you first read them, you don't get Svelte well enough (since you're reading a tutorial...) for this to make sense to you. Then you try something, encounter a behaviour, question it, understand better... That's learning.
    2. Anyway, If this is an expected behaviour, we should probably add an asterisk to the docs, describing the pitfall, because I believe many will be bitten by this.
  5. Sep 2020
    1. I really have no idea how you came up with this solution but that reflects a major problem with many npm packages, i.e. 90 percent of the library documentation should be pulled from the Git issues or SO answers.
  6. Aug 2020
    1. All of the components should allow passing MUI configuration properties to them so that they can be easily customized. In the case of RFF and MUI components with deeply nested structures of multiple subcomponents, you can pass the properties in with sepecial top level properties. This is very hard to document fully without making a mess, so please refer to the source code and demos for examples.
  7. Jul 2020
  8. Jun 2020
  9. May 2020
    1. If we find that GitLab doesn't work as people expect, the documentation should be updated so this is no longer a surprise. This applies whether we classify it as a feature request or a bug.
  10. Apr 2020
    1. Sometimes, the best way to learn is to mimic others. Here are some great examples of projects that use documentation well:

      Examples of projects that use documentation well

      (chech the list below)

    2. “Code is more often read than written.” — Guido van Rossum
    3. Documenting code is describing its use and functionality to your users. While it may be helpful in the development process, the main intended audience is the users.

      Documenting code:

      • describing use to your users (main audience)
    4. Class method docstrings should contain the following: A brief description of what the method is and what it’s used for Any arguments (both required and optional) that are passed including keyword arguments Label any arguments that are considered optional or have a default value Any side effects that occur when executing the method Any exceptions that are raised Any restrictions on when the method can be called

      Class method should contain:

      • brief description
      • arguments
      • label on default/optional arguments
      • side effects description
      • raised exceptions
      • restrictions on when the method can be called

      (check example below)

    5. Comments to your code should be kept brief and focused. Avoid using long comments when possible. Additionally, you should use the following four essential rules as suggested by Jeff Atwood:

      Comments should be as concise as possible. Moreover, you should follow 4 rules of Jeff Atwood:

      1. Keep comments close to the code being described.
      2. Don't use complex formatting (such as tables).
      3. Don't comment obvious things.
      4. Design code in a way it comments itself.
    6. From examining the type hinting, you can immediately tell that the function expects the input name to be of a type str, or string. You can also tell that the expected output of the function will be of a type str, or string, as well.

      Type hinting introduced in Python 3.5 extends 4 rules of Jeff Atwood and comments the code itself, such as this example:

      def hello_name(name: str) -> str:
          return(f"Hello {name}")
      
      • user knows that the code expects input of type str
      • the same about output
    7. Docstrings can be further broken up into three major categories: Class Docstrings: Class and class methods Package and Module Docstrings: Package, modules, and functions Script Docstrings: Script and functions

      3 main categories of docstrings

    8. According to PEP 8, comments should have a maximum length of 72 characters.

      If comment_size > 72 characters:

      use `multiple line comment`
      
    9. Docstring conventions are described within PEP 257. Their purpose is to provide your users with a brief overview of the object.

      Docstring conventions

    10. All multi-lined docstrings have the following parts: A one-line summary line A blank line proceeding the summary Any further elaboration for the docstring Another blank line

      Multi-line docstring example:

      """This is the summary line
      
      This is the further elaboration of the docstring. Within this section,
      you can elaborate further on details as appropriate for the situation.
      Notice that the summary and the elaboration is separated by a blank new
      line.
      
      # Notice the blank line above. Code should continue on this line.
      
    11. say_hello.__doc__ = "A simple function that says hello... Richie style"

      Example of using __doc:

      Code (version 1):

      def say_hello(name):
          print(f"Hello {name}, is it me you're looking for?")
      
      say_hello.__doc__ = "A simple function that says hello... Richie style"
      

      Code (alternative version):

      def say_hello(name):
          """A simple function that says hello... Richie style"""
          print(f"Hello {name}, is it me you're looking for?")
      

      Input:

      >>> help(say_hello)
      

      Returns:

      Help on function say_hello in module __main__:
      
      say_hello(name)
          A simple function that says hello... Richie style
      
    12. class constructor parameters should be documented within the __init__ class method docstring

      init

    13. Scripts are considered to be single file executables run from the console. Docstrings for scripts are placed at the top of the file and should be documented well enough for users to be able to have a sufficient understanding of how to use the script.

      Docstrings in scripts

    14. Documenting your code, especially large projects, can be daunting. Thankfully there are some tools out and references to get you started

      You can always facilitate documentation with tools.

      (check the table below)

    15. Commenting your code serves multiple purposes

      Multiple purposes of commenting:

      • planning and reviewing code - setting up a code template
      • code description
      • algorithmic description - for example, explaining the work of an algorithm or the reason of its choice
      • tagging - BUG, FIXME, TODO
    16. In general, commenting is describing your code to/for developers. The intended main audience is the maintainers and developers of the Python code. In conjunction with well-written code, comments help to guide the reader to better understand your code and its purpose and design

      Commenting code:

      • describing code to/for developers
      • help to guide the reader to better understand your code, its purpose/design
    17. Along with these tools, there are some additional tutorials, videos, and articles that can be useful when you are documenting your project

      Recommended videos to start documenting

      (check the list below)

    18. If you use argparse, then you can omit parameter-specific documentation, assuming it’s correctly been documented within the help parameter of the argparser.parser.add_argument function. It is recommended to use the __doc__ for the description parameter within argparse.ArgumentParser’s constructor.

      argparse

    19. There are specific docstrings formats that can be used to help docstring parsers and users have a familiar and known format.

      Different docstring formats:

    20. Daniele Procida gave a wonderful PyCon 2017 talk and subsequent blog post about documenting Python projects. He mentions that all projects should have the following four major sections to help you focus your work:

      Public and Open Source Python projects should have the docs folder, and inside of it:

      • Tutorials
      • How-To Guides
      • References
      • Explanations

      (check the table below for a summary)

    21. Since everything in Python is an object, you can examine the directory of the object using the dir() command

      dir() function examines directory of Python objects. For example dir(str).

      Inside dir(str) you can find interesting property __doc__

    22. Documenting your Python code is all centered on docstrings. These are built-in strings that, when configured correctly, can help your users and yourself with your project’s documentation.

      Docstrings - built-in strings that help with documentation

    23. Along with docstrings, Python also has the built-in function help() that prints out the objects docstring to the console.

      help() function.

      After typing help(str) it will return all the info about str object

    24. The general layout of the project and its documentation should be as follows:
      project_root/
      │
      ├── project/  # Project source code
      ├── docs/
      ├── README
      ├── HOW_TO_CONTRIBUTE
      ├── CODE_OF_CONDUCT
      ├── examples.py
      

      (private, shared or open sourced)

    25. In all cases, the docstrings should use the triple-double quote (""") string format.

      Think only about """ when using docstrings

    1. TSDoc is a way of writing TypeScript comments where they’re linked to a particular function, class or method (like Python docstrings).

      TSDoc <--- TypeScript comment syntax. You can create documentation with TypeDoc

    1. OpenCV (Open Source Computer Vision Library) is an open source computer vision and machine learning software library. OpenCV was built to provide a common infrastructure for computer vision applications and to accelerate the use of machine perception in the commercial products. Being a BSD-licensed product, OpenCV makes it easy for businesses to utilize and modify the code. The library has more than 2500 optimized algorithms, which includes a comprehensive set of both classic and state-of-the-art computer vision and machine learning algorithms. These algorithms can be used to detect and recognize faces, identify objects, classify human actions in videos, track camera movements, track moving objects, extract 3D models of objects, produce 3D point clouds from stereo cameras, stitch images together to produce a high resolution image of an entire scene, find similar images from an image database, remove red eyes from images taken using flash, follow eye movements, recognize scenery and establish markers to overlay it with augmented reality, etc. OpenCV has more than 47 thousand people of user community and estimated number of downloads exceeding 18 million. The library is used extensively in companies, research groups and by governmental bodies. Along with well-established companies like Google, Yahoo, Microsoft, Intel, IBM, Sony, Honda, Toyota that employ the library, there are many startups such as Applied Minds, VideoSurf, and Zeitera, that make extensive use of OpenCV. OpenCV’s deployed uses span the range from stitching streetview images together, detecting intrusions in surveillance video in Israel, monitoring mine equipment in China, helping robots navigate and pick up objects at Willow Garage, detection of swimming pool drowning accidents in Europe, running interactive art in Spain and New York, checking runways for debris in Turkey, inspecting labels on products in factories around the world on to rapid face detection in Japan. It has C++, Python, Java and MATLAB interfaces and supports Windows, Linux, Android and Mac OS. OpenCV leans mostly towards real-time vision applications and takes advantage of MMX and SSE instructions when available. A full-featured CUDAand OpenCL interfaces are being actively developed right now. There are over 500 algorithms and about 10 times as many functions that compose or support those algorithms. OpenCV is written natively in C++ and has a templated interface that works seamlessly with STL containers.
  11. Mar 2020
    1. Used By

      I like how they have indexed their core code base so they can show in both directions:

      • which other core functions a function uses
      • which other core functions use this function (references)
  12. Feb 2020
    1. Write things down We document everything: in the handbook, in meeting notes, in issues. We do that because "the faintest pencil is better than the sharpest memory." It is far more efficient to read a document at your convenience than to have to ask and explain. Having something in version control also lets everyone contribute suggestions to improve it.
  13. Dec 2019
    1. Aside from testing, we place high value in documenting code. It's our legacy for anyone who will be working with our codebase in the future. Fortunately, having a component library like Storybook allows us to document components visually and declaratively. Storybook provides a developer with all the information needed to understand the structure and state of a component.
  14. Nov 2019
    1. Peer Dependencies react-hooks-testing-library does not come bundled with a version of react or react-test-renderer to allow you to install the specific version you want to test against.
  15. Oct 2019
    1. Tutorials and how-to guides are similar because they are both concerned with describing practical steps, while what how-to guides share with technical referenceis that they’re what we need when we are actually at work, coding. Reference guides and explanation are similar because they’re concerned with theoretical knowledge, and finally, what tutorials have in common with explanation is that they are most useful when we are studying, rather than actually working

      Difference between tutorials, how-to guides, explanation and reference:

    1. "http://lobid.org/items/HT019025795:DE-Kn3:KMB%2FYG%20BERLINW%2033%20%202016%20A#!"
      Beschreibung

      Durch Folgen der URI gelangt man zu einer Einzelansicht für das Exemplar. Die dort angezeigten Daten sind ebenfalls als JSON-LD verfügbar. Siehe [Link](##### Beschreibung

      Durch Folgen der URI gelangt man zu einer Einzelansicht für das Exemplar. Die dort angezeigten Daten sind ebenfalls als JSON-LD verfügbar. Siehe Link für die markierte Ressource.

  16. Sep 2019
  17. Aug 2019
  18. Jul 2019
    1. "classification"
      Name

      Spezieller Organisationstyp

      Beschreibung

      Diese Klassifikation liefert eine granulare Unterscheidung verschiedener Einrichtungstypen. Das verwendete SKOS-Schema basiert auf der Klassifikation des deutschen ISIL-Verzeichnis.

      Abdeckung

      Zu jeder Institution wird der detaillierte Typ angegeben.

      Verwendungsbeispiele

      Auflistung aller Bibliotheken, die als Wissenschaftliche Spezialbibliothek klassifiziert sind.

      URI

      http://www.w3.org/ns/org#classification

    1. "rs"
      Name

      Region key

      Description

      The key of the administrative area the organization is located in.

      Coverage

      Only applies to organizations in Germany. Currently missing in more than 2000 entries of institutions in Germany.

      Use cases
      URI

      http://purl.org/lobid/lv#rs

  19. Apr 2019
    1. It is important to understand the interaction between aggregates and SQL's WHERE and HAVING clauses. The fundamental difference between WHERE and HAVING is this: WHERE selects input rows before groups and aggregates are computed (thus, it controls which rows go into the aggregate computation), whereas HAVING selects group rows after groups and aggregates are computed. Thus, the WHERE clause must not contain aggregate functions; it makes no sense to try to use an aggregate to determine which rows will be inputs to the aggregates. On the other hand, the HAVING clause always contains aggregate functions. (Strictly speaking, you are allowed to write a HAVING clause that doesn't use aggregates, but it's seldom useful. The same condition could be used more efficiently at the WHERE stage.)

      WHERE >> AGGREGATE >> HAVING (use aggregate functions)

      this is SQL procedural sequence on data querying.

      and yes HAVING kind of do almost the same thing in WHERE. but it accepts the grouping and aggregation functions that fails to be in WHERE.

  20. Mar 2019
    1. "sameAs"

      Name: Weitere Profile

      Beschreibung: Profile des Dienstes in sozialen Netzwerken wie Twitter, Instagram, GitHub etc.

      Pflichtfeld?: nein

      Typ: Array, URL

    2. "license"

      Name: Lizenz(en)

      Beschreibung: Die Lizenz(en), unter denen die angebotenen Inhalte veröffentlicht sind. Angegeben werden die URL zur Lizenz

      Pflichtfeld?: nein

      Typ: Array, URL

    3. "dateModified"

      Name: Änderungsdatum

      Beschreibung: Das letzte Änderungsdatum der Visitenkarte

      Pflichtfeld?: ja

      Typ: Date, Format ISO 8601

    4. "schemaVersion"

      Name: Link zum genutzen Schema

      Beschreibung: Link zur genutzen Version des Schemas für dei Validierung der Visitenkarte

      Pflichtfeld?: ja

      Typ: URL

    5. "serviceType"

      Name: Schnittstellentyp

      Beschreibung: Die Art der maschinellen Schnittstelle

      Pflichtfeld?: nein

      Typ: String

      Beispielewerte: Search, Sitemap, OAI-PMH, Statistics, embed (oEmbed), Generic_Api

    6. "documentation"

      Name: Schnittstellendokumentation

      Beschreibung: Ein Link zur Dokumentation der Schnittstelle

      Pflichtfeld?: nein

      Typ: URL

    7. "serviceUrl"

      Name: API-Endpoint

      Beschreibung: Der URL des Schnittstellen-Endpunkts

      Pflichtfeld?: nein

      Typ: URL

    8. "type"

      Name: Typ des Objekts

      Beschreibung: Angabe der Typen ServiceChannel und WebAPI

      Pflichtfeld?: nein

      Typ: Array, URL

      Werte: ServiceChannel, WebAPI

    9. "addressLocality"

      Name: Ort

      Beschreibung: Der name des Ortes, in dem der Betreiber sitzt.

      Pflichtfeld?: nein

      Typ: String

    10. "postalCode"

      Name: Postleitzahl

      Beschreibung: Die Postleitzahl des Sitzes des betreibers

      Pflichtfeld?: nein

      Typ: Integer

    11. "streetAddress"

      Name: Straße

      Beschreibung: Die Straße, in der der Betreiber sitzt

      Pflichtfeld?: nein

      Typ: String

    12. "addressCountry"

      Name: Land

      Beschreibung: Das Land, in dem der Betreiber sitzt

      Pflichtfeld?: nein

      Typ: String

      Werte: ISO 3166-1 Codes

    13. "type"

      Name: Typ des Objekts

      Beschreibung: Angabe des Typs PostalAddress

      Pflichtfeld?: ja

      Typ: URL

      Wert: PostalAddress

    14. "type"

      Name: Typ des Objekts

      Beschreibung: Angabe des Typs GeoCoordinates

      Pflichtfeld?: ja

      Typ: URL

      Wert: GeoCoordinates

    15. "address"

      Name: Adresse

      Beschreibung: Die Adresse der Anbieters

    16. "latitude"

      Name: Geographische Breite

      Pflichtfeld?: nein

      Typ: Nummerischer Wert

    17. "longitude"

      Name: Geographische Länge

      Pflichtfeld?: nein

      Typ: Nummerischer Wert

    18. "geo"

      Name: Geokoordinaten

      Beschreibung: Dieses JSON-Objekt beinhaltet die Angaben zur Geoposition der Einrichtung nach WGS 84.

      Pflichtfeld?: nein

      Typ:

    19. "location"

      Name: Standort

      Beschreibung: Im location-Objekt befinden sich Angaben zum Sitz des Anbieters: Anschrift und Geokoordinaten.

      Pflichtfeld?: nein

      Typ: Objekt

    20. "type"

      Name: Typ des Objekts

      Beschreibung: Angabe des Typs Place

      Pflichtfeld?: ja

      Typ: URL

      Wert: Place

    21. "email"

      Name: E-Mail-Adresse des Anbieters

      Beschreibung: Die E-Mail-Adresse des Anbieters

      Pflichtfeld?: nein

      Typ: Text (Format)

    22. "type"

      Name: Typ des Anbieters

      Beschreibung: Angabe, ob der Anbieter eine Organisation oder Gruppe (Organization) oder eine Einzelperson (Person) ist. Pflichtfeld?: ja

      Typ: Array, URL

      Mögliche Werte: Organization, Person

    23. "name"

      Name: Name des Anbieters

      Beschreibung: Der Name des Dienstanbieters

      Pflichtfeld?: ja

      Typ: String

    24. "provider"

      Name: Anbieter des Dienstes

      Beschreibung: Die Organisation, Gruppe oder Einzelperson, die den Dienst anbietet

      Pflichtfeld?: ja

      Typ: Array, Objekt

      Felder: type (Pflicht), name (Pflicht), email, location, id

    25. "availableChannel"

      Name: Schnittstellen des Dienstes

      Beschreibung: Angabe von Maschninenschnittstellen zum Dienst, deren Art und Dokumentation.

      Pflichtfeld?: ja

      Typ: Array, Objekt

      Felder: type (Pflicht), serviceURL (Pflicht), serviceType, documentation

    26. "startDate"

      Name: Launch-Datum

      Beschreibung: Das Datum, an dem der Dienst offiziell gelauncht wurde

      Pflichtfeld?: nein

      Typ: Date, Format ISO 8601

    27. "isAccessibleForFree"

      Name: Zugangsfreiheit

      Beschreibung: Ist die Nutzung des Dienstes ohne Zugangsbeschränkungen (Registrierung, Authentifizierung) möglich und die Inhalte ohne Einschränkungen erreichbar?

      Pflichtfeld?: nein

      Typ: Boolean

    28. "about"

      Name: Fach/Thema der Inhalte

      Beschreibung: Die Fächer bzw. Themen, zu denen der Dienst Open Educational Resources (OER) anbietet. Die Werte sollten URLs aus einer kontrollierten Liste sein.

      Pflichtfeld?: nein

      Typ: Array, URL

    29. "audience"

      Name: Zielgruppe(n) des Angebotes

      Beschreibung: Die Zielgruppe, auf der das Angebot des Dienstes ausgerichtet ist.

      Pflichtfeld?: nein

      Typ: Array, URL

      Werteliste: http://purl.org/dcx/lrmi-vocabs/educationalAudienceRole/

    30. "serviceType"

      Name: Art des Dienstes

      Beschreibung: Die Art des Dienstes

      Pflichtfeld?: ja

      Typ: Array, String

      Beispielwerte: Repository, Referatory, Wiki, LMS

    31. id

      Name: URL als Identifiktator

      Beschreibung: Die URL, durch den der Dienst identifiziert wird. Das ist in der Regel die Homepage. Auf dieser URL MUSS die Visitenkarte später findbar / abrufbar sein

      Pflichtfeld?: ja

      Typ: URL

    32. "name"

      Name: Name des Dienstes

      Beschreibung: Der Name des OER-Services

      Pflichtfeld?: ja

      Typ: String

    33. "description"

      Name: Beschreibung des Dienstes

      Beschreibung: Eine kurze Beschreibung des Dienstes.

      Pflichtfeld?: nein

      Typ: String

    34. "inLanguage"

      Name: Sprache(n) des Hauptangebotes

      Beschreibung: Die Sprachen der Open Educational Resources (OER), die der Dienst anbietet.

      Pflichtfeld?: nein

      Typ: Array, String

    35. "image"

      Name: Icon des Dienstes

      Beschreibung: Ein Link zu einer Bilddatei mit einem Icon des Dienstes, das etwa zur Kennzeichnung von Einträgen in einer Suchergebnisliste genutzt werden kann. Die verlinkte Datei sollte im Format svg oder png sein und eine Größe von 64x64px haben.

      Pflichtfeld?: nein

      Typ: URL

      Dateiformat: Das verlinkte Bild sollte eine svg- oder png-Datei sein mi8t 64x64px.

    36. "logo"

      Name: Logo des Dienstes

      Beschreibung: Ein Link zu einer Bilddatei mit dem Logo des Dienstes.

      Pflichtfeld?: nein

      Typ: URL

    37. "@context"

      Name: JSON-LD-Kontext (@context)

      Beschreibung: @context ist ein JSON-LD-Keyword, mit dem das JSON-LD-Kontext-Dokument angegeben wird. Es beinhaltet ein Mapping von JSON Keys auf RDF-Properties und von Typen auf RDF-Klassen. Mit dem JSON-LD-Kontext kann aus dem angebotenen JSON, RDF generiert werden.

      Pflichtfeld?: ja

      Typ: URL

      Wert: http://schema.org/

    38. "type"

      Name: Typ

      Beschreibung: Mit type wird der Typ der durch die Visitenkarte beshriebenen Ressource angegeben. Der Typ wird durch eine URL identifiziert. Durch Nutzung des schema.org-Kontexts lassen sich die URLs kürzen, anstatt http://schema.org/WebSite und http://schema.org/Service können WebSite und Service angegeben werden.

      Pflichtfeld?: ja

      Typ: Array, URL

      Werte: WebSite, Service

  21. Jan 2019
    1. after the terminal operation of the stream pipeline commences.

      Above is because of the nature of Streams in general: they are lazily executed (or put another way, execution is delayed until the latest convenient method call).

  22. Nov 2018
    1. Ce qui est commun aux formes de documentation est la fixation, dans le sens collecte avec indexation, d'informations et de processus stockés menant à une réalisation reproductible et diffusable.
    1. "changeDate"
      Name

      Change date

      Description

      The date when the resource description was last changed.

      Coverage

      80 % of the records have a change date, while it is missing for 20 %, see here for a pie chart.

      Usage examples
      URI

      http://id.loc.gov/ontologies/bibframe/changeDate

  23. Oct 2018
    1. "label": "Report of the trial of George Ryan : before the Superior Court at Charlestown, N.H., in the county of Cheshire, May term 1811, for highway robbery."

      The label for the work.

      Combines the title.mainTitle and title.subtitle fields. This field is set for 98 of 100 works in our test set. It can be queried in a field query with label:*.

      It is mapped to rdf-schema#label in our context.

  24. Sep 2018
  25. Aug 2018
    1. "isil"
      Name

      ISIL

      Beschreibung

      Der ISIL (International Standard Identifier for Libraries and Related Organizations) der Einrichtung. Das deutschsprachige ISIL-Verzeichnis ist – neben der Deutschen Bibliotheksstatistik (DBS) – die Datenquelle von lobid-organisations.

      Abdeckung

      Alle Einträge aus dem ISIL-Verzeichnis haben einen ISIL, das sind etwa 14000 Einträge.

      Verwendungsbeispiele

      In der bibliothekarischen Arbeit begegnet man desöfteren ISILs. Mit einem lobid-organisations-Lookup kann einfach und zügig die dadurch identifizierte Institution gefunden werden.

      URI

      http://purl.org/lobid/lv#isil

    2. "fundertype"
      Name

      Art des Unterhaltsträgers

      Beschreibung

      Typ des Unterhaltsträgers der Einrichtung. Die Werte stammen aus einem kontrollierten Vokabular, siehe das SKOS-Schema.

      Abdeckung

      Vorhanden bei gut 7000 Einträgen, fehlt bei ca. 7.700

      Verwendungsbeispiele
      URI

      http://purl.org/lobid/lv#fundertype

    3. "type"
      Name

      Allgemeiner Organisationstyp

      Beschreibung

      Art der Einrichtung. Vergebene Typen sind: Bibliothek (Library), Archiv (Archive), Museum (Museum), Verlag (Publisher), sonstige Organisationen (Organization).

      Abdeckung

      Jeder Eintrag ist einem Einrichtungstyp zugeordnet.

      Verwendungsbeispiele
      Provenienz

      Für Einträge aus der DBS wird automatisch der Typ "Library" vergeben. Bei den Einträgen aus dem Sigelverzeichnis wird der Typ auf Basis der detaillierten Organisationsklassifikation verwendet, siehe das Mapping der Notationen auf einen Typ.

      URI

      "type" ist auf das JSON-LD-Keyword "@type" gemappt, das in diesem Zusammenhang (als node type) in RDF mit http://www.w3.org/1999/02/22-rdf-syntax-ns#type übersetzt wird.

  26. Jan 2018
    1. "isPartOf"
      Name

      Ist Teil von

      Beschreibung

      Enthält Informationen zum Erscheinen der Ressource als Teil eines übergeordneten Werks (eines, mehrbändigen Werks, einer Serie oder eines Periodikums).

      Abdeckung

      Gut sieben Millionen Einträge sind Teil eines übergeordneten Werkes.

      Verwendungsbeispiel

      Asterix-Bände der "Mundart"-Reihe in kölschem Dialekt

      URI

      http://purl.org/lobid/lv#isPartOf

  27. Oct 2017
    1. "license"
      Name

      License

      Path

      about.license

      Description

      A license used within a service providing OER. The values are taken from the controlled vocabulary at https://oerworldmap.org/assets/json/licenses.json.

      Use cases
      Coverage
    2. "dateModified"
      Name

      Modification data

      Path

      dateModified

      Description

      Time stamp for the moment the latest modification of the entry was published.

      Use cases
      Coverage

      Every entry has information on the last modification date.

    3. "startDate"
      Name

      Start date

      Path

      about.startDate

      Description

      The date – following ISO 8601 – when the service was launched.

      Use cases

      A list of services launched before 2015: https://oerworldmap.org/resource/?q=about.startDate%3A%3C2015&filter.about.%40type=Service

      Coverage
    4. "@id"
      Name

      Identifier

      Path

      about.@id

      Description

      The ID of the described resource. OER World Map uses URN UUIDs for identifying resources as specified in RDF 4122. The URL for the associated entry is https://oerworldmap.org/resource/{id}

      Use cases

      You can state identity between OER World Map resources and the same resource on other platforms using sameAs.

      Coverage

      Every resource has an id.

    5. "name"
      Name

      Name

      Path

      about.name

      Description

      The name of the resource described

      Use cases

      Search resources by name

      Coverage

      Every resource needs to have a name.

    6. "member"
      Name

      Affiliated

      Path

      `about.member''

      Description

      An organization affiliated with the service

      Coverage
    7. "@type" : "WebPage"
      Name

      Type

      Path

      @type

      Description

      The type of all entries in the OER World Map is "WebPage".

      Coverage

      Every entry has the type "WebPage".

    8. "provider"
      Name

      Provider

      Path

      about.provider

      Description

      The provider of a service. This can be an organization or a person.

      Use cases
      Coverage
    9. "@id" : "https://oerworldmap.org/assets/json/sectors.json#general"
      Note:

      Each controlled value has a URL as ID that points to the whole controlled vocabulary it is part of.

    10. "@type" : "Concept"
      Note:

      Values from controlled vocabularies all have the @typeConcept`.

    11. "@context"
      Name

      JSON-LD context (@context)

      Path

      @context

      Description

      @context is a JSON-LD keyword, specifying the JSON-LD context document. It primarily includes a mapping of JSON keys to RDF properties. Based on the JSON-LD context one can convert the data to different RDF serializations from the JSON provided.

      Coverage

      The JSON-LD is linked in every entry.

      Use cases
      • This example entry can be converted – for example using the RDF-Translator – to different RDF serializations: N3, N-Triples, RDF/XML.
    12. "primarySector"
      Name

      Primaryy sector

      Path

      about.primarySector

      Description

      The primary sector of education a resource is focused on. Values come from the sectors value list.

      Use cases

      Get a list of OER online services focused on higher education: https://oerworldmap.org/resource/?q=about.primarySector.%40id%3A%22https%3A%2F%2Foerworldmap.org%2Fassets%2Fjson%2Fsectors.json%23higherEd%22&filter.about.%40type=Service

      Coverage
    13. "@language"
      Name

      Language

      Description

      The @language key is always used together with the @value key. It indicates the language of the content.

    14. "@value"
      Name

      Value

      Description

      The @value key is always used together with the @language key. It contains the content of a possibly multilingual field while @language indicates the language of the content.

    15. "description"
      Name

      Description

      Path

      about.description

      Description

      A short description text for the resource.

      Coverage
    16. "@type"
      Name

      Resource type

      Path

      about.@type

      Description

      The type of the resource described. Currently, the OER World Map supports these types:

      Use cases
      • Filter by type (click on the links above or use filters at oerworldmap.org).
      Coverage

      Every resource has a type.

    17. "documentation"
      Name

      API Documentation

      Path

      about.availableChannel.documentation

      Description

      A link to the API documentation

      Coverage
    18. "serviceUrl"
      Name

      URL

      Path

      about.availableChannel.serviceUrl

      Description

      The URL of the Web site or API.

      Use cases
      Coverage
    19. "availableLanguage"
      Name

      Languages

      Path

      about.availableChannel.availableLanguage

      Description

      The language of the resources provided by the service

      Use cases

      A list of services that provide resources in Spanish: https://oerworldmap.org/resource/?q=&filter.about.availableChannel.availableLanguage=es

      Coverage

      List of services where the language information is missing: https://oerworldmap.org/resource/?q=_missing_:about.availableChannel.availableLanguage&filter.about.@type=Service

    20. "availableChannel"
      Name

      Service channels

      Path

      about.availableChannel

      Description

      An array with channels for a specific online OER service. Usually the are the website itself and (optional) an API as a means of interacting with it programatically.

      Coverage

      Every resource of type "Service" has an entry in availableChannel.serviceUrl.

    21. "keywords"
      Name

      Tags

      Path

      about.keywords

      Description

      Tags associated with the resource.

      Use cases
      Coverage
    1. "dateCreated"
      Name

      Date of creation

      Path

      dateCreated

      Description

      The point in time when the first version of the entry was published.

      Use cases
      Coverage

      Every entry has a creation date.

    2. "contributor"
      Name

      Latest contributor

      Path

      contributor

      Description

      The last user that edited the entry.

      Use cases
      Coverage

      Every entry has this information.

    3. "image"
      Name

      Image

      Path

      about.image

      Description

      An image (logo or profile picture) associated with a resource.

      Coverage
    4. "about"
      Name
      Path

      about

      Description

      The "about" object contains all the information about the resource (person, organization, service, project etc.) described by this entry. The information that is not inside the "about" object is about the actual description, when and by whom it was created and modified.

      Coverage

      Every entry contains this information.

    5. "author"
      Name

      Creator

      Path

      author

      Description

      The user of created and published the first version of the entry.

      Use cases
      Coverage

      Every entry has an author/oiginal creator.

    1. "@context"
      Name

      JSON-LD context (@context)

      Description

      @context is a JSON-LD keyword, specifying the JSON-LD context document. It primarily includes a mapping of JSON keys to RDF properties. Based on the JSON-LD context one can convert the data to different RDF serializations from the JSON provided.

      Coverage

      The JSON-LD is linked in every entry.

      Use cases
  28. Sep 2017
  29. Jul 2017
    1. "linkedTo"
      Name

      Library network

      Description

      Link to the library service center of a German library network the organization is member of.

      Coverage

      This information is mostly relevant for German libraries. Information exists for approximately 5000 institutions.

      Use cases

      Get a list of members of the GBV Common Library Network.

      URI

      http://www.w3.org/ns/org#linkedTo

      Provenance

      Information stems from Pica+ field 035I $c of ISIL data (see ISIL format documentation and morph file).

    2. "extent"
      Name

      Collection size

      Description

      The size of the organization's colletion. Values come from a controlled vocabulary, see the SKOS version.

      Coverage

      Existent in approximately 14,000 entries, missing in approximately 8,000 entries.

      URI

      http://purl.org/dc/terms/extent

    3. "isil"
      Name

      ISIL

      Description

      The organization's ISIL (International Standard Identifier for Libraries and Related Organizations). The ISIL registry for German-speaking countries is – besides the German Library Statistics (DBS) – the data source of lobid-organisations.

      Coverage

      All entries from the ISIL registry have an ISIL, these are approximately 15,000 entries.

      Use cases

      In day-to-day library work some people often have to deal with ISILs. With a lookup in lobid-organisations one can easily and quickly find ein specific institution and its ISIL.

      URI

      http://purl.org/lobid/lv#isil

  30. Jun 2017
    1. "IsPartOfRelation"
      Name

      Ist-Teil-von-Beziehung

      Beschreibung

      Diese Entität enthält weitere Informationen zur Ist-Teil-Beziehung: ID und Name der übergeordneten Ressource sowie Bandnummer.

      URI

      http://purl.org/lobid/lv#IsPartOfRelation

  31. May 2017
    1. "openingHoursSpecification"
      Name

      Öffnungszeiten

      Beschreibung

      Das Öffnungszeiten-Objekt enthält unstrukturierte Angaben zu den Öffnungszeiten der Einrichtungen bzw. ihrer verschiedenen Angebote.

      Abdeckung

      Fehlt bei etwa 15.000 Einträgen.

      URI

      http://schema.org/openingHoursSpecification

      Provenienz

      Information stammt aus Pica+-Feld 032P $i der ISIL-Daten siehe ISIL-Format-Dokumentation.

    2. "dbsID"
      Name

      DBS-ID

      Beschreibung

      Bezieht sich nur auf Bibliotheken. Die ID der Einrichtung innerhalb der Deutschen Bibliotheksstatistik (DBS). (Die DBS stellt – neben dem ISIL-Verzeichnis – die Quelldaten für lobid-organisations bereit.)

      Abdeckung

      Vorhanden bei ca. 12.200 Einträgen, fehlt bei ca. 9700.

      Verwendungsbeispiele

      Start der variablen Auswertung der Bibliothek mit der URL https://www.bibliotheksstatistik.de/vaJahr?dbsid={dbsID}, hier: https://www.bibliotheksstatistik.de/vaJahr?dbsid=BJ038

      URI

      http://purl.org/lobid/lv#dbsID

  32. Apr 2017
    1. "collects"
      Name

      Collection

      Description

      Description (size, focus topic) of an organization's collection

      Coverage

      This JSON object is existent in approximatey 14,000 entries and is missing in approximately 8000 entries.

      URI

      http://purl.org/lobid/lv#collects

    2. "type"
      Name

      General organization type

      Description

      Tyoe of an organisation. Assigned types are: Library, Archive, Museum, Publisher, Organization (=other)

      Coverage

      Every entry has type information

      Use cases
      Provenance

      Entries from DBS data automatically are assigned type "Library". Entries from ISIL registry a type is assigned based on the detailed organisation classification, see the mapping of notations to a general type.

      URI

      The "type" key is mapped to the JSON-LD keyword "@type" which in this context – as node type) – translated to http://www.w3.org/1999/02/22-rdf-syntax-ns#type in RDF.

    3. "location"
      Name

      Place

      Description

      The "location" object pools information about the organization's domicile: address, opening hours, geo coordinates.

      Coverage

      Existent in approximately 21,000 entries, missing in approximately 1000 entries.

      URI

      http://schema.org/location

    4. "sameAs"
      Name

      SameAs links

      Description

      In this field, URIs of the organization from the ISIL registry and Wikidata (if existent) are listed.

      Coverage

      Existent in approximately 14,700 Einträgen, missing in approximately 7000.

      Use cases
      • You can get additional information (like photos) about the organization from Wikidata.
      URI

      http://schema.org/sameAs

    5. "name_en"
      Name

      English name

      Description

      The English name of the organization

      Coverage

      Existent in less than 100 entries.

      URI

      http://schema.org/name + language tag "en"

    6. "dbsID"
      Name

      DBS ID

      Description

      Only applies to libraries. The organization's ID in the German Library Statistics (DBS). (DBS is – besides the ISIL registry – one of lobid-organisations' data sources.)

      Coverage

      Existent in more than 12,000 Einträgen, missing in approximately 10,000 entries.

      Use cases

      Start the variable evaluation of the library's statistics with the URL https://www.bibliotheksstatistik.de/vaJahr?dbsid=$dbsID, here: https://www.bibliotheksstatistik.de/vaJahr?dbsid=BJ038

      URI

      http://purl.org/lobid/lv#dbsID

    7. "email"
      Name

      Email address

      Description

      An email address of the organization in mailto: format.

      Coverage

      Existent in approximately 6,000 entries.

      URI

      http://schema.org/email

    8. "subject"
      Name

      Collection focus

      Description

      The organization's collection focus described with uncontrolled keywords (tags)

      Coverage

      Existent in approximately 2000 entries missing in approximately 20,000 entries.

      URI

      http://purl.org/dc/elements/1.1/subject

    1. "sameAs"
      Name

      Same-As-Links

      Beschreibung

      Unter sameAs werden URIs der Einrichtung beim ISIL-Verzeichnis sowie bei Wikidata – wenn vorhanden – angegeben.

      Abdeckung

      Vorhanden bei ca. 15.000 Einträgen, fehlt bei ca. 7000.

      Verwendungsbeispiele
      • Über Wikidata kann man zusätzliche Informationen und Fotos zu einer Einrichtung bekommen.
      URI

      http://schema.org/sameAs