De online hulp uitbreiden

De online hulpfunctie van SPIP (beschikbaar vanaf versie SPIP 2.1) kan meerdere informatiebronnen bevatten en die op een uniforme wijze weergeven in een popup venster dat bestaat uit twee frames. Het verschijnt wanneer in het privé gedeelte wordt geklikt op één van de iconen met een vraagteken en is contextgevoelig.

  • Apparu en : SPIP 2.1

Principes

De globale help_server bestaat niet uit een enkele URL, maar is een tabel die meerdere URL’s kan bevatten. Wanneer hulp wordt gezocht in een taal «T», zal SPIP alle pagina’s gaan opzoeken die «T-aide.html» heten in de aangegeven URL’s en de informatie samenvoegen. Standaard bevat de tabel slechts één element http://www.spip.net/aide, de standaard informatiebron, maar andere elementen kunnen worden toegevoegd.

In het bestand mes_options.php [1] verwijst de URL naar dit bestand of deze bestanden.

Voorbeeld

Je wilt een eigen paragraaf toevoegen aan de hulp over het onderwerp «De typografische opmaakcodes».

-  In de map squelettes/ maak je het bestand nl-aide.html [2] met deze structuur:

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="nl" lang="nl" dir="ltr">
<head>
<link rel='stylesheet' href='http://www.spip.net/prive/spip_admin.css' type='text/css' />
</head>
<body>
<h2>raccourcis/De typografische opmaakcodes</h2>
<!-- jouw additionele hulptekst  -->
<h3 class="spip">Aanvullende opmaakcodes</h3>
<p style="color:red;">
Deze aanvullende opmaakcodes zijn beschikbaar.
</p>
<p style="color:navy;">
En deze opmaakcodes hebben een afwijkend gedrag.
</p>
<!-- einde van de aanvullende hulp -->
</body>
</html>

-  In het bestand mes_options.php, declareer je de URL die naar de map met het bestand verwijst:

// URL naar aanvullende online hulp
$GLOBALS['help_server'][] = url_de_base(1) . 'squelettes/';

Let op: vanaf SPIP3 volstaat de schrijfwijze:

$GLOBALS['help_server'][] = url_de_base() . (test_espace_prive()? '../' : '') . 'squelettes/';

-  vanaf nu zal bij een klik op «De typografische opmaakcodes» in het linker menu van het hulpvenster de standaard hulptekst van spip.net worden aangevuld (onderaan) met de persoonlijke tekst [3].

De standaard toegangspunten voor de online hulp

Om een bestaande uitleg aan te vullen moet je gebruik maken van de bestaande <h2>sleutel/menu titel</h2> waardes die beschikbaar zijn op spip.net.

Dit is de lijst:

Installatie van SPIP

  • install0/Toegangsrechten instellen
  • install1/Je SQL verbinding
  • install2/Keuze van database
  • install5/Persoonlijke gegevens
  • ftp_auth/Verificatie via FTP
  • erreur_mysql/Een probleem met een skelet?

De artikelen

  • raccourcis/De typografische opmaakcodes
  • arttitre/Titel, boventitel, ondertitel
  • artrub/De rubriek kiezen
  • artdesc/Korte omschrijving
  • artchap/Introductie
  • artvirt/Doorverwijzing
  • arttexte/Tekst
  • artdate/Datum
  • artdate_redac/Vorige redactiedatum
  • artauteurs/De auteurs
  • logoart/Logo van het artikel
  • artstatut/De status van een artikel
  • artprop/Een artikel voorstellen

De rubrieken

  • rubhier/Een hiërarchische structuur
  • rubrub/De rubriek kiezen
  • rublogo/Logo van de rubriek

Les brèves

  • breves/Nieuwsberichten
  • brevesrub/De rubriek kiezen
  • breveslien/De hyperlink
  • brevesstatut/De status van een nieuwsbericht
  • breveslogo/Het logo van een nieuwsbericht

