Readability
Table of contents
Description
Enrichment service that adds readable versions of the web site content. As web site objects are always attached to information objects, the created contents will be connected to the information objects.
Responsible Person
Status
Status | Ready for Use |
|---|
Possible Values: Ready for Use, In Development, Plannend, Broken
Aggregation Features
Fill | No |
|---|---|
Update | No |
Enrich | Yes |
Source Code
Project: https://github.com/soziotech/CommunityMashup/tree/master/sources/ReadabilitySourceService
Tracking
Planned Todos
Bugs
Feature Request
Used Service
Name | Readability Parser Api |
|---|---|
Link | https://www.readability.com/ |
Developer Portal | https://www.readability.com/developers/api |
Authentication | Api Key |
Used Libraries
Name | Version | License | Usage | Link |
|---|---|---|---|---|
Apache Http Client | 4.2.1 | Apache License 2.0 | Compiled | |
| Apache Http Core | 4.2.1 | Apache Licence 2.0 | Compiled | http://hc.apache.org/httpcomponents-core-ga/ |
| Google gson | 2.2.2 | Apache Licence 2.0 | Compiled | http://code.google.com/p/google-gson/ |
Possible Usage Values: Compiled, Source, Extended Source, Modified Source
Configuration
Key | Description | Possible Values | Default | Required (Yes/No) |
|---|---|---|---|---|
apiUrl | The url of the readability parser api service. | Text | No | |
apiKey | Api key (token) from readability. | Text | None | Yes |
addExcerpt | Whether to add excerpt or not as content. | true/false | false | No |
addContent | Whether to add readable website content or not | true/false | true | No |
addAuthor | Whether to create and add the parsed author. Author parsing of Readability is not realy reliable. | true/false | true | No |
enrichContent | Whether to enrich content websites or not. | true/false | true | No |
enrichPerson | Whether to enrich person websites or not. | true/false | true | No |
enrichOrganisation | Whether to enrich organization websites or not. | true/false | true | No |
neededMetaTag | Specific meta tag that is needed for a website to be processed. | Text | None | No |
Example:
<sources bundleId="org.sociotech.communitymashup.source.ReadabilitySourceService name="Readability">
<configuration>
<properties Key="apiKey" Value=" "/>
</configuration>
</sources>
Description | Adds readable content for all web site objects. Api key must be set in configuration. |
|---|
Meta-Informations
Type | Description | Value | Items |
|---|---|---|---|
| MetaTag | Added to all items created by the readability source service. | readability | Item |
| MetaTag | Added to all created authors. | readability_author | Person |
| MetaTag | Added to the contents created from the excerpt values. | readability_excerpt | Content |
| MetaTag | Added to the readable content. | readability_content | Content |
| MetaTag | Added to the lead image identified by readability. | readability_lead_image | Image |
| MetaTag | Added to connections between persons and created content. | readability_person_content_con | Connection |
| MetaTag | Added to connections between organizations and created content. | readability_org_content_con | Connection |
| MetaTag | Added to connections between content and created content. | readability_content_content_con | Connection |
| Subcontent relationship | Excerpt will be sub content of full content if both are added | reference | Content |
| Subcontent relationship | Created content (full content or excerpt) will be sub content of existing content at content content relationship. | reference | Content |
Transformation
External | CommunityMashup |
|---|---|
| Readable web site version | Content |
| Excerpt of readable web site version | Content |