Skip to content

Commit f518634

Browse files
thejhhthejhh
committed
Added initial docs for livelog
1 parent 5a976c7 commit f518634

13 files changed

+176
-0
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Livelog metadata

‎src/ServiceLivelog.html

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<View name="ServiceLivelog">
2+
<div class="service-livelog">
3+
<CardsContainer>
4+
<FoldableCard
5+
title="serviceLivelog.foldableCardTitle"
6+
image="../../../../assets/icons/taklogo.png">
7+
<div class="flex flex-col items-center justify-center p-5">
8+
<ServiceInfoCard
9+
title="serviceLivelog.serviceInfoCardTitle"
10+
image="../../../../assets/icons/taklogo.png"
11+
></ServiceInfoCard>
12+
<UnfoldableCard title="serviceLivelog.unfoldableCardTitle">
13+
<Description>serviceLivelog.step1Description</Description>
14+
<Description>serviceLivelog.step2Description</Description>
15+
<Description>serviceLivelog.step3Description</Description>
16+
</UnfoldableCard>
17+
<div class="flex flex-col items-center justify-center px-0 w-full">
18+
<Button
19+
variant='{"width":full"}'
20+
onClick='{"navigate": "/app/services/livelog/usage"}'
21+
class="m-1 px-2 w-full min-h-[4rem]"
22+
>
23+
<div class="flex items-center justify-center w-full h-full">
24+
<img
25+
src="../../../../assets/icons/sota.png"
26+
alt="keys"
27+
class="h-5 w-5 mr-2"
28+
/>
29+
serviceLivelog.guideButton.usage
30+
</div>
31+
</Button>
32+
<Button
33+
variant='{"width": "full"}'
34+
onClick='{"navigate": "/app/services/livelog/usage"}'
35+
class="m-1 px-3 bg-success text-white w-full"
36+
>serviceLivelog.grabZipButton</Button>
37+
</div>
38+
</div>
39+
</FoldableCard>
40+
</CardsContainer>
41+
</div>
42+
</View>

‎src/assets/PVARKI-livelogi-ohje-2.jpg

64.7 KB
Loading

‎src/assets/PVARKI-livelogi-ohje-3.jpg

78.1 KB
Loading

‎src/assets/PVARKI-livelogi-ohje.jpg

338 KB
Loading

‎src/common/LivelogNote.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<Component name="LivelogNote">
2+
<div class="note m-2 text-white prose prose-white">
3+
<Component.Children></Component.Children>
4+
</div>
5+
</Component>

‎src/translations/ServiceLivelog.en.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"serviceLivelog.foldableCardTitle": "Livelog",
3+
"serviceLivelog.serviceInfoCardTitle": "Livelog Event Service",
4+
"serviceLivelog.unfoldableCardTitle": "How to get started",
5+
"serviceLivelog.step1Description": "<strong>Quickstart Guide</strong> tells you how to start using Livelog on your device.",
6+
"serviceLivelog.step2Description": "The <strong>Usage Guide</strong> tells you how to use the application, according to our standard model.",
7+
"serviceLivelog.step3Description": "Download the <strong>Client Package</strong> and install it to your TAK device according to the Quickstart Guide, to get using the app.",
8+
"serviceLivelogUsageCard.title": "Purpose",
9+
"serviceLivelogUsageCard.content": "<ul><li>Real-time tracking of friendlies <em>(GPS).</em></li><li>Send observations to the command post (HQ) for interpretation.</li><li>Follow the <strong>Recon Feed</strong> that your command post (HQ) creates for your unit.</li></ul>",
10+
"serviceLivelog.guideButton.quickStart": "Quickstart",
11+
"serviceLivelog.guideButton.usage": "Usage Guide",
12+
"serviceLivelog.grabZipButton": "Open Livelog",
13+
"serviceLivelogUsageView.navbarTitle": "Livelog Usage Guide",
14+
"serviceLivelogUsageView.title": "Livelog",
15+
"serviceLivelogUsageView.subtitle1": "1. Creating a new event",
16+
"serviceLivelogUsageView.subtitle2": "2. Searching existing events",
17+
"serviceLivelogUsageView.subtitle3": "3. Viewing existing events",
18+
"serviceLivelogUsageView.subtitle4": "4. Single event view"
19+
}

