EbookFoundation
/
capstone-projects
mirror of https://github.com/EbookFoundation/capstone-projects.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

headings in plan

pull/4/head
eric 2018-08-15 17:47:57 -04:00
parent 4f31937df1
commit 6c56222c48
2 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
copyright-records.md
View File

@ -14,6 +14,10 @@ There is a need for a user-friendly search interface for librarians, archivists,
This project will produce a user-friendly, open-source search interface for the structured renewal records.
### Team
This project will require team members to combine technology with some understanding of copyright law and an ability to analyse user requirements.
### Objectives
The team will:
- become familiar with the structure of the data. Over the years, the renewal records used four different formats, so the system will need to deal with four different data structures.
@ -21,5 +25,12 @@ The team will:
- identify appropriate search, application, web-service and user interface software for implementation of the search system.
- implement and deploy the system.
- user-test the system
The NYPL team is excited at the possibility that a user facing service could be built; they feel it may be instrumental in demonstrating the value of the converted records and securing funding for the remaining conversion work.
### Issues
Issues the team will need to resolve
- how to connect record metadata with original scans
- versioning and duplicates
### Wrap-up
The NYPL team is very excited at the possibility that a user facing service could be built; they feel it may be instrumental in demonstrating the value of the converted records and securing funding for the remaining conversion work. Documentation of the project will need to enable future addition of the records that have not yet been converted.

9
pipeline.md
View File

@ -9,8 +9,10 @@ There needs to be a way for ebook authors to announce new books and version upda
## Plan
This project will create an update pipeline for these ebooks by implementing update hooks in a variety of open source ebook authoring systems. The Free Ebook Foundation has demonstrated the viability of such a system in its GITenberg project, which uses Github hooks to announce the possible availability of an updated version of a book built from a git repository, and YAML-based metadata files to describe the ebooks being updated.
### Team
This project will attempt to scale this approach by implementing update hooks in a number of open-source ebook authoring tools. As the tools are based on different software environments, this project will need a team with a variety of programming skills.
### Objectives
Ebook authoring systems the team will target:
- Wikibooks (PHP)
- Gitbooks (Node/Javascript)
@ -21,4 +23,11 @@ Ebook authoring systems the team will target:
The update server will then use Unglue.it to provide syndication feeds for downstream consumption.
### Issues
Issues the team will need to resolve
- metadata format and dictionary
- versioning and duplicates
### Wrapup
Finally the team will produce how-to documentation to enable other ebook-building systems to add update hooks to their own systems.