Update documentation

This commit is contained in:
Herbert Reiter
2020-01-04 19:37:41 +01:00
parent 3f7f6cb028
commit 777313f3fb
2 changed files with 15 additions and 15 deletions
+5 -4
View File
@@ -1,10 +1,10 @@
# Changelog
## 2.1.0 (versionCode 14, 2020-01-01)
TODO: Dialog "Einstellungen" mit Option für Kalender
## 2.1.0 (versionCode 14, 2020-01-04)
- Renewed the user interface
- Birthdays and events can be provided as an Android calendar
- A lot of refactoring, updated to androidx packages
- Added `@Nullable` and `@NotNull` annotations, fixed potential bugs
- Removed UDP broadcast support as it didn't really work for the app
- Updated copyright
@@ -14,7 +14,8 @@ TODO: Dialog "Einstellungen" mit Option für Kalender
- HTML layout changed to border-box
- targetSdkVersion updated due to recent Google requirements
- Do not use an internal TCP port any more. Thus, the app requires no Internet permission for normal usage, it is only necessary for synchronisation.
- Do not use an internal TCP port any more. Thus, the app requires no
Internet permission for normal usage, it is only necessary for synchronisation.
- Bugfix: Fixed broken search
- Bugfix: Page titles with space or special characters couldn't be shown
+10 -11
View File
@@ -11,7 +11,7 @@ To download the app see https://moasdawiki.net/.
- Synchronizes the data from a MoasdaWiki Server instance.
- Data privacy: No cloud connection established, directly connects to the server inside your private network.
- Fast and powerful full text search, supports regular expressions.
- Powerful full text search, supports regular expressions.
- Content cannot be modified within the app as it is no fun to type Wiki syntax on the mobile device,
changes have to be done via the MoasdaWiki Server.
- Calendar integration, shows birthdays and events in the mobile calendar (German version only).
@@ -19,16 +19,15 @@ To download the app see https://moasdawiki.net/.
## Synchronize content with a MoasdaWiki Server
1. Ensure to have a MoasdaWiki Server instance running on a computer in your LAN.
2. Install and open the MoasdaWiki App.
3. Click on menu button (⋮) in the upper right corner → Settings.
4. Enter host name of the server instance, e.g. `192.168.1.101`.
5. Enter port of the server instance, usually `11080` (see config file `config.txt`).
6. Click on "Connect to Server" button.
7. In the status section you should see the connection status "Needs authorization at server".
8. On server side open the Wiki page in a browser, click on "Help" and "Synchronization".
9. You can see a list of devices and synchronization sessions. Check the device name and click on "Grant".
10. Back in the app click on the button "Synchronize now".
Now you should have all the server content also in the app.
1. Install and open the MoasdaWiki App.
1. You can see a hint that the App has to be configured first. Press on that hint.
1. Press on "Host name" and enter the host name of the server instance, e.g. `192.168.1.101`. Press OK.
1. In the status section below you should see "Needs authorization at server". Otherwise check host name and port again.
1. On server side open the Wiki page in a browser, click on "Help" and "Synchronization".
1. You can see a list of devices and synchronization sessions. Check the device name and click on "Grant".
1. Back in the app press the back button (←) on the upper left corner to get back to the main dialog.
Now you can see a hint that the app has to be synchronized. Press on that hint.
1. Now you should have all the server content also in the app and you can see the "Home" wiki page.
## Support