issue #106 cleanup documentation; build pages also from develop branch

.github/workflows/main.yml

@@ -4,9 +4,9 @@ name: Deploy Jekyll & Doxygen GitHub Pages dependencies preinstalled
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["feat/issue106"]
+    branches: [ "develop", "feat/issue106" ]
   pull_request:
-    branches: [ "feat/issue106" ]
+    branches: [ "develop", "feat/issue106" ]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -36,18 +36,18 @@ jobs:
         uses: actions/jekyll-build-pages@v1
         with:
           source: ./docs
-          destination: ./docs/_site            
+          destination: ./docs/_site
       - name: Doxygen Action
         uses: mattnotmitt/[email protected]
-        with:          
-          doxyfile-path: ./Doxyfile 
-          working-directory: ./docs 
+        with:
+          doxyfile-path: ./Doxyfile
+          working-directory: ./docs
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
           path: ./docs/_site
-            
-      
+
+
 
   # Deployment job
   deploy:
@@ -57,7 +57,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     steps:
-      - name: Deploy to GitHub Pages 
+      - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4        
 

README.md

@@ -15,36 +15,38 @@ tobexyz
 alt="Get it on F-Droid"
 height="80">](https://f-droid.org/packages/de.yaacc/)
 
-<img src="./docs/screenshots/4.1.x/browse_servers.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.1.x/browse_image_folder.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.1.x/browse_receiver.png" alt= “” width="30%" height="30%">
-<img src="./docs/screenshots/4.1.x/music_player.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.1.x/playlist_fully_editable.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.1.x/image_player_show_menu.png" alt= “” width="30%" height="30%">
+<img src="./docs/screenshots/4.2.x/browse_servers.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.2.x/browse_image_folder.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.2.x/browse_receiver.png" alt= “” width="30%" height="30%">
+<img src="./docs/screenshots/4.2.x/music_player.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.2.x/playlist_fully_editable.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.2.x/image_player_show_menu.png" alt= “” width="30%" height="30%">
 
 ## Description
 
-The App allows you to play media from UPNP/DLNA devices in your network on your android device or
-any capable UPNP device in your network. It is also possible to start an UPNP server on your device
-in order to play media from your device on any UPNP renderer in your network.
+The App allows you to play media from UPnP/DLNA devices in your network on your android device or
+any capable UPnP device in your network. It is also possible to start an UPnP server on your device
+in order to play media from your device on any UPnP renderer in your network.
 
 ## Features
 
-* UPNP Server - share files of your device in the network
-* UPNP Client - receive media from other devices on your device
-* UPNP Controller - control media renderer in the network
+* UPnP/DLNA Server - share files of your device in the network
+* UPnP/DLNA Client - receive media from other devices on your device
+* UPnP/DLNA Controller - control media renderer in the network
 * Control multiple media renderer
 * Allow download files to the device
-* Allow sharing of urls and sending them to the current media renderers
-* Implemented parts of UPnP Version 3 at once (sending synchronization information to the renderer)
-
+* Allow sharing of URLs and sending them to the current media renderers
+* Use your device as an proxy if your media renderer can't process https media URLs
 
 ## Configuration
-Please take a look in the settings of the app. A lot of configuration can be done there. 
 
-The media server is stopped by default and has to be activiated in the settings. 
-For this go to settings and tick some checkboxes under "Local server configuration" depending on your needs in order to start the server
+Please take a look in the settings of the app. A lot of configuration can be done there.
 
+The media server is stopped by default and has to be activated in the settings.
+For this go to settings and tick some checkboxes under "Local server configuration" depending
+on your configuration needs. You can start the server by activating the corresponding setting
+or by activating the switch at the bottom of the server tab
 
 ## A word about the cling library
 
-This project is based on the work of <https://github.com/4thline/cling>. This great UPNP library made
+This project is based on the work of <https://github.com/4thline/cling>. This great UPnP library
+made
 yaacc possible and all honor belongs to the authors of that project. Thank you for your work on that
 project!
 
@@ -68,4 +70,3 @@ After the build has finished the debug apk is located in
 ## Documentation
 
 <https://tobexyz.github.io/yaacc-code>
-

docs/_config.yml

@@ -18,13 +18,13 @@
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
 
-title: YAACC - Android UPNP/DLNA Client and Server
+title: YAACC - Android UPnP/DLNA Client and Server
 email:
 description: >- # this means to ignore newlines until "baseurl:"
-  The App allows you to play media from UPNP/DLNA devices in your network 
-  on your android device or any capable UPNP device in your network. 
-  It is also possible to start an UPNP server on your device in order 
-  to play media from your device on any UPNP renderer in your network.
+  Play media from UPnP/DLNA devices in your network 
+  on your android device or any capable UPnP/DLNA device in your network. 
+  It is also possible to start an UPnP/DLNA server on your device and play 
+  media from your device on any UPnP/DLNA renderer in your network.
 baseurl: "/yaacc-code/" # the subpath of your site, e.g. /blog
 url: "https://tobexyz.github.io" # the base hostname & protocol for your site, e.g. http://example.com
 twitter_username:

docs/about.md

@@ -6,8 +6,9 @@ permalink: about/
 
 # About
 
-YAACC (Yet Another Android Client Controller) is a hobby project I am working on in my free time. So
-it's not perfect and I am only able to test the app with my own hardware setup.
+YAACC (Yet Another Android Client Controller) is a hobby project
+I am working on in my free time. So it's not perfect and I am
+only able to test the app with my own hardware setup.
 
 Please, help improving YAACC by reporting problems or sending pull requests.
 

docs/index.md

@@ -1,36 +1,37 @@
 ---
 layout: default
 ---
+
 <!-- markdownlint-configure-file {
     "first-line-h1": false
 } -->
 
 * TOC
-{:toc}
+  {:toc}
 
 # Features
 
-* UPNP/DLNA Server - share files of your device in the network
-* UPNP/DLNA Client - receive media from other devices on your device
-* UPNP/DLNA Controller - control media renderer in the network
+* UPnP/DLNA Server - share files of your device in the network
+* UPnP/DLNA Client - receive media from other devices on your device
+* UPnP/DLNA Controller - control media renderer in the network
 * Control multiple media renderer
 * Allow download files to the device
-* Allow sharing of urls and sending them to the current media renderers
-* Use your device as an proxy if your media renderer can't process https media urls
+* Allow sharing of URLs and sending them to the current media renderers
+* Use your device as an proxy if your media renderer can't process https media URLs
 
 # Usage
 
-On the first screen all UPNP/DLNA servers in your network are listed.
-Select one and the app will atomatically switch to the content tab.
+On the first screen all UPnP/DLNA servers in your network are listed.
+Select one and the app will automatically switch to the content tab.
 It allows to browse the content provided by the selected server.
 
-![browse_servers](./screenshots/4.1.x/browse_servers.png){:height="30%" width="30%"}
+![browse_servers](./screenshots/4.2.x/browse_servers.png){:height="30%" width="30%"}
 
-Before selecting content make sure you have choosen an receiver on
-the receiver tab. Receivers are either UPNP/DLNA media renderers in
+Before selecting content make sure you have chosen an receiver on
+the receiver tab. Receivers are either UPnP/DLNA media renderers in
 your network or the android device itself.
 
-![browse_receiver](./screenshots/4.1.x/browse_receiver.png){:height="30%" width="30%"}
+![browse_receiver](./screenshots/4.2.x/browse_receiver.png){:height="30%" width="30%"}
 
 Normally senders and receivers will appear automatically.
 If not you can use the refresh button at the bottom of
@@ -48,7 +49,7 @@ Behind each content entry different symbols are showing the possible actions:
 
 At the bottom of the screen the currently selected sender and receiver is displayed.
 
-![browse_music_folder](./screenshots/4.1.x/browse_music_folder.png){:height="30%" width="30%"}
+![browse_music_folder](./screenshots/4.2.x/browse_music_folder.png){:height="30%" width="30%"}
 
 ## Playing content
 
@@ -60,22 +61,22 @@ smart speaker at the same time.
 Each player is displayed in the player tab. Depending on the content type
 and if the content is played by YAACC itself or a network device, the player ui differs.
 
-![browse_player](./screenshots/4.1.x/browse_player.png){:height="30%" width="30%"}
+![browse_player](./screenshots/4.2.x/browse_player.png){:height="30%" width="30%"}
 
 YAACC includes a player for music and image shows.
 Videos are played using a third parties app on the device.
 The video app will start automatically, if video content is selected for playing
 
-![music_player](./screenshots/4.1.x/music_player.png){:height="30%" width="30%"}
+![music_player](./screenshots/4.2.x/music_player.png){:height="30%" width="30%"}
 
-![image_player_show_menu](./screenshots/4.1.x/image_player_show_menu.png){:height="30%" width="30%"}
+![image_player_show_menu](./screenshots/4.2.x/image_player_show_menu.png){:height="30%" width="30%"}
 
 ## Media server
 
 YAACC includes a media server service, which has to be enabled separately.
 A switch for this is located at the bottom of the server list tab.
 
-![browse_servers](./screenshots/4.1.x/browse_servers.png){:height="30%" width="30%"}
+![browse_servers](./screenshots/4.2.x/browse_servers.png){:height="30%" width="30%"}
 
 Depending on the configurations for the server in the settings,
 the server service is used as media provider, media renderer or proxy.
@@ -84,23 +85,23 @@ The icons behind the server switch are showing which service is activated.
 ## Media provider
 
 If the device is used as media provider, media files stored on the device
-are accessible for other UPNP/DLNA devices in you network.
+are accessible for other UPnP/DLNA devices in you network.
 At the moment there are no restrictions beside the content type,
 which files are accessible and which are not.
 Be aware of this when activating the service!
 
 ## Media renderer
 
 This service allows your device acting as an media renderer. Therefore the
-device can be controlled by other UPNP/DLNA controllers in your network
-and receive and play media from UPNP/DLNA servers.
+device can be controlled by other UPnP/DLNA controllers in your network
+and receive and play media from UPnP/DLNA servers.
 
 ## Media proxy
 
 The proxy service is used in the context of sharing URLs with YAACC and
-playing the url on a UPNP/DLNA device in your network. Normally the
+playing the URL on a UPnP/DLNA device in your network. Normally the
 URL will directly passed to the rendering device. Sometimes the rendering
-device is not able to play https urls. Therefore we need to get rid of the
+device is not able to play https URLs. Therefore we need to get rid of the
 encryption and provide the content with an unencrypted http URL.
 For this the proxy service can be used. In that case the URL shared with
 YAACC will not directly passed to the rendering device. YAACC generates a

docs/screenshots/screenshots.md

@@ -2,18 +2,33 @@
 layout: default
 permalink: screenshots/
 ---
+
 <!-- markdownlint-configure-file {
     "first-line-h1": false
 } -->
 [Up]({{site.baseurl}}/)
 
 # Screenshot gallary of YAACC
 
+- [Version 4.2.x](#4.2.x)
 - [Version 4.1.x](#4.1.x)
 - [Version 4.0.x](#4.0.x)
 - [Version 3.x.x](#3.x.x)
 - [Version 2.x.x](#2.x.x)
 
+<div id='4.2.x'/>
+## Version 4.2.x
+
+![browse_servers](./4.2.x/browse_servers.png){:height="30%" width="30%"}
+![browse_content_folder](./4.2.x/browse_content_folder.png){:height="30%" width="30%"}
+![browse_image_folder](./4.2.x/browse_image_folder.png){:height="30%" width="30%"}
+![browse_music_folder](./4.2.x/browse_music_folder.png){:height="30%" width="30%"}
+![browse_receiver](./4.2.x/browse_receiver.png){:height="30%" width="30%"}
+![music_player](./4.2.x/music_player.png){:height="30%" width="30%"}
+![browse_player](./4.2.x/browse_player.png){:height="30%" width="30%"}
+![image_player](./4.2.x/image_player.png){:height="30%" width="30%"}
+![image_player_show_menu](./4.2.x/image_player_show_menu.png){:height="30%" width="30%"}
+
 <div id='4.1.x'/>
 ## Version 4.1.x
 

docs/settings.md

@@ -17,7 +17,7 @@ permalink: settings/
 | **media browsing behavior** | category for media browsing settings |
 | thumbnails | show thumbnails or not|
 | cover images | search for cover images in media files or use a cover.jpg file within the directories |
-| number of threads | Configure the number of threads used for loading content from the UPNP server. More threads causes faster loading but increase the possibility of errors. Changes are effect after restart of yaacc. |
+| number of threads | Configure the number of threads used for loading content from the UPnP server. More threads causes faster loading but increase the possibility of errors. Changes are effect after restart of YAACC. |
 | chunk size when browsing |amount of items fetched from server in one request |
 | **media playing behavior** | category for media playing settings |
 | default item duration | default item duration if media file provides no duration information |
@@ -35,5 +35,5 @@ permalink: settings/
 | serve images | activate or deactivate publishing of images |
 | serve music | activate or deactivate publishing of music |
 | serve videos | activate or deactivate publishing of music |
-| sending UPNP alive notifications | define the frequency for sending UPNP alive notifications |
+| sending UPnP alive notifications | define the frequency for sending UPnP alive notifications |
 | network name for local server| display name of the media server |