sbrl/pepperminty-wiki-client-android

:wrench: WIP :wrench: An experimental Pepperminty Wiki client, written in Kotlin for Android.

Pepperminty-Wiki-Client-Android

🔧 WIP 🔧 An experimental Pepperminty Wiki client, written in Kotlin for Android.

Latest Version: v0.2 (internal testing) v0.3-dev (development) (Changelog)

Install

Method 1: Build from Source

1. Install Android Studio
2. Clone this repository
3. Make sure that USB Debugging is enabled in your phone
4. Connect your phone to your computer
5. Hit the "Run" button in Android Studio
6. Disconnect your phone, optionally disabling USB Debugging.

Method 2: From the Google Play Store

This app is available for beta testing in the Google Play Store!

Link: Pepperminty Wiki Client

Be sure to leave a good review :P

Any issues should be reported here as an issue. I am exponentially more likely to respond on here than to a review in the Google Play store.

Notes

Google Play policies are wildly complicated. Notes here are to remind me about various things.

• Use the EmojiCompat class for all user-supplied strings to ensure the newest emojis are always supported

Contributions

Contributions are welcome! Simply send open a pull request 😺

License

The Pepperminty Wiki Android Client is released under the Mozilla Public License 2.0. The full license text is included in the LICENSE file in this repository.

pepperminty-wiki-client-android's Issues

Implement SnackBar instead of Toast notifications

This should be less intrusive for the user if done right.

Also, we want to avoid showing notifications when we load from the Internet - only when we load from the local cache or when something goes wrong....

https://developer.android.com/training/snackbar/showing

Quick access to the main page of a wiki

It would be helpful if there was a quick way to access the main page of a wiki, rather than scrolling through the entire list to find it.

Implement link support

If we implement support for app links, we can use a meta tag to direct wiki users to the app like this:

<meta name="google-play-app" content="app-id=com.musescore.playerlite" />
<link rel="alternate" href="android-app://com.musescore.player/musescore/start" />

Of course, we'll probably want to hide this behind a setting that's disabled by default until the app is actually at least of beta quality.

Consider Allowing HTTP Support

I just VPN into my network and avoid SSL because it's a hassle, but it seems that http is restricted.

I like to use personal wikis for school and research and being able to cache pepperminty to my phone would be better than the syncthing/dokuwiki/ksweb set up I'm currently using.

Bug: Page list refresh on first load says it has refreshed

When the app first loads the page list, it says that the page list has been refreshed. This isn't actually the case - it loads it from the cache.

We should squash the message when it hasn't actually reloaded the page list from the network.

Fix the colour scheme when the phone is in dark mode

If the phone has the global theme (I can't remember what it's called) set to the dark mode, then the app decides to show all the text in white..... on a light background. Research is required here I think.

Bug: Can't view recent changes for the 2nd wiki in the list

....it crashes.

Add a settings page

Adding a settings page will provide users with the ability to customise the way that the app works. We could include:

• Image download settings - always, never, and only over WiFi
• Clear cache button
• Cache location: cache folder, external SD card

Is there a way to remove a wiki? Or edit its credentials?

I had to change my password on my wiki a few days ago, and this seems to have broken access to my wiki. I'm no longer able to pull any pages up, but neither does there seem to be a way to change my password as the Android app sees it. Is there a way to delete a wiki from the Android app, or change my password for one, or something?

Feature request: How to tell if a wiki page is cached locally or not?

Use case: I keep a large amount of travel-related information (frequent flyer memberships, reservations, contact information for points-of-contact where I go) in my Pepperminty Wiki install. I would like to use the Pepperminty Wiki client to keep locally cached copies of some of these pages (as reflected in Hamburger Menu -> Settings -> Clear cache (Current size)). However, it would be helpful if it were possible to tell if a particular wiki page were cached or not (see also ticket #7 ). Perhaps if the page icon in the page list had a smaller icon overlaid on it (like an arrow or a phone icon, or something) to tell them apart?

App crashes after adding URL on "Add wiki" screen

When the app starts it shows the "Add wiki" dialog. As soon as I enter any valid URL it crashes. I'd happy to provide more details but not sure how to collect them on Android :) will need some guidance

Implement GeckoView

Firefox is awesome. Who wouldn't want to use GeckoView for displaying Pepperminty Wiki pages?

Todo list:

• Turn all relative links into absolute ones (minding we need to ensure we have a reliable way to tell internal and external links apart)
• Get started with GeckoView https://firefox-source-docs.mozilla.org/mobile/android/geckoview/consumer/geckoview-quick-start.html
• Figure out how to add a custom JS interface

Opening the app while disconnected puts it into a crash loop.

I'm running the latest version from the Play Store on Android 10. I have found that, when the phone is disconnected from the Net (in airplane mode), when I try to open a non-cached page the application immediately crashes. Subsequent to that, every time I try to re-open the Pepperminty Wiki client it continues to crash until I force-kill it, re-enable data, and open the app again. I've been able to replicate this bug on a Samsung Tab A tablet running Android 9 and with the same version of the Pepperminty Wiki client.