Skip to content

Commit

Permalink
Admonitions with the colon_fence extension
Browse files Browse the repository at this point in the history
  • Loading branch information
psonnera committed Sep 26, 2024
1 parent 6a17f89 commit 9689da2
Show file tree
Hide file tree
Showing 25 changed files with 232 additions and 242 deletions.
4 changes: 2 additions & 2 deletions docs/EN/5-DailyLifewithAAPS/DailyLife-PUMPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Physical cartridge/reservoir changes cannot be done via **AAPS** and have to be

If you are confident that you haven’t received any insulin for a period of time, despite **AAPS** recording that you have, and you know exactly when the issue started (_e.g._ you remove the cannula and see that the cannula was kinked during the insertion process) you can correct this in **AAPS**, while being aware that the insulin may in fact have been delivered but may be slow to act for some reason.

:::{admonition} Caution - Risk of Hypoglycemia
```{admonition} Caution - Risk of Hypoglycemia
:class: danger
Only delete insulin delivery from **AAPS** with EXTREME caution, in case insulin _has_ actually been delivered, and monitor BG closely for the next 24 h.
:::
```

To remove boluses and SMBs which you know have not been delivered, open the Treatments tab and conservatively delete the logged bolus information from > carbs and bolus starting from the point the incident happened. This will correct the “insulin on board” (IOB) value which is key for **AAPS**’ calculations, if you now return to the homescreen you will see that the IOB has now reduced. Be aware that you cannot delete basal insulin which **AAPS** calculates to have been delivered, so that will still be taken into account by **AAPS**.

Expand Down
13 changes: 4 additions & 9 deletions docs/EN/Administration/stateTranslations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,16 @@

The state is once per hour updated and reflects only the state in Crowdin.

:::{tip}

```{tip}
Be careful the percentage of proofreading must be lower then the percentage of translations but they decided to show it on top of the translations.
It's better to look only at the percentage level of translations to see if work is to be done.
```

:::

:::{admonition} needed time for final publication
:class: note

```{admonition} needed time for final publication
After Crowdin translation a sync to Github is scheduled every day to transfer translations to Github as pull request (PR).
The acceptance of the PR is a manual task which will be done es fast as possible.

:::
```

## state app translation

Expand Down
7 changes: 4 additions & 3 deletions docs/EN/Configuration/Preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,10 +422,11 @@ Original communication protocol, can be used with older Nightscout versions.

[New protocol introduced with AAPS 3.2.](../Installing-AndroidAPS/Releasenotes.md#important-comments-on-using-v3-versus-v1-api-for-nightscout-with-aaps) Safer and more efficient.

:::{admonition} V3 data uploaders
```{admonition} V3 data uploaders
:class: warning
When using NSClientV3, all uploaders must be using the API V3. Since most are not compatible yet, this means **you must let AAPS upload all data** (BG, treatments, ...) to Nightscout and disable all other uploaders if they're not V3 compliant.
:::
When using NSClientV3, all uploaders must be using the API V3. Since most are not compatible yet, this means **you must let AAPS upload all data** (BG, treatments, ...) to Nightscout and disable all other uploaders if they're not V3 compliant.
```

- Set your *Nightscout URL* (i.e. <https://yoursitename.yourplaform.dom>).
- **Make sure that the URL is WITHOUT /api/v1/ at the end.**
Expand Down
10 changes: 5 additions & 5 deletions docs/EN/Configuration/xdrip.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ If the checkbox for `Automatic Calibration` is checked, activate `Download treat

Tap `Extra Options`(8)

:::{admonition} Safety warning
```{admonition} Safety warning
:class: warning
You must deactivate "Upload treatments" from xDrip+, otherwise treatments can be doubled in AAPS leading to false COB and IOB.
:::
You must deactivate "Upload treatments" from xDrip+, otherwise treatments can be doubled in AAPS leading to false COB and IOB.
```

Deactivate `Upload treatments`(9) and make sure you will **NOT** use `Back-fill data` (11).

Expand Down Expand Up @@ -233,10 +233,10 @@ Follow [these instructions](https://navid200.github.io/xDrip/docs/Dexcom/SensorF

- Start the sensor in xDrip+.

:::{admonition} Safety warning
```{admonition} Safety warning
:class: warning
Do not use sensor data before the one hour warm-up is over: the values can be extremely high and cause wrong decisions in AAPS.
:::
```

→ Hamburger Menu (1) → Start sensor (2) → Start sensor (3) → Set the exact time you started it with the reader or the vendor app. If you didn't start it today, answer "Not Today" (4).

Expand Down
4 changes: 2 additions & 2 deletions docs/EN/Hardware/DexcomG5.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

## If using G5 with patched Dexcom app

:::{admonition} Legacy apps
```{admonition} Legacy apps
:class: warning
These apps are not compatible with recent Android versions.
:::
```

- Download the apk from <https://github.com/dexcomapp/dexcomapp>, and choose the version that fits your needs (mg/dl or mmol/l version, G5).

Expand Down
4 changes: 2 additions & 2 deletions docs/EN/Hardware/DexcomG7.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Noteworthy is the fact that the G7 and ONE+ systems, compared to the G6, do not

![G7 english](../images/6fe30b84-227a-4bae-a9a5-527cee341dbf.png)

:::{admonition} [Smoothing method](../Usage/Smoothing-Blood-Glucose-Data)
```{admonition} [Smoothing method](../Usage/Smoothing-Blood-Glucose-Data)
:class: warning
**Exponential Smoothing** **MUST** be enabled for meaningful use of the G7 / ONE+ values.
:::
```

## 1. Patched Dexcom G7 App (DiAKEM)

Expand Down
4 changes: 2 additions & 2 deletions docs/EN/Hardware/Libre1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
To use your Libre as a CGM that is getting new BG values every 5 minutes without having to scan the sensor,
you need to buy an NFC to Bluetooth bridge (commercially available devices, based on the obsolete [LimiTTer](https://github.com/JoernL/LimiTTer) project).

:::{admonition} Libre 2, Libre 1 US and Libre Pro
```{admonition} Libre 2, Libre 1 US and Libre Pro
:class: warning
Verify the bridge and the app you want to use are compatible with your sensor.
:::
```

Several bridges are available on the market:

Expand Down
12 changes: 6 additions & 6 deletions docs/EN/Hardware/Libre2.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Remark: The transmitter can be used in parallel to the LibreLink app without int

## 2. Use xDrip+ direct connection

:::{admonition} Libre 2 EU only
```{admonition} Libre 2 EU only
:class: warning
xDrip+ doesn't support direct connection to Libre 2 US and AUS.
:::
```

- Follow [these instructions](https://www.minimallooper.com/post/how-to-setup-freestyle-libre-2-and-oop2-to-use-a-native-bluetooth-connection-in-xdrip) to setup xDrip+ but make sure to download [this latest OOP2](https://drive.google.com/file/d/1f1VHW2I8w7Xe3kSQqdaY3kihPLs47ILS/view) as the one in the document is obsolete.
- Follow setup instructions on [xDrip+ settings page](../Configuration/xdrip.md).
Expand All @@ -54,19 +54,19 @@ xDrip+ doesn't support direct connection to Libre 2 US and AUS.

- Select xDrip+ in in [ConfigBuilder, BG Source](../Configuration/Config-Builder.md#bg-source).

:::{admonition} Use with xDrip+
```{admonition} Use with xDrip+
:class: note
You can set Juggluco to broadcast to xDrip+ with Patched Libre Broadcast (you should disable xDrip+ broadcast), in order to calibrate (see here) and avoid 1 minute readings to be sent to AAPS.
![Juggluco broadcast to xDrip+](../images/Juggluco_xDrip.png)
You will then need to set xDrip+ data source to Libre 2 Patched App to receive data from Juggluco.
:::
```

## 5. Use the patched LibreLink app with xDrip+

:::{admonition} Libre 2 EU only
```{admonition} Libre 2 EU only
:class: warning
The patched app is an old version (22/4/2019) and might not be compatible with recent Android releases.
:::
```

### Step 1: Build the patched app

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Some **AAPS** users prefer to use their main email account for **AAPS** as well.

If you don't want to set up an **AAPS**-dedicated Gmail account, you can just go straight to the next section, [building AAPS](building-AAPS.md).

:::{admonition} Advantages of a dedicated Google account for AAPS
```{admonition} Advantages of a dedicated Google account for AAPS
:class: dropdown
- Dedicated Google drive space means you will not risk filling up your personal Google drive limit with **Export Preferences**.
Expand All @@ -13,7 +13,7 @@ If you don't want to set up an **AAPS**-dedicated Gmail account, you can just go
- Depending on the setup (see below), you will have a separate identity as an alias to communicate within the community which can protect your privacy. 
- Children with T1D can preserve their own “everyday” email account as minors while using **AAPS** and associated features which require an adult account.
- Gmail allows you to register up to 4 accounts under the same phone number.
:::
```

## How to set up a dedicated Google account for AAPS

Expand All @@ -26,21 +26,21 @@ Requirements:
* You have a Windows’ PC (Windows 10 or newer) and a Android phone (Android 9 or newer) which will host the **AAPS** app. These both have all the latest security updates, internet access and admin privileges, since some steps require downloading and installing programs.
* The Android phone is already set-up with your personal ”everyday”  email address, such as a Gmail account.

:::{admonition} Things to consider when setting up your new account
```{admonition} Things to consider when setting up your new account
:class: dropdown
- You could use a name different to your own, which has relevance to the account (like t1dsuperstar) for privacy reasons. You can then use it in **AAPS** public forums while keeping your own identity private. Since Google requires a recovery email and phone number, it is still traceable.
- The new **AAPS** account will use the same phone number for verification as your “_everyday_” one. It will use the “everyday” email address for verification;
- We will setup email forwarding such that any email sent to the new dedicated AAPS account will be forwarded to the primary one (so there is no need to check two different mailboxes);
- Use separate passwords for your _everyday_ Gmail account and the AAPS-dedicated Gmail account
- If you use google “2-step verification” (aka multifactor) authentication for one Gmail account, you might as well do it for both Gmail accounts.
- If you plan to use Google “Passkeys”, make sure you register multiple devices. This is so you don’t lock yourself out. Only do it on devices that nobody else can access (_i.e._ not on a PC with a shared account that other people can unlock).
:::
```


:::{admonition} Video Walkthrough!
```{admonition} Video Walkthrough!
:class: Note
Click [here](<https://drive.google.com/file/d/1dMZTIolO-kd2eB0soP7boEVtHeCDEQBF/view?usp=drive_link>) for a video walkthrough of how to set up a dedicated Google account.
:::
```

These are the steps outlined in the video:

Expand Down
4 changes: 2 additions & 2 deletions docs/EN/Installing-AndroidAPS/Update-to-new-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ See the [Export & import settings](ExportImportSettings-export-settings) page if
(Update-to-new-version-update-your-local-copy)=
## 2. Update your local copy

:::{admonition} WARNING
```{admonition} WARNING
:class: warning
If you update from versions prior to 2.8.x, please follow the instructions to do a [New clone](../Installing-AndroidAPS/building-AAPS), as this guide will not work for you!
:::
```

* Open your existing AAPS project with Android Studio. You might need to select your project. (Double) click on the AAPS project.

Expand Down
48 changes: 24 additions & 24 deletions docs/EN/Installing-AndroidAPS/building-AAPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ If you think something in the building instructions is wrong, missing or confusi

## Step-by-step guide to building the AAPS app

:::{admonition} WARNING
```{admonition} WARNING
:class: warning
If you have built AAPS before, you don't need to take all the following steps again.
Please jump directly to the [update guide](../Installing-AndroidAPS/Update-to-new-version)!
:::
```

The overall steps for building the **AAPS** apk file are as follows:

Expand All @@ -90,12 +90,12 @@ Since **Android Studio** runs on Windows, Mac OS X and Linux platforms, there mi
(Install-Git)=
### Install Git (if you don't have it)

:::{admonition} Why Git?
```{admonition} Why Git?
:class: dropdown
Git is known as a “_Versioning Control System_” (VCS).\
Git is a program that allows you to track changes in code and to collaborate with others. You will use Git to make a copy of the **AAPS** source code from the GitHub website to your local computer. Then, you will use Git on your computer to build the **AAPS** application (apk).
:::
```

#### Steps for Installing Git

Expand Down Expand Up @@ -123,10 +123,10 @@ Git is a program that allows you to track changes in code and to collaborate wit

- **You have to be online all of the time during the following steps, as Android Studio downloads several updates**

:::{admonition} What is Android Studio?
```{admonition} What is Android Studio?
:class: dropdown
Android Studio is a program which runs on your computer. It allows you to download source code from the internet (using Git) and build smartphone (and smartwatch) apps. You cannot "break" a current, looping version of **AAPS** which you might have running on a smartphone by building a new or updated app on your PC with Android Studio, these are totally separate processes.
:::
```

The following screenshots have been taken from Android Studio Version **Hedgehog**, they should be identical with more recent versions.

Expand Down Expand Up @@ -180,11 +180,11 @@ You will now get a message about a missing software development kit (SDK) (don't

The software should autoselect the required (SDK) and choose a location.

:::{admonition} What is an Android SDK?
```{admonition} What is an Android SDK?
:class: dropdown
In order to run **AAPS** on the phone the application needs to integrate with Android itself. Android provides “_software development kits_” (SDK) which allow apps like **AAPS** to interface with an Android operating system.
:::
```

The SDK platform package does **not** relate to the version of Android running on your phone, but to the build of **AAPS**. **AAPS** version 3.2 (and newer) builds on top of API level 34, which is automatically selected in the **Hedgehog** version of **Android Studio**. Therefore, simply click "Next":

Expand Down Expand Up @@ -218,14 +218,14 @@ You are now greeted with the "Welcome to Android Studio" screen.
(Building-APK-download-AAPS-code)=
### Download the AAPS code

:::{admonition} Why can it take a long time to download the AAPS code?
```{admonition} Why can it take a long time to download the AAPS code?
:class: dropdown
The first time **AAPS** is downloaded, Android Studio will connect over the internet to the Github website to download the source code for **AAPS**. This should take about 1 minute.
Android Studio will then use **Gradle** (a development tool in Android studio) to identify other components needed to install these items on your computer.
:::
```

On the Android Studio Welcome screen, check that "**Projects**" (1) is highlighted on the left. Then click "**Get from VCS**" (2) on the right:

Expand All @@ -247,10 +247,10 @@ and paste it into the URL textbox (3).

* Check the (default) directory for saving the cloned code is sensible (4).

:::{admonition} INFORMATION
```{admonition} INFORMATION
:class: information
Make a note of the directory. It is where your sourcecode is stored!
:::
```

* Now click the button "Clone" (5).

Expand Down Expand Up @@ -293,11 +293,11 @@ When Android Studio opened again, wait patiently (this may take a few minutes),

![AS_download_dependencies](../images/Building-the-App/19_downloading_dependencies.png)

:::{admonition} NEVER UPDATE GRADLE!
```{admonition} NEVER UPDATE GRADLE!
:class: warning
Android Studio might recommend updating the gradle system. **Never update gradle!** This will lead to difficulties.
:::
```

_Optional_ - If you want to clear the pop-up for **"project update recommended"**, click on the blue text "More" (1). In the dialog box the select "Don't ask for this project" (2).

Expand Down Expand Up @@ -349,11 +349,11 @@ When the Git version is displayed next to the path (see screenshot above) you ha
(Building-APK-generate-signed-apk)=
### Build the AAPS "signed" APK

:::{admonition} Why does the AAPS app need to be "signed"?
```{admonition} Why does the AAPS app need to be "signed"?
:class: dropdown
Android requires each app to be _signed_, to ensure that it can only be updated later from the same trusted source that released the original app. For more information on this topic, follow [this link](https://developer.android.com/studio/publish/app-signing.html#generate-key). For our purposes, this just means that we generate a signing or "keystore" file and use it when we build the **AAPS** app.
:::
```

* In the menu bar, click "Build" (1), select "Generate Signed Bundle/APK (2)

Expand All @@ -366,18 +366,18 @@ Android requires each app to be _signed_, to ensure that it can only be updated
* In the next screen, make sure that "Module" is set to "AAPS.app" (1).

(Building-APK-wearapk)=
:::{admonition} INFORMATION!
```{admonition} INFORMATION!
:class: information
If you want to create the apk for your watch, you need to select AAPS.wear!
:::
```

* Click "Create new..." (2) to start creating your key store.

:::{admonition} INFORMATION!
```{admonition} INFORMATION!
:class: information
You will only need to create the keystore once.
If you have build AAPS before, do NOT create a new keystore but select your existing one!
:::
```

**_Note:_** The key store is a file in which the information for signing the app is stored. It is encrypted, and the information is secured with passwords.

Expand All @@ -394,21 +394,21 @@ If you have build AAPS before, do NOT create a new keystore but select your exis

This will take you back to the previous screen. Your chosen location for saving the key store file is shown.

:::{admonition} WARNING!
```{admonition} WARNING!
:class: warning
Make sure to note down for yourself where your keystore is stored. You will need it when you build the next AndroidAPS update!
:::
```

Now choose a simple password (make a note of it), enter it in the password box (1), and confirm it (2). The passwords for key store and key do not have to be sophisticated. If you lose your password in the future, see [troubleshooting for lost key store](troubleshooting_androidstudio-lost-keystore).

The default alias (3) for your key is "key0", leave this unchanged.

You now need a password for your key. To keep it simple, if you want, you can use the same password you used for your keystore, above. Enter a password (4) and confirm (5) it.

:::{admonition} WARNING!
```{admonition} WARNING!
:class: warning
Note down these passwords! You will need them when you build the next AAPS update!
:::
```

The validity (6) is 25 years by default, leave it as it is.

Expand Down
Loading

0 comments on commit 9689da2

Please sign in to comment.