From 59047071d5781e44ea2017995cea2d490a1e367d Mon Sep 17 00:00:00 2001 From: Christian Schabesberger Date: Sat, 1 Sep 2018 15:47:57 +0200 Subject: [PATCH] minor fixes --- docs/01_Concept_of_the_extractor.md | 6 +++--- docs/02_Concept_of_LinkHandler.md | 1 + docs/index.md | 17 +++++++---------- mkdocs.yml | 2 +- 4 files changed, 12 insertions(+), 14 deletions(-) create mode 100644 docs/02_Concept_of_LinkHandler.md diff --git a/docs/01_Concept_of_the_extractor.md b/docs/01_Concept_of_the_extractor.md index 4862404..3a29021 100644 --- a/docs/01_Concept_of_the_extractor.md +++ b/docs/01_Concept_of_the_extractor.md @@ -3,7 +3,7 @@ ## 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 -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) 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 @@ -14,7 +14,7 @@ You need to take care of the extractors. ### Usage in the front end So typical call for retrieving data from a website would look like this: -```java +``` java Info info; try { // Create a new Extractor with a given context provided as parameter. @@ -29,7 +29,7 @@ try { ### Typical implementation of a single data extractor The typical implementation of a single data extractor on the other hand would look like this: -```java +``` java class MyExtractor extends FutureExtractor { public MyExtractor(RequiredInfo requiredInfo, ForExtraction forExtraction) { diff --git a/docs/02_Concept_of_LinkHandler.md b/docs/02_Concept_of_LinkHandler.md new file mode 100644 index 0000000..114682c --- /dev/null +++ b/docs/02_Concept_of_LinkHandler.md @@ -0,0 +1 @@ +# Concept of LinkHandler diff --git a/docs/index.md b/docs/index.md index 3394efa..8039499 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 however is an addition to our [jdoc documentation](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/). +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). +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 -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. -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. +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 written code. diff --git a/mkdocs.yml b/mkdocs.yml index 2505eab..2c124e9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ site_name: NewPipe Documentation theme: name: readthedocs - custom_dir: theme + custom_dir: theme