Skip to content

Commit 33e4ac4

Browse files
committed
chore: Review docs files in vs code to get spellchecker and markdown linting and reliable preview
1 parent f4deae3 commit 33e4ac4

File tree

3 files changed

+26
-25
lines changed

3 files changed

+26
-25
lines changed

cSpell.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
"version": "0.2",
44
"language": "en,de",
55
"words": [
6-
// Add custom words here
6+
"appsettings",
77
"DevTKSS",
88
"Listboard",
99
"Mvux",
10-
"appsettings",
11-
"sampledata",
12-
"Resizetizer"
10+
"Resizetizer",
11+
"resw",
12+
"sampledata"
1313
],
1414
"dictionaries": [
1515
"csharp",
@@ -22,4 +22,4 @@
2222
"dist/**",
2323
"src/*"
2424
]
25-
}
25+
}

doc/articles/MvuxGallery/How-To-XamlNavigation.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,15 @@ Jede Anwendung, die mehr als eine einzige Seite umfasst oder eben nicht vollkomm
88
Grundlegend enthält es die gleichen Bausteine wie man es von einer Navigation mittels Landkarte und Co kennt:
99

1010
- **Eine Sammlung von `ViewMap`'s**, mit der wir dem Navigator mitteilen, welche Seite mit welchen Daten zusammengehört. Das kann ein ViewModel oder auch spezifischen Daten sein, wobei es dann ein `DataViewMap` element zusätzlich wird.
11-
- **Eine hierarchisch aufgebaute `Routes` Sammlung**, mit der wir dem Navigator mitteilen, in welcher Relation die verschiedenen Routen zueinander stehen. Wenn wir keine Relation in dem Sinne haben, dann wäre es eine schlichte flache Liste, aber sagen wir mal, wir wollen eine seitliche Navigationsleiste (hierzu können wir bspw. TabBar oder NavigationView nutzen) haben, dann wird das oberste Element in dem eben diese Navigationssteuerelemente UI technisch definiert sind, zum hierarchisch übergeordneten Element auch in unseren Routes:
12-
13-
```plaintext
14-
- MainPage mit NavigationView
15-
- SecondPage
16-
- ThirdPage
17-
```
11+
- **Eine hierarchisch aufgebaute `Routes` Sammlung**, mit der wir dem Navigator mitteilen, in welcher Relation die verschiedenen Routen zueinander stehen. Wenn wir keine Relation in dem Sinne haben, dann wäre es eine schlichte flache Liste, aber sagen wir mal, wir wollen eine seitliche Navigationsleiste (hierzu können wir bspw. TabBar oder NavigationView nutzen) haben, dann wird das oberste Element in dem eben diese Navigationssteuerelemente UI technisch definiert sind, zum hierarchisch übergeordneten Element auch in unseren Routes, hierzu aber später mehr.
1812

1913
## Voraussetzungen erfüllen
2014

2115
Bevor es los geht, prüft bitte mit `Uno.Check` ob eure Entwicklungs-Umgebung startklar ist. Hierzu habe ich euch eine kurze Link Sammlung zu allen dahingehenden Dokumentations-Seiten im Bereich [Getting Started](../getting-started.md) erstellt.
2216

2317
Solltet ihr schon eine existierende Uno Anwendung haben, prüft einfach mal in der .csproj Datei, ob ihr in der `UnoFeatures` Sammlung die Elemente `Hosting` und `Navigation` habt und fügt diese hinzu, wenn das nicht bereits der Fall sein sollte.
2418

25-
Des weiteren benötigt eure App.xaml.cs Datei folgende Elemente:
19+
Des weiteren benötigt eure App.xaml.cs Datei folgende Elemente als Anfangs Inhalt:
2620