Afbeeldingen en documenten

  • ins_img/Afbeeldingen invoegen
  • ins_doc/Documenten bijvoegen
  • ins_upload/Bestanden via FTP of SSH uploaden

De trefwoorden

  • mots/Principe van trefwoorden
  • artmots/De trefwoorden
  • motsgroupes/Trefwoordgroepen

Gerefereerde sites

  • reference/Aan een site refereren
  • rubsyn/Gesyndiceerde sites
  • artsyn/Gesyndiceerde artikelen
  • confhttpproxy/Een proxy gebruiken

Intern berichtensysteem

  • messut/Berichten tussen gebruikers
  • messpense/Geheugensteuntjes
  • messcalen/De kalender
  • messconf/Persoonlijk configuratie van het interne berichtensysteem

Forums opvolgen

  • suiviforum/Forums opvolgen

Configuratie van de site

  • confnom/Naam en adres van de site
  • confart/Inhoud van artikelen
  • confdates/Artikelen postdateren
  • confforums/Functioneren van de forums
  • confbreves/Systeem van nieuwsberichten
  • confmessagerie/Intern berichtensysteem
  • confstat/Bezoekersstatistieken
  • confmails/Automatisch verzenden van emails
  • confmoteur/Geïntegreerde zoekmachine [4]

Configuratie van de persoonlijke interface

  • intersimple/Eenvoudige of uitgebreide interface [4]
  • cookie/Beheerscookie
  • deconnect/Afmelden

Geavanceerde toepassing

  • artmodif/Artikelen in bewerking
  • suivimodif/Revisies opvolgen
  • corrortho/Ortografische correctie [4]
  • previsu/Vooruitblik
  • latex/Wiskundige formules
  • confurl/Type van URL-adressen

SPIP, vrije software

  • licence/Licentie en gebruiksvoorwaarden

Een extra blok aan het linker menu toevoegen

Mogelijk wil je een extra blok aan het linkse verticale menu toevoegen. Daarvoor volstaat een element <h1> </h1> in je bestand T-aide.html:

<body>
<h1>Extra informatie</h1>
<h2>blok_perso/Hulp op dit onderdeel</h2>
<h3 class="spip">Dit onderdeel gebruiken</h3>
<p>
Een paragraaf.
</p>
<p>
Nog een paragraaf.
</p>
<h2>ander_blok_perso/Andere extra informatie</h2>
<h3 class="spip">Gebruik van een ander onderdeel</h3>
<p>
Een paragraaf.
</p>
</body>
 

Opslaan en organiseren van je hulpbestanden

Wil je jouw persoonlijke hulpbestanden in een specifieke submap plaatsen (bijvoorbeeld «mijn_hulp/»), dan moet je dat in het bestand «mes_options.php» aangeven:

$GLOBALS['help_server'][] = url_de_base(1) . 'squelettes/mijn_hulp/';

of vanaf SPIP3:

$GLOBALS['help_server'][] = url_de_base() . (test_espace_prive()? '../' : '') . 'squelettes/mijn_hulp/';
  
  
  
  

Lees ook over het baken #AIDER in.

Voetnoot

[1In het kader van een plugin (bijvoorbeeld «mijnplugin») declareer je deze URL in het bestand mijnplugin_options.php: $GLOBALS['help_server'][] = url_de_base(1) . str_replace("../", "", _DIR_PLUGIN_MIJNPLUGIN); of wanneer je de hulpbestanden in een bepaalde submap hebt opgeslagenen: $GLOBALS['help_server'][] = url_de_base(1) . str_replace("../", "", _DIR_PLUGIN_MIJNPLUGIN) . "hulp/";

[2Bij een meertalige site maak je per gebruikte taal een bestand: en-aide.html, fr-aide.html, es-aide.html, ...

[3Le erop dat je waarschijnlijk eerst de cache van SPIP moet leeg maken (om de map tmp/cache/aide/ te verwijderen)

[4niet meer beschikbaar sinds SPIP 2.0

Auteur Hanjo Gepubliceerd op:

Vertalingen: عربي, català, English, français, Nederlands, українська