Teksten invoeren in administrativia

Teksten in administrivia worden gewoon op het filesystem ingevoerd met de favoriete $EDITOR van de gebruiker. Unix en DOS line-endings worden geaccepteerd.

De eerste regels van een .help bestand bevatten meta-informatie, met de volgende tags:

title: 
keywords: 
rcsid: 

Bij rcsid gewoon \$Id\$ invoeren zodat hier het rcsid terecht komt als de file in RCS gezet is.

Geef voor het wijzigen van een bestaande file het commando:

co -l teksteninvoeren.help 

Dit zal de file schrijfbaar maken voor de huidige gebruiker en een checkout doen uit rcs.

Bij 'keywords' een of meerdere relevante keywords invoeren, gescheiden door komma's. Bestanden worden aan elkaar gelinkt ('see also') met behulp van deze keywords.
Voorbeeld:

keywords: een, twee

De 'title' is de titel voor de gegenereerde pagina's. Eventueel kunnen later nog andere meta-tags door het page-script of door andere scripts herkend worden.

Sla na deze tags een lege regel over, tik daarna het html-deel in. Het administrivia page-script zal koppen, voeten en navigatie er om heen zetten, dus er is maar minimale html nodig, eigenlijk alleen de content.

In de html kunnen headings <h2> tot <h6> gebruikt worden. Deze headings worden automatisch in een pagina-navigatie menu verwerkt.

Er zijn in de stylesheets speciale link-classes gedefinieerd voor links vanuit het systeem naar pagina's buiten de helpdesk site:

<a href="[..]" class="externallink"> link naar bron op andere site
<a href="[..]" class="restrictedlink"> link naar pagina die alleen van binnen ons netwerk te bekijken is.

Images kunnen het best geplaatst worden in de images subdir van de helpdesk-root. Voor screendumps is een css-class aangemaakt om ze van een apart kader te voorzien: <img src="/images/[..]" class="screendump">

Geef nadat je je wijzigingen klaar hebt het commando:

ci -u teksteninvoeren.help

zodat het bestand leesbaar voor de webserver blijft staan maar andere leden van de groep aan het bestand kunnen werken.

Als extra header kan toegevoegd worden:

expired: yes

Deze header is voor paginas die verlopen zijn, zodat externe links ernaar nog wel zullen werken maar de pagina niet meer in overzichten staat.

Related pages

Administrivia

---