Skip to content

Commit e01d24d

Browse files
committed
Fix and normalize all links in english docs
1 parent 27d5a6f commit e01d24d

File tree

9 files changed

+39
-59
lines changed

9 files changed

+39
-59
lines changed

i18n/en/docusaurus-plugin-content-docs/current/03-faq.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,16 @@ import { KolLink } from '@public-ui/react';
4545
KoliBri components are not styled solely using embedded CSS or the use of CSS frameworks (such as Bootstrap, Material-UI, Tailwind CSS, etc.), but
4646
about the technical setting of CSS on the component. This has the advantage that the components are independent of the external CSS. Robustness is an architectural quality objective. It is reflected in the fact that only the component itself decides on its styling.
4747
- **Why do you need the scheme?**<br/>
48-
KoliBri is based on a sophisticated <KolLink _href="/en/docs/concepts/architecture" _label="Architecture" />. For example, the small schema package (@public-ui/schema) is used to define the tag names and language keys of the KoliBri components independently of the concrete implementation. This enables completely detached work with auto-completion when creating the theme, but without needing the components and their dependencies. This has advantages in some integration scenarios, such as static pages or content management systems (CMS).
48+
KoliBri is based on a sophisticated <KolLink _label="Architecture" _href="/en/docs/concepts/architecture" />. For example, the small schema package (@public-ui/schema) is used to define the tag names and language keys of the KoliBri components independently of the concrete implementation. This enables completely detached work with auto-completion when creating the theme, but without needing the components and their dependencies. This has advantages in some integration scenarios, such as static pages or content management systems (CMS).
4949

5050
## Technical
5151

5252
- **Why can KoliBri components really be accessible?**<br/>
5353
The KoliBri components are designed in terms of software architecture in such a way that they can only be instrumented via properties and not via their own HTML that can be entered. This means that the components can only be controlled via the API (properties). This is a quality feature because the components cannot be manipulated from the outside. The components are very restrictive and can therefore always be accessible.<br/>
54-
In order to be able to break out of this restriction, there is the <KolLink _href="/en/docs/concepts/expert-slot" _label="Expert-Slot" />, which makes it possible to embed your own HTML in the component. Accessibility via the expert slot is in the hands of the expert (developer) and should only be used in exceptional cases.
54+
In order to be able to break out of this restriction, there is the <KolLink _label="Expert-Slot" _href="/en/docs/concepts/expert-slot" />, which makes it possible to embed your own HTML in the component. Accessibility via the expert slot is in the hands of the expert (developer) and should only be used in exceptional cases.
5555
- **Why are component properties sometimes named differently from HTML naming?**<br/>
56-
In order to keep KoliBri easy to learn, the HTML naming is usually used. But even the HTML standard is not uniform in its naming across several elements (components). And that is why we have chosen uniform names for similar properties in KoliBri. See concept <KolLink _href="/en/docs/concepts/properties" _label="Properties" /> for more information.
56+
In order to keep KoliBri easy to learn, the HTML naming is usually used. But even the HTML standard is not uniform in its naming across several elements (components). And that is why we have chosen uniform names for similar properties in KoliBri. See concept <KolLink _label="Properties" _href="/en/docs/concepts/properties" /> for more information.
5757

5858
## Any questions?
5959

60-
If you still have questions, please send us an email to <KolLink _href="mailto:kolibri@itzbund.de" _label="kolibri@itzbund.de" _icons="codicon codicon-mail" />.
60+
If you still have questions, please send us an email to <KolLink _label="kolibri@itzbund.de" _href="mailto:kolibri@itzbund.de" _icons="codicon codicon-mail" />.

i18n/en/docusaurus-plugin-content-docs/current/10-get-started/5-frameworks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { KolAlert, KolLink, KolTable } from '@public-ui/react';
88

99
## Installation
1010

11-
All packages/artifacts of KoliBri are provided versioned in the public <kol-link _href="https://www.npmjs.com/search?q=%40public-ui" _target="npmjs">NPM-Registry</kol-link>.
11+
All packages/artifacts of KoliBri are provided versioned in the public <KolLink _label="NPM-Registry" _href="https://www.npmjs.com/search?q=%40public-ui" _target="_blank" />.
1212

1313
<KolTable
1414
_caption="Packages overview"