2721
<!--![code-csharp[](../../../src/DevTKSS.Uno.Samples.MvuxGallery/App.xaml.cs?highlight=L19-L23,L96,L110,L113-L115,L124-L130)] TODO: uncomment as soon as the docs are DocFx generated-->
2822
```diff

doc/articles/MvuxGallery/Overview.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@ uid: DevTKSS.Uno.SampleApps.MvuxGallery.Overview
44

55
## Mvux Gallery
66

7-
At the [Mvux Gallery](../../../src/DevTKSS.Uno.Samples.MvuxGallery/) you can explore the following features:
7+
The [Mvux Gallery (source link)](../../../src/DevTKSS.Uno.Samples.MvuxGallery/) Tutorials are currently:
8+
9+
- [How-To: Xaml Navigation mit NavigationView (deutschsprachig)](./How-To-XamlNavigation.md)
810

911
### Controls
1012

13+
Here is a list of Controls and Features you can explore in the MvuxGallery App with links to their Source code in this Repository.
14+
1115
- [Card](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/SimpleCardsPage.xaml)
1216
- [Counter](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/CounterPage.xaml) and [CounterModel](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/CounterModel.cs)
13-
- [FeedView + GridView](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/DashboardPage.xaml)and [Model](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/DashboardModel.cs)
14-
- [FeedView + ListView](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/ListboardPage.xaml)and [Model](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/ListboardModel.cs)
17+
- [FeedView + GridView](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/DashboardPage.xaml) and [Model](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/DashboardModel.cs)
18+
- [FeedView + ListView](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/ListboardPage.xaml) and [Model](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/ListboardModel.cs)
1519
- [DataTemplate centralized Resource Definition](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml)
1620
- [`ItemOverlayTemplate` DataTemplate](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml) (*Layout replicated from WinUI 3 Gallery*)
1721
- [TabBar and TabBarItem](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/DashboardPage.xaml) and [Model for Binding Items to ListFeed](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/DashboardModel.cs)
@@ -50,35 +54,38 @@ At the [Mvux Gallery](../../../src/DevTKSS.Uno.Samples.MvuxGallery/) you can exp
5054
- [CodeSampleOptionsContext](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOptions.cs)
5155
- [CodeSampleOptionsConfiguration](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOptionsConfiguration.cs)
5256

57+
> [!NOTE]
58+
> Currently `ValueTuple<int,int>` and `Dictionary<string, CodeSampleOption>` Definitions of IOptions loaded Settings could'nt get successfully loaded, therefore this is defined as Array for Workaround.
59+
5360
- Configuration
5461
- Data for Serialization
5562
- [appsettings.sampledata.json](../../../src/DevTKSS.Uno.Samples.MvuxGallery/appsettings.sampledata.json)
63+
- [`IOptions<CodeSampleOptionsConfiguration>` in Service](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleService.cs)
5664

5765
- Storage
5866
- Via Model
5967
- [DashboardModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/DashboardModel.cs)
6068
- Via Service
6169
- [CodeSampleService.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleService.cs)
62-
- Via StorageExtension
63-
- Currently in private preview package
64-
- Via Uno.Extensions.Storage.IStorage Interface extension
70+
- Via [own StorageExtensions](../../../src/DevTKSS.Extensions.Uno/StorageExtensions.cs) and [IEnumerableExtensions](../../../src/DevTKSS.Extensions.Uno/EnumerableExtensions.string.cs) (*temporary imported until PR might get merged or Package gets published*)
71+
- Via Uno.Extensions.Storage.StorageExtensions
6572
- added as PR to Uno.Extensions [#2734](https://github.com/unoplatform/uno.extensions/pull/2734)
6673

6774
- Localization
6875
- **IStringLocalizer**
69-
- Resources Dictionaries
76+
- Resources Dictionaries (*I recommend to lookup those links using Visual Studio 2022*)
7077
- [en](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Strings/en/)
7178
- [de](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Strings/de/)
72-
- Binding current value in `IState<string>` and to corresponding View
79+
- Binding current value in `IState<string>` and to corresponding View
7380
- [DashboardModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/DashboardModel.cs)
7481
- [ListboardModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/ListboardModel.cs)
7582
- [MainModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/MainModel.cs)
76-
- CounterModel.cs
77-
- Requesting localized Items via FeedView
78-
- Service Definition
83+
- [CounterModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/CounterModel.cs)
84+
- Requesting localized Items via FeedView
85+
- Service Definition
7986
- [GalleryImageService.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/GalleryImageService.cs)
8087
- [IGalleryImageService.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/IGalleryImageService.cs)
81-
- Data Model Definition
88+
- Data Model Definition
8289
- [GalleryImageModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/GalleryImageModel.cs)
8390
- **ILocalizationService**
8491
- Requesting current culture

0 commit comments

Comments
 (0)