User:Angeliki/X-LIB/Annotations: Difference between revisions

From XPUB & Lens-Based wiki
Line 46: Line 46:
http://localhost:5000/docs/help
http://localhost:5000/docs/help
http://localhost:5000/admin
http://localhost:5000/admin
https://github.com/hypothesis/frontend-toolkit


=== Attempt 2: ===
=== Attempt 2: ===

Revision as of 20:31, 5 June 2018

Tools

Hypothes.is

Hypothes-is-pdf-audio.jpg Augmented pdf (links, audio, video, images)

Ideas

  • Annotate the PDF file
  • Annotate the URL of XPPL
  • Develop tool for embedded PDF with sound/ other media

Steps

Attempt 1:

Steps to host the software hypothes.is in the same machine with XPPL so there is more control over the annotation data and the access of users Installing hypothes.is in my machine: https://h.readthedocs.io/en/latest/developing/install/
Database with the annotations locally- able to interact with the database of the books?

Questions:
The structure of hypothes.is tool is based on the contribution of individual users. How an external tool can be part of xppl, by following its conceptual context?
Legal object (annotations and extracts of the PDFs)/ illegal object (PDF downloaded with annotations)


Comments:

  • I have to accept the users signing in my 'local' hypothesis. How to connect with real users.
  • Embed PDF: just embed the h in the html page pf the pdf
  • There will be a separate h interface for people to sign up
  • Get annotations from api of my h
  • Download PDFs with annotations
  • BIG ISSUE: the localhost should change to public ip address (Michael)
  • Make a bash with all the commands needed to run client, h, XPPL
    ~/Documents/PZI-ITL/h$ sudo docker-compose up
    ~/Documents/PZI-ITL/h$ source .venv/bin/activate
    ~/Documents/PZI-ITL/client$ export SIDEBAR_APP_URL=http://localhost:5000/app.html
    ~/Documents/PZI-ITL/client$ gulp watch
    ~/Documents/PZI-ITL/h$ export CLIENT_OAUTH_ID=b0dedcdc-675b-11e8-8450-0f70f73a2d89
    ~/Documents/PZI-ITL/h$ export CLIENT_URL=http://localhost:3001/hypothesis
    ~/Documents/PZI-ITL/h$ make dev
    ~/Apps/rqlite-v4.3.0-linux-amd64$ ./rqlited ~/node.1
    ~/Documents/PZI-ITL/xpub-lib$ bash ./init_db.sh
    ~/Documents/PZI-ITL/xpub-lib$ python3 run.py
  • Editing the interface of h. so to adjust to the xppl

Useful links:
hypothesis client: http://h.readthedocs.io/projects/client/en/latest/developers/developing/#running-the-client-from-h
http://localhost:5000/docs/help http://localhost:5000/admin https://github.com/hypothesis/frontend-toolkit

Attempt 2:

Plan:

  • embed h

PROBLEM1: file path for the PDF viewer
PROBLEM2: add the viewer with the annotations of pdfs embedded to the stack page
annotate each link of the PDF. (Using that link in my scripts: http://localhost:8000/uploads/title.pdf) embedding the tool. Hosting hypothesis to each PDF online https://github.com/hypothesis/pdf.js-hypothes.is. Solutions: to change the path of the files in viewer.html, to interact with app.route uploads at the views.py, to add the viewer.html to the templates? Template that will link all this information (the viewer there, the other things somewhere else and what they do together). embedding Hypothesis in Websites and Platforms

  • export annotations

I want to create a 'block'/html page of exported annotations from the PDFs. So I add the HTML page of the exported material. But also to link every PDF with its own annotations? Interact with the API
back end: API, python scripts, fetch the data in a file (CSV file/JSON of the annotations)
front end: html, css, javascript. put them online. Static first and then dynamic(Javascript of the JSON files)