i18n/en/docusaurus-plugin-content-docs/current/20-concepts/05-styling/35-designer.mdx

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,10 @@
1-
import {
2-
KolAbbr,
3-
KolAlert,
4-
KolCard,
5-
KolHeading,
6-
KolIconIcofont,
7-
KolIndentedText,
8-
KolIcon,
9-
KolKolibri,
10-
KolDetails,
11-
KolLink,
12-
KolLogo,
13-
KolTable,
14-
} from '@public-ui/react';
1+
import {KolCard, KolLink,} from '@public-ui/react';
152

163
# Designer
174

185
<div className="grid grid-cols-2">
19-
<KolCard _headline="Create own theme" _level={2}>
20-
<KolLink slot="content" _useCase="nav" _href="/designer" _target="designer">
21-
<div className="flex gap-4 py-2">
22-
<KolIcon className="homepage" _icons="codicon codicon-paintcan" />
23-
<span>Click here to open the designer in a new browser window.</span>
24-
</div>
25-
</KolLink>
6+
<KolCard _label="Create own theme" _level={2}>
7+
<KolLink _label="Click here to open the designer in a new browser window." _href="/designer" _target="_blank" _icons={{ left:'codicon codicon-paintcan' }} />
268
</KolCard>
279
</div>
2810

i18n/en/docusaurus-plugin-content-docs/current/20-concepts/07-swizzling.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ tags:
88
- concept
99
---
1010

11+
import { KolLink } from '@public-ui/react';
12+
1113
## Motivation
1214

1315
Numerous, sometimes complex requirements for components of design systems or component libraries would not have to be considered over and over again if there were small-scale, easily reusable basic components to carry these requirements.
@@ -24,4 +26,4 @@ The easiest method to customize a KoliBri component is wrapping. Here, an own co
2426

2527
### Overwriting
2628

27-
Another variant of swizzling is the overwriting of the inner component construction. In Web Components, this is often done using slots. In KoliBri, we have introduced the <kol-link _href="expert-slot" _label="expert slots"></kol-link> for this purpose.
29+
Another variant of swizzling is the overwriting of the inner component construction. In Web Components, this is often done using slots. In KoliBri, we have introduced the <KolLink _label="expert slots" _href="expert-slot" /> for this purpose.

i18n/en/docusaurus-plugin-content-docs/current/20-concepts/09-formular.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ tags:
88
- concept
99
---
1010

11-
As part of the refactoring to improve the developer experience, we have restructured the input components and converted them into separate components according to the <kol-link _href="https://html.spec.whatwg.org/multipage/input.html" _target="w3c">W3C-Aufteilung</kol-link>.
11+
import { KolLink } from '@public-ui/react';
12+
13+
As part of the refactoring to improve the developer experience, we have restructured the input components and converted them into separate components according to the <KolLink _label="W3C separation" _href="https://html.spec.whatwg.org/multipage/input.html" _target="_blank" />.
1214
In this way, the respective components only provide the properties that also have a function for the respective type. Properties that were previously maintained but had no function were removed from the programming.
1315

1416
## Vergleich zum HTML-Tag &lt;input&gt;
1517

1618
<p>
17-
If you look at the{' '}
18-
<kol-link _href="https://developer.mozilla.org/de/docs/Web/HTML/Element/Input" _target="mozilla">
19-
<code>&lt;input&gt;</code>-tag
20-
</kol-link>{' '}
21-
, then all types of an input field are implemented with only one tag (component). This results in the fact that all properties (attributes/properties) are
19+
If you look at the <KolLink _label="" _href="https://developer.mozilla.org/de/docs/Web/HTML/Element/Input" _target="_blank">
20+
<span slot="expert"><code>&lt;input&gt;</code>-tag</span>
21+
</KolLink>, then all types of an input field are implemented with only one tag (component). This results in the fact that all properties (attributes/properties) are
2222
possible, but have no function depending on the type.
2323
</p>
2424

i18n/en/docusaurus-plugin-content-docs/current/20-concepts/10-datenschutz.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,16 @@ tags:
77
- concept
88
---
99

10+
import { KolLink } from '@public-ui/react';
11+
1012
# Privacy concept
1113

1214
This concept addresses and explains the aspects of the KoliBri component library that are relevant from a data protection perspective.
1315

14-
> The <kol-link _href="/docs_en/datenschutz">privacy policy</kol-link> regarding the open source approach is described in a separate document.
16+
> The <KolLink _label="privacy policy" _href="/docs_en/datenschutz" /> regarding the open source approach is described in a separate document.
1517
1618
## Introduction
1719

18-
The component library KoliBri has an obvious and focused target area of its technical functional expression, which is described in detail in the <kol-link _href="/docs_en/manifest">manifest</kol-link>.
20+
The component library KoliBri has an obvious and focused target area of its technical functional expression, which is described in detail in the <KolLink _label="manifest" _href="/docs_en/manifest" />.
1921

