be-gay-do-crimes
/
newpipe-documentation
mirror of https://github.com/TeamNewPipe/documentation
1
0
Fork 0
Code Issues Releases Wiki Activity

minor fixes

This commit is contained in:
Christian Schabesberger 2018-09-01 15:47:57 +02:00
parent 4d96f49af0
commit 59047071d5
4 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/01_Concept_of_the_extractor.md
View File

@ -3,7 +3,7 @@
## Collector/Extractor pattern ## Collector/Extractor pattern
Before we can start coding our own service we need to understand the basic concept of the extractor. There is a pattern Before we can start coding our own service we need to understand the basic concept of the extractor. There is a pattern
you will find all over the code. It is called the __extractor/collector__ pattern. The idea behind this pattern is that you will find all over the code. It is called the __extractor/collector__ pattern. The idea behind it is that
the [extractor](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/Extractor.html) the [extractor](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/Extractor.html)
would produce single peaces of data, and the collector would take it and form usable data for the front end out of it. would produce single peaces of data, and the collector would take it and form usable data for the front end out of it.
The collector also controls the parsing process, and takes care about error handling. So if the extractor fails at any The collector also controls the parsing process, and takes care about error handling. So if the extractor fails at any
@ -14,7 +14,7 @@ You need to take care of the extractors.
### Usage in the front end ### Usage in the front end
So typical call for retrieving data from a website would look like this: So typical call for retrieving data from a website would look like this:
```java ``` java
Info info; Info info;
try { try {
// Create a new Extractor with a given context provided as parameter. // Create a new Extractor with a given context provided as parameter.
@ -29,7 +29,7 @@ try {
### Typical implementation of a single data extractor ### Typical implementation of a single data extractor
The typical implementation of a single data extractor on the other hand would look like this: The typical implementation of a single data extractor on the other hand would look like this:
```java ``` java
class MyExtractor extends FutureExtractor { class MyExtractor extends FutureExtractor {
public MyExtractor(RequiredInfo requiredInfo, ForExtraction forExtraction) { public MyExtractor(RequiredInfo requiredInfo, ForExtraction forExtraction) {

1
docs/02_Concept_of_LinkHandler.md Normal file
View File

@ -0,0 +1 @@
# Concept of LinkHandler

17
docs/index.md
View File

@ -1,17 +1,14 @@
j# Welcome to the NewPipe Documentaiton. # Welcome to the NewPipe Documentaiton.
This side is a beginner friendly tutorial and documentatin for people who want to use, or write services for the [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor). This side is/should be a beginner friendly tutorial and documentation for people who want to use, or write services for the [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor).
This however is an addition to our [jdoc documentation](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/). It is an addition to our auto generated [jdoc documentation](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/).
This tutorial and the documentation are in an early state. So [feedback](https://github.com/TeamNewPipe/documentation/issues) is always welcome :D Please be aware that it is also in an early state, so help and [feedback](https://github.com/TeamNewPipe/documentation/issues) is always welcome :D
## Stay Tuned
Tune yourself to stay ;D
## Introduction ## Introduction
The NewPipeExtractor is a java framework for scraping video platform websites in a way that they can be accedes like a normal API. The extractor is the core of the popular Youtube and streaming app [NewPipe](https://newpipe.schabi.org) for android, however it's system independent and also available for other platforms. The NewPipeExtractor is a Java framework for scraping video platform websites in a way that they can be accedes like a normal API. The extractor is the core of the popular Youtube and streaming App [NewPipe](https://newpipe.schabi.org) for android, however it's system independent and also available for other platforms.
The beauty behind the NewPipeExtractor is that is takes care about the extraction process, error handling etc., so you can take care about what is important: Scraping the website. The beauty behind this framework is it takes care about the extraction process, error handling etc., so you can take care about what is important: Scraping the website.
It focuses on making it possible for the creator of a scraper for a streaming service to create best outcome by least amount of self written code. It focuses on making it possible for the creator of a scraper for a streaming service to create best outcome by least amount of written code.

2
mkdocs.yml
View File

@ -1,4 +1,4 @@
site_name: NewPipe Documentation site_name: NewPipe Documentation
theme: theme:
name: readthedocs name: readthedocs
custom_dir: theme custom_dir: theme