Beheer: /* Intro */

2024-06-25T12:40:20Z

Intro

Beheer: /* en afsluiten met */

2024-06-25T12:15:12Z

en afsluiten met

Beheer: /* Codeer Versies */

2024-06-25T11:04:42Z

Codeer Versies

OllieA: Created page with "{{TBN}} == Intro == Dit artikel beschrijft .. Bijzonder aan deze beschrijvingen is, dat er de wens is voor zowel producten beschreven worden, die wel en die niet zijn opgeno..."

2023-11-02T10:28:51Z

Created page with "{{TBN}} == Intro == Dit artikel beschrijft .. Bijzonder aan deze beschrijvingen is, dat er de wens is voor zowel producten beschreven worden, die wel en die niet zijn opgeno..."

New page

{{TBN}}
== Intro ==

Dit artikel beschrijft ..

Bijzonder aan deze beschrijvingen is, dat er de wens is voor zowel producten beschreven worden, die wel en die niet zijn opgenomen in het {{TNID| | ThuisNet}}.
In principe worden daarom de artikelen gerangschikt onder de {{TNID}} paraplu.
Dit vergemakkelijkt ook de uniforme artikelopbouw met behulp van templates als {{tl|TNID Software}} → analoog aan {{tl|TNID Host}}.

Dat laatste vergt tamelijk veel aanpassingen: Er is al heel wat beschreven ... (Zie ook [[PC Applicaties]])

Verder is er een apart template voor {{tl|APT packages}}.
Meer hierover in [[APT/Documentatie]].

== Bedoeling ==
{{tbl}}
|-
| Elk stuk software, dat volgens de hier beschreven methodiek wordt vastgelegd, zal op identieke wijze worden beschreven.
|}

=== Idee vorming ===
Om erin te komen schrijf ik uitwat zoal kan worden vastgelegd over software...

* Artikel waar alle verwijzingen naar software staan, eventueel gecategoriseerd. ({{TNID|Software}} ?)

* Per product een artikel met titels in de vorm 'ThuisNetInDetail/''categorie''/''product'''
*: NB Er is al een aantal producten beschreven waarvan de basis niet aan deze normering voldoet!

Bij elk product bovenin een tabel met primaire gegevens als
* Productnaam
* Leverancier
* Categorie
* (recentste) versie

=== Basis Templates ===

{{tbl}}
|- 
! rowspan=2 |<tt><nowiki>{{TNID Software|</nowiki>id=''Productnaam''<nowiki>}}</nowiki></tt>
| {{tl|TNID Software}} wordt gedefinieerd in het Artikel

|-
| '''Functie''': Genereert het basisartikel over de software, die in de id=parameter wordt genoemd.

|- 
! rowspan=2 | <tt><nowiki>{{TNID SoftwareTmpl|</nowiki>id=''Productnaam''<nowiki>}}</nowiki></tt>
| {{tl|TNID SoftwareTmpl}} wordt gedefinieerd in de Discussie pagina van het artikel
|-
| '''Functie''': Genereert de serie tempaltes, die uiteindelijk het artikel samenstellen.

|- 
! rowspan=2 | <tt><nowiki>{{</nowiki>infobox software ''parameters''<nowiki>}}</nowiki>|}
| {{tl|Infobox software}}
|-
| '''Functie''': definieert een tabel met daarin een reeks niet positionele ''parameters '' als volgt:

|}

;'' Zie ook'':
categorieen
::[[:Category:Code templates|Code templates]]
::[[:Category:Versie templates|Versie templates]]

; ''In detail'':
==== TNID Software ====
{{tl|TNID Software}} genereert een serie aanroepen van de templates die gezamenlijk de diverse secties in het artikel bepalen.
Met de parameter ''id='' wordt de (unieke) naam genoemd van de software, die wordt beschreven.

==== TNID SoftwareTmpl ====
{{tl|TNID SoftwareTmpl}}
wordt gebruikt in de {{us|discusse}} pagina van het beschreven software onderdeel.
Het genereert de aanroepverwijzing naar de in het artikel gebruikte templates.
; Voorbeeld
{{tbl}}
| rowspan=2|  
! code !! Genereert
|-
| <tt><nowiki>{{TNID SoftwareTmpl|id=voorbeeld}}</nowiki></tt>
| {{TNID SoftwareTmpl|id=voorbeeld}}
|}

== Wat codeer je ==
In de diverse templates worden de navolgende coderegels gehanteerd:
=== Codeer Doel ===
Begin met het introduceren van het {{tl|Infobox Software}}.

Maak vervolgens een of meer alinea's waarin de doelstelling van de software wordt beschreven.

=== Codeer Geinstalleerd op ===
Tabel met hosts of websites, waar de software door ons werd geinstalleerd.

Voorbeeld:
{{tbl}}
! codeer !! Resultaat
|-
|
<nowiki>{{</nowiki>tbl<nowiki>}}</nowiki>
<nowiki>! Host !! Versie !! Per datum</nowiki>
<nowiki>|-</nowiki>
<nowiki>| {{TNID2|LT0530}}</nowiki>{{Note|1}}
<nowiki />| ''versie nr''
<nowiki>| ~~~~~</nowiki>
<nowiki>|-</nowiki>
<nowiki>| {{TNID2|P2415}}</nowiki>
<nowiki />| ''versie nr''
<nowiki>| Onbekend</nowiki>
<nowiki>|}</nowiki>

