Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Textbox for intro and/or description on each main view #22

Closed
kaiec opened this issue Nov 18, 2015 · 12 comments
Closed

Textbox for intro and/or description on each main view #22

kaiec opened this issue Nov 18, 2015 · 12 comments
Assignees
Milestone

Comments

@kaiec
Copy link

kaiec commented Nov 18, 2015

When people arrive at the Linked Data Fragments View, the browse API or browse schema and the play view (i.e., every view that is directly reached via Menu or the direct links from the homepage), a box at the top of the view should be shown that contains a brief description. I deliver texts, but have no idea how the box is to be created,

kba added a commit that referenced this issue Nov 18, 2015
@kba
Copy link
Contributor

kba commented Nov 18, 2015

No need, I can integrate them. Just post the texts here or edit the help blocks in the jade files in /views.

@kba
Copy link
Contributor

kba commented Nov 19, 2015

turned them off again for now because they are in the way while developing. Give me a ping when you have the texts and I'll turn them on again.

kba added a commit that referenced this issue Nov 21, 2015
@bolandka bolandka modified the milestone: Prototype for SWIB Nov 23, 2015
@kaiec
Copy link
Author

kaiec commented Nov 24, 2015

Here are some texts, sorry for being last second:

**** LDF Service

You can query our data using [[http://linkeddatafragments.org/][Linked Data Fragments]]. This basically allows for filtering the statements based on combinations of subject, predicate and/or object. For instance, fill in a URI in the subject field and you get all statements about this subject.

Note: This service ist not yet fully functionable. [[https://github.com//issues/67][Filtering by object]] is not yet implemented and we know that there are bugs in filtering by subject and predicate combinations. We would appreciate if you [[https://github.com/infolis/infolis-web/issues][create an issue]] with an example if you spot a problem.

**** Schema

Our data schema not only addresses the actual [[http://infolis.gesis.org/infolink/schema/EntityLink][links]] between publications and research data, but also contains the process model to obtain these links by [[http://infolis.gesis.org/infolink/schema/Execution][executing]] [[http://infolis.gesis.org/infolink/schema/algorithm][algorithms]] by means of our services. A higher-level description of the schema is provided [[http://infolis.github.io/data-model/][here]].

**** API

Feel free to look around and test our API. Basically, there are only two essential methods for uploading files and executing a linking algorithm. Note that uploaded files will not be available for download for copyright reasons.

During the execution of the algorithm, many additional resources are created to reflect the status of the execution and the provenance chain for the produced links. To create these resources and get access to them afterwards, we provide many additional methods that you probably do not need to know about at the beginning.

Note: This API is under heavy development and far from stable. If you have problems using it or find a bug, please [[https://github.com/infolis/infoLink/issues][create an issue]].

@kba
Copy link
Contributor

kba commented Nov 24, 2015

not markdown.

@kba
Copy link
Contributor

kba commented Nov 30, 2015

Still missing: http://infolis.gesis.org/infolink/api/stats

@kba
Copy link
Contributor

kba commented Nov 30, 2015

@kba
Copy link
Contributor

kba commented Nov 30, 2015

@infolis/all Propopsed workflow for UI documentation / help texts:

  • Fork infolis/infolis-web
  • Create a topical branch
  • Create a Github Flavored Markdown file under /help
  • Open a pull request so we can discuss wording and I'll integrate it.

@kba kba modified the milestones: Beta Version, Prototype for SWIB Nov 30, 2015
@bolandka bolandka mentioned this issue Dec 1, 2015
@bolandka
Copy link
Member

bolandka commented Dec 1, 2015

created a help text for /play/demo1 following the proposed workflow. Comments welcome! (Please comment the pull request directly).

@bolandka
Copy link
Member

bolandka commented Dec 1, 2015

added some comments on the help text for /api here: 0793084

@bolandka
Copy link
Member

bolandka commented Dec 2, 2015

thought it might be nice to have more detailed explanations on the api help page. I added a suggestion here: #79

@bolandka
Copy link
Member

bolandka commented Dec 2, 2015

created a help text for /api/stats here: #80

@kba
Copy link
Contributor

kba commented Jun 13, 2016

We have help for all publicly available features of the web UI now.

@kba kba closed this as completed Jun 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants