Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 81441afe authored by cketti's avatar cketti
Browse files

Remove scripts to create screenshots for the user manual

parent ba42bf11

ui-flows/screenshots/user_manual_account_setup.yml

deleted100644 → 0
+0 −158
Original line number Diff line number Diff line 
appId: com.fsck.k9.debug

---

- launchApp:

    clearState: true



- assertVisible:

    id: "com.fsck.k9.debug:id/welcome_message"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/welcome_screen"



- tapOn:

    id: "com.fsck.k9.debug:id/next"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step1_empty"



- tapOn:

    id: "com.fsck.k9.debug:id/account_email"

- inputText: "dummy@outlook.com"

- tapOn:

    id: "com.fsck.k9.debug:id/next"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step1_sign_in"



- pressKey: "back"



- tapOn:

    id: "com.fsck.k9.debug:id/account_email"

- eraseText

- inputText: "user@domain.example"

- tapOn:

    id: "com.fsck.k9.debug:id/next"

- tapOn:

    id: "com.fsck.k9.debug:id/account_password"

- inputText: "password"

- pressKey: "back"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step1_filled_in"



- tapOn:

    id: "com.fsck.k9.debug:id/next"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step2_account_type_selection"



- tapOn:

    id: "com.fsck.k9.debug:id/imap"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step3_imap_incoming_server_1"



- scroll



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step3_imap_incoming_server_2"



- scrollUntilVisible:

    element:

      id: "com.fsck.k9.debug:id/account_server"

    direction: UP

- tapOn:

    id: "com.fsck.k9.debug:id/account_server"

- eraseText

- inputText: "wrong.host.badssl.com"

- tapOn:

    id: "com.fsck.k9.debug:id/account_port"

- eraseText

- inputText: "443"



- tapOn:

    id: "com.fsck.k9.debug:id/next"



- assertVisible:

    id: "android:id/alertTitle"

- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step3.6_invalid_certificate"



- tapOn:

    id: "android:id/button2"



- tapOn:

    id: "com.fsck.k9.debug:id/account_server"

- eraseText

- inputText: "127.0.0.1"



- tapOn:

    id: "com.fsck.k9.debug:id/next"



- assertVisible:

    id: "android:id/alertTitle"

- pressKey: "back"



- assertVisible:

    id: "com.fsck.k9.debug:id/progress"

- takeScreenshot: "user-manual/screenshots/account_setup_step3.5_imap_checking_incoming_server_settings"



- pressKey: "back"



- tapOn:

    id: "com.fsck.k9.debug:id/next"

- tapOn:

    id: "android:id/button2"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step4_smtp_outgoing_server"



- tapOn:

    id: "com.fsck.k9.debug:id/account_server"

- eraseText

- inputText: "127.0.0.1"



- tapOn:

    id: "com.fsck.k9.debug:id/next"



- assertVisible:

    id: "android:id/alertTitle"

- pressKey: "back"



- assertVisible:

    id: "com.fsck.k9.debug:id/progress"

- takeScreenshot: "user-manual/screenshots/account_setup_step4.5_smtp_checking_outgoing_server_settings"



- pressKey: "back"



- tapOn:

    id: "com.fsck.k9.debug:id/next"

- tapOn:

    id: "android:id/button2"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step5_account_options"



- tapOn:

    id: "com.fsck.k9.debug:id/next"

- tapOn:

    id: "com.fsck.k9.debug:id/account_description"

- inputText: "My first account"

- tapOn:

    id: "com.fsck.k9.debug:id/account_name"

- inputText: "Demo User"

- pressKey: "back"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step6_account_name"



- pressKey: "back"

- pressKey: "back"

- pressKey: "back"

- pressKey: "back"



- tapOn:

    id: "com.fsck.k9.debug:id/pop"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_setup_step3_pop3_incoming_server"

ui-flows/screenshots/user_manual_accounts.yml

deleted100644 → 0
+0 −121
Original line number Diff line number Diff line 
appId: com.fsck.k9.debug

---

- launchApp:

    clearState: true



- tapOn:

    id: "com.fsck.k9.debug:id/next"



- tapOn:

    id: "com.fsck.k9.debug:id/account_email"

- inputText: "fun@k9mail.example"

- tapOn:

    id: "com.fsck.k9.debug:id/next"



- tapOn:

    id: "com.fsck.k9.debug:id/account_description"

- inputText: "Personal"

- tapOn:

    id: "com.fsck.k9.debug:id/account_name"

- inputText: "Demo User"

- tapOn:

    id: "com.fsck.k9.debug:id/done"



- tapOn:

    id: "com.android.permissioncontroller:id/permission_allow_button"



- tapOn: "Navigate up"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/drawer_one_account"



- tapOn: "Settings"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/settings_one_account"



- tapOn: "Add account"



- tapOn:

    id: "com.fsck.k9.debug:id/account_email"

- inputText: "serious@k9mail.example"

- tapOn:

    id: "com.fsck.k9.debug:id/next"



- tapOn:

    id: "com.fsck.k9.debug:id/account_description"

- inputText: "Work"

- tapOn:

    id: "com.fsck.k9.debug:id/done"



- tapOn: "Navigate up"

- tapOn: "Manage folders"



- tapOn: "Inbox"

- tapOn: "Unify"

- back



- tapOn: "Turing Awards"

- tapOn: "Unify"

- back

- back



- tapOn: "Navigate up"

- tapOn: "Turing Awards"

- swipe:

    direction: DOWN



- back



- tapOn:

    id: "com.fsck.k9.debug:id/contact_picture"

    index: 0

- tapOn:

    id: "com.fsck.k9.debug:id/subject"

    index: 1

- tapOn:

    id: "com.fsck.k9.debug:id/subject"

    index: 2

- tapOn:

    id: "com.fsck.k9.debug:id/subject"

    index: 3

- tapOn:

    id: "com.fsck.k9.debug:id/delete"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/unified_inbox"



- tapOn: "Navigate up"

- tapOn:

    id: "com.fsck.k9.debug:id/material_drawer_account_header_text_switcher"

- tapOn: "Personal"

- back



- tapOn: "Navigate up"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/drawer_two_accounts"



- tapOn:

    id: "com.fsck.k9.debug:id/material_drawer_account_header_text_switcher"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/drawer_account_list"



- tapOn:

    id: "com.fsck.k9.debug:id/material_drawer_account_header_text_switcher"



- tapOn: "Settings"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/settings_two_accounts"



- tapOn: "Work"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_settings"



- tapOn: "More options"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/account_settings_menu_expanded"

ui-flows/screenshots/user_manual_reading.yml

deleted100644 → 0
+0 −84
Original line number Diff line number Diff line 
appId: com.fsck.k9.debug

---

- launchApp:

    clearState: true



- tapOn:

    id: "com.fsck.k9.debug:id/next"



- tapOn:

    id: "com.fsck.k9.debug:id/account_email"

- inputText: "fun@k9mail.example"

- tapOn:

    id: "com.fsck.k9.debug:id/next"



- tapOn:

    id: "com.fsck.k9.debug:id/account_description"

- inputText: "Personal"

- tapOn:

    id: "com.fsck.k9.debug:id/account_name"

- inputText: "Demo User"

- tapOn:

    id: "com.fsck.k9.debug:id/done"



- tapOn:

    id: "com.android.permissioncontroller:id/permission_allow_button"



- tapOn: "Navigate up"

- tapOn: "Settings"

- tapOn: "Add account"



- tapOn:

    id: "com.fsck.k9.debug:id/account_email"

- inputText: "serious@k9mail.example"

- tapOn:

    id: "com.fsck.k9.debug:id/next"



- tapOn:

    id: "com.fsck.k9.debug:id/account_description"

- inputText: "Work"

- tapOn:

    id: "com.fsck.k9.debug:id/done"



- tapOn: "Navigate up"

- tapOn: "Turing Awards"

- swipe:

    direction: DOWN





- tapOn: "More options"

- tapOn:

    id: "com.fsck.k9.debug:id/title"

    index: 1

- tapOn:

    id: "android:id/button1"

- tapOn:

    id: "com.fsck.k9.debug:id/contact_picture"

    index: 0

- tapOn:

    id: "com.fsck.k9.debug:id/subject"

    index: 1

- tapOn: "Mark unread"



- tapOn:

    id: "com.fsck.k9.debug:id/subject"

    index: 2



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/message_list_multi_select"



- back



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/reading_folder_view"



- scrollUntilVisible:

    element:

      id: "com.fsck.k9.debug:id/subject"

      text: "The Humble Programmer"

    direction: DOWN

    timeout: 5000

- tapOn: "The Humble Programmer"



- waitForAnimationToEnd

- takeScreenshot: "user-manual/screenshots/reading_email_view"

user-manual/.gitignore

deleted100644 → 0
+0 −2
Original line number Diff line number Diff line 
screenshots/

output/

user-manual/README.md

deleted100644 → 0
+0 −28
Original line number Diff line number Diff line 
# User Manual Tooling



This directory contains scripts to automate creating screenshots for the [user manual](https://docs.k9mail.app/) whose

source can be found in the [k9mail-docs](https://github.com/k9mail/k9mail-docs) repository.



## Requirements



- [Bash](https://www.gnu.org/software/bash/)

- [Maestro](https://maestro.mobile.dev/)

- [ImageMagick](https://imagemagick.org/)'s `convert` command line tool



## Usage



1. Start an emulator with the following configuration:



   - Device: Pixel 2

   - Size: 1080x1920

   - Density: 420 dpi

   - API 33 "Android 13.0 (Google APIs)" - not "… (Google Play)"



2. Run `./build_images.sh`



   This will enable [System UI Demo Mode](https://android.googlesource.com/platform/frameworks/base/+/master/packages/SystemUI/docs/demo_mode.md)

   on the emulator, run the Maestro flows `ui-flows/screenshots/user_manual*` to record screenshots, then run a

   post-processing step on the screenshots.



3. The final images can be found in the `output` directory. Copy as necessary to the

   [k9mail-docs](https://github.com/k9mail/k9mail-docs) repository.