| 
{{tbl}}
! Host !! Versie !! Per datum
|-
| {{TNID2|LT0530}}

| ''versie nr''
| 22:26, 13 October 2017 (CEST)
|-
| {{TNID2|P2415}}
| ''versie nr''
| Onbekend
|}
|}
; Noot
# Vanaf 17 januari 2019 is er hettemplate {{tl|TNID Installed On}}
#: <code><nowiki>{{TNID Installed On|id=KeePass|host=DT02}}</nowiki></code>
#: Gebrik dat om een host te benoemen.

=== Codeer Versies ===
Een tabel met de 1e 2 niveauss van de versie nummers, gevolgd door de detail becscchrijvingen van de functionele onderewerpen per changelog.

=== Codeer Meer ===
* Verwijzing naar de website van het product.
* Gedetaileerde beschrijving van het gebruik van de software.

=== Codeer Zie ook ===
Verwijzingen naar gerelateerde artikelen.

Itemgewijs opstellen, bij grote aantallen eventueel een tabel maken.
=== en afsluiten met ===

: {{tl|Referenties}} (indien gemaakt)
: {{tlx|TNIDcat|Software|''productenaam''}}

== Software op host ==
Een verbijzonderde vorm van software documentatie is het op uniforme wijze vastleggen van de gevolgen van de installatie van software op een host of website.
Daarbij valt te denken aan
# een apart template dat dient te worden gebruikt
## binnen de software documentatie
##:en
## binnen de host c.q. wesite documentatie
# de inhoud van zo'n (sub-)artikel.

=== X_SWHW ===
{{tl|X_SWHW|X_SWHW }} staat voor Cross Reference Soft- en hardware ...
{{tbl}}
! Code !! Resultaat
|-
| <code><nowiki>{{X_SWHW|sid=Thunderbird|hid=LT0530}}</nowiki></code>
| {{X_SWHW|sid=Thunderbird|hid=LT0530}}

|-
| <code><nowiki>{{X_SWHW|sid=phpBB|wid=adjaan.nl}}</nowiki></code>
| {{X_SWHW|sid=phpBB|wid=adjaan.nl}}
|}

== Meerdere benaderingswijzen ==
In principe staan de software artikelen gedefinieerd als subartikel van {{TNID}}.
er doen zich in de wiki sitautties voor waarin dat niet het geval is.
Dan wordt er veelal met een <tt>#REDIRECT</tt> door verwezen naar de beschrijving, zoals bovenbedoeld.

Voorbeeld:
: <nowiki>[[Debian]]</nowiki> wijst deoo naar <nowiki>[[ThuisnetInDetail/Debian]]</nowiki>
Andersom komt ook voor (niet alleen voor software documentatie, maar voor alle {{TNID}} artikelen:

== Zie ook ==
* {{TWID|Documentatie}}
* {{TNID|Host Documentatie}}
*: Daarin wordt verwezen naar {{Tl|TNID HostSoftware}}, wat bedoeld is om de voor een host geisntalleerde software weer te geven.
* {{tl|RecentVersion}}
*: Om een verwijzing naar de (meest recente) versie van een product te definireren of weer te geven...
* {{TNID2|Documentatie#Productbeschrijvingen|Productbeschrijvingen}}

@@ Line 1: / Line 1: @@
 {{TBN}}
-== Intro ==
+== Introductie ==
-Dit artikel beschrijft ..
+Dit artikel beschrijft alles wat met het documenteren van
 Bijzonder aan deze beschrijvingen is, dat er de wens is voor zowel producten beschreven worden, die wel en die niet zijn opgenomen in het {{TNID| | ThuisNet}}.

@@ Line 146: / Line 146: @@
 === en afsluiten met ===
-: {{tl|Referenties}} (indien gemaakt)
+: {{tlx|Referenties}} (indien gemaakt)
-: {{tlx|TNIDcat|Software|''productenaam''}}
+: {{tlx|TNIDcat|Software|''productnaam''}}
 == Software op host ==

@@ Line 132: / Line 132: @@
 === Codeer Versies ===
-Een tabel met de 1e 2 niveauss van de versie nummers, gevolgd door de detail becscchrijvingen van de functionele onderewerpen per changelog.
+Een tabel met de 1e 2 niveaus van de versie nummers, gevolgd door de detail becscchrijvingen van de functionele onderwerpen per changelog.<br>
 === Codeer Meer ===

DezeWikiInDetail/Software Documentatie - Revision history

Beheer: /* Intro */

Beheer: /* en afsluiten met */

Beheer: /* Codeer Versies */

OllieA: Created page with "{{TBN}} == Intro == Dit artikel beschrijft .. Bijzonder aan deze beschrijvingen is, dat er de wens is voor zowel producten beschreven worden, die wel en die niet zijn opgeno..."