2022
KoliBri is a collection of small, semantically accessible and flexibly reusable web components without any business logic or other data processing functionalities. In particular, it does not contain any functionalities for sending data. The aim is exclusively to ensure semantically accessible HTML markup of the various elements (components) in different style guides.

i18n/en/docusaurus-plugin-content-docs/current/40-project/02-license.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ tags:
99
- legal
1010
---
1111

12+
import { KolLink } from '@public-ui/react';
13+
1214
# Licensing
1315

1416
## The EUPL is the "perfect" license‽
@@ -28,10 +30,7 @@ The "European Union Open Source License" (EUPL) is a copyleft license issued by
2830

2931
<kol-alert _type="info">
3032
On the website of the European Commission all information about the{' '}
31-
<kol-link _href="https://ec.europa.eu/info/european-union-public-licence_en" _target="eupl-1.2">
32-
European Union Public Licence (EUPL)
33-
</kol-link>{' '}
34-
can be found.
33+
<KolLink _label="European Union Public Licence (EUPL)" _href="https://ec.europa.eu/info/european-union-public-licence_en" _target="_blank" /> can be found.
3534
</kol-alert>
3635
<br />
3736
<br />

i18n/en/docusaurus-plugin-content-docs/current/41-formular-handling.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ In **KoliBri** the form components are decoupled from the form handling. This ha
2828

2929
## Input-components
3030

31-
The **input** components are the components that can be used to make form inputs. That means primarily <kol-link _href="/docs/konzepte/formular-input">inputs, select and textarea</kol-link>.
31+
The **input** components are the components that can be used to make form inputs. That means primarily <KolLink _label="inputs, select and textarea" _href="/docs/konzepte/formular-input" />.
3232

3333
## Handling adapters
3434

@@ -42,7 +42,7 @@ The form handling is then **coupled** with the **input** components via an **ada
4242

4343
### Lean-Input adapters
4444

45-
For development with TypeScript, **KoliBri** provides the **adapter** component for the form handling library <kol-link _href="https://www.npmjs.com/package/@leanup/form" _label="@leanup/form" _target="npmjs"/>.
45+
For development with TypeScript, **KoliBri** provides the **adapter** component for the form handling library <KolLink _label="@leanup/form" _href="https://www.npmjs.com/package/@leanup/form" _target="_blank" />.
4646

4747
#### Installation
4848

i18n/en/docusaurus-plugin-content-docs/current/99-impressum.mdx

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ tags:
55
- leagal
66
---
77

8-
import { KolKolibri, KolLogo } from '@public-ui/react';
9-
import { KoliBri } from '@site/src/components/KoliBri';
10-
import { translate } from '@docusaurus/Translate';
8+
9+
import {KolKolibri, KolLink, KolLogo} from '@public-ui/react';
10+
import {KoliBri} from '@site/src/components/KoliBri';
1111

1212
<div className="flex gap-4">
1313
<KolLogo
@@ -31,31 +31,26 @@ import { translate } from '@docusaurus/Translate';
3131

3232
<p>
3333
This technical documentation is published by the open source project "<KoliBri />" of the{' '}
34-
<kol-link _href="https://itzbund.de" _target="itzbund">
35-
Informationstechnikzentrum Bund (ITZBund)
36-
</kol-link>
37-
.
34+
<KolLink _label="Informationstechnikzentrum Bund (ITZBund)" _href="https://itzbund.de" _target="blank" />.
3835
</p>
3936

40-
### Adress
37+
### Address
4138

4239
<p>
43-
ITZBund Dienstsitz Bonn
44-
<br />
45-
Bernkasteler Straße 8
46-
<br />
47-
53175 Bonn
48-
<br />
40+
ITZBund Dienstsitz Bonn<br />
41+
Bernkasteler Straße 8<br />
42+
53175 Bonn<br />
4943
Germany
5044
</p>
5145

5246
### Contact
5347

5448
<p>
55-
E-Mail:
56-
<kol-link _icons="codicon codicon-mail" _href="mailto:kolibri@itzbund.de" _target="_blank">
57-
kolibri@itzbund.de
58-
</kol-link>
49+
E-Mail: <KolLink
50+
_label="kolibri@itzbund.de"
51+
_href="mailto:kolibri@itzbund.de"
52+
_icons="codicon codicon-mail"
53+
/>
5954
</p>
6055

6156
### Privacy

0 commit comments

Comments
 (0)