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

fix image paths

This commit is contained in:
Christian Schabesberger 2018-11-16 19:23:01 +01:00
parent 398ecf9f25
commit 9410de6c80
4 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/00_Prepare_everything.md
View File

@ -45,7 +45,7 @@ If all the checks are green you did everything right, and you are good to go to
Go to _run_ > _edit configurations_ > _add new configuration_ and select "Gradle". Go to _run_ > _edit configurations_ > _add new configuration_ and select "Gradle".
As Gradle Project, select NewPipeExtractor. As task add "test". Now save and you should be able to run. As Gradle Project, select NewPipeExtractor. As task add "test". Now save and you should be able to run.
![tests passed on idea](/img/prepare_tests_passed.png) ![tests passed on idea](img/prepare_tests_passed.png)
# Inclusion criteria for services # Inclusion criteria for services

2
docs/01_Concept_of_the_extractor.md
View File

@ -60,7 +60,7 @@ Sometimes information can be represented as a list. In NewPipe a list is represe
A InfoItemCollector will collect and assemble a list of [InfoItem](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItem.html). A InfoItemCollector will collect and assemble a list of [InfoItem](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItem.html).
For each item that should be extracted a new Extractor must be created, and given to the InfoItemCollector via [commit()](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItemsCollector.html#commit-E-). For each item that should be extracted a new Extractor must be created, and given to the InfoItemCollector via [commit()](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItemsCollector.html#commit-E-).
![InfoItemsCollector_objectdiagram.svg](/img/InfoItemsCollector_objectdiagram.svg) ![InfoItemsCollector_objectdiagram.svg](img/InfoItemsCollector_objectdiagram.svg)
If you are implementing a list for your service you need to extend InfoItem containing the extracted information, If you are implementing a list for your service you need to extend InfoItem containing the extracted information,
and implement an [InfoItemExtractor](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/Extractor.html) and implement an [InfoItemExtractor](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/Extractor.html)

5
docs/04_Run_changes_in_App.md
View File

@ -40,10 +40,11 @@ Your browser does not support the video tag.
If everything synced well then you should only see a screen with OK signs. Now you can go on an compile and run NewPipe If everything synced well then you should only see a screen with OK signs. Now you can go on an compile and run NewPipe
with the new extractor. with the new extractor.
![image_sync_ok](/img/sync_ok.png)
![image_sync_ok](img/sync_ok.png)
### Trouble shoot ### Trouble shoot
If something went wrong on jitpack site, you can check their build log, by selecting the commit you tried to build and If something went wrong on jitpack site, you can check their build log, by selecting the commit you tried to build and
click on that little paper symbol next to the `GET IT` button. If it is red it already shows that the build failed. click on that little paper symbol next to the `GET IT` button. If it is red it already shows that the build failed.
![jitpack failed to build](/img/jitpack_fail.png) ![jitpack failed to build](img/jitpack_fail.png)

3
docs/index.md
View File

@ -1,5 +1,8 @@
# Welcome to the NewPipe Documentation. # Welcome to the NewPipe Documentation.
<img width=150 src="https://raw.githubusercontent.com/TeamNewPipe/NewPipe/dev/assets/new_pipe_icon_5.png"/>
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 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/). It is an addition to our auto generated [jdoc documentation](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/).