‎src/translations/ServiceLivelog.fi.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"serviceLivelog.foldableCardTitle": "Livelog",
3+
"serviceLivelog.serviceInfoCardTitle": "Lokisovellus Livelog",
4+
"serviceLivelog.unfoldableCardTitle": "Näin otat käyttöön",
5+
"serviceLivelog.step1Description": "<strong>Käyttöönotto-ohje</strong> opastaa palvelun käyttöönoton laitteellesi.",
6+
"serviceLivelog.step2Description": "Ohje <strong>Käyttö joukossa</strong> opastaa, miten käytät sovellusta perusmallin mukaisesti.",
7+
"serviceLivelog.step3Description": "<strong>Viestiperustepaketti</strong> sisältää ladattavat henkilökohtaiset perusteesi.",
8+
"serviceLivelogUsageCard.title": "Käyttötarkoitus lyhyesti",
9+
"serviceLivelogUsageCard.content": "<ul><li>Käyttäjiesi seuranta reaaliajassa <em>(GPS).</em></li><li>Lähetä havaintoja komentopaikalle. (HQ) tulkittavaksi</li><li>Seuraa <strong>Recon Feediä</strong>, mitä komentopaikka (HQ) muodostaa joukollesi.</li></ul>",
10+
"serviceLivelog.guideButton.quickStart": "Käyttöönotto",
11+
"serviceLivelog.guideButton.usage": "Käyttö joukossa",
12+
"serviceLivelog.grabZipButton": "Avaa Liveloki",
13+
"serviceLivelogUsageView.navbarTitle": "Livelokin käyttöohje",
14+
"serviceLivelogUsageView.title": "Livelokin käyttöohje",
15+
"serviceLivelogUsageView.subTitle1": "1. Creating a new event",
16+
"serviceLivelogUsageView.subTitle2": "2. Searching existing events",
17+
"serviceLivelogUsageView.subTitle3": "3. Viewing existing events",
18+
"serviceLivelogUsageView.subTitle4": "4. Single event view"
19+
}

‎src/usage/LivelogUsage1.Component.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Livelog is platform to aggregate and enrich data brought from different sources.
2+
All data in Livelog is handled in "events". Single event can contain following inputs:
3+
4+
![PVARKI-livelogi-ohje](../assets/PVARKI-livelogi-ohje.jpg)
5+
6+
1. Header
7+
* Header of the event.
8+
2. Source
9+
- Where the data is coming from.
10+
3. Date / time
11+
- Date and time of the event (this is the time when something happened, not when it was submitted to Livelog).
12+
4. HCOE Domains
13+
- Categorization of the event based on Hybrid CoE classification.
14+
5. Link
15+
- If the event was something that has permanent link (for example Facebook post/ news article, forum post, etc)
16+
6. Admiralty code -> Reliability / Accuracy
17+
- https://en.wikipedia.org/wiki/Admiralty_code
18+
7. Keywords
19+
- Tags/keywords to help group and search information.
20+
- Drop down menu will show and search existing keywords when user is inputting a new keyword.
21+
8. Location
22+
- Geographic location of the event
23+
- Includes option to input coordinates and/or free text, if coordinates are unknown.
24+
- Location can also be set by using the provided map.
25+
26+
After inputting the event details, you can add another event by pressing the "Add Another Event" (9) or press "Submit Event" (10) to save already ready events.

‎src/usage/LivelogUsage2.Component.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Search (11) allows user to perform search of the database for existing events. It will also use fuzzy search to filter results real time while user is typing.
2+
3+
Alert Keyword (12) will highlight all events matching the user input.
4+
5+
Search and Alert can be used both together to narrow down results and mark important results more clearly.
6+
7+
Toggle Map icon (13) opens the map displaying all existing events that have coordinates set.
8+
9+
Toggle List icon (14) opens the list listing all events or events matching the user input.

0 commit comments

Comments
 (0)