Rst2HTML restuctured text source

Laden

Onder de knoppen voor het laden en opslaan van de site instellingen zit een rij knoppen om met de ReST sources te werken. Naast de document selector zit om te beginnen de knop om een tekst te laden:

Deze knop kan verschillende dingen doen afhankelijk van de keuze die je maakt in de erop volgende selector:

Om te beginnen natuurlijk het laden van een source, maar het is ook mogelijk om de status van een document op te vragen. Dit veroorzaakt een melding op het scherm:

Ook is het mogelijk om te kijken wat de laatste wijziging in het document is geweest. Dit wordt getoond in een zogeheten "diff view" (oude stand voorafgegaan door een min teken, nieuwe stand voorafgegaan door een plus teken, met wat regels eromheen voor de context):

Wanneer je een source laadt wordt ook de target selector bijgewerkt; een bijkomstigheid daarvan is dat je daardoor kunt zien of de tekst nog niet eerder naar HTML is omgezet omdat deze dan geen waarde krijgt.

Voor het gelijkvormig houden van de documenten op de site kan de template functionaliteit gebruikt worden.

Opslaan

Vervolgens hebben we de knop voor het opslaan:

Ook deze heeft verschillende mogelijkheden afhankelijk van de keuze in de erop volgende selector:

Deze keuzes maken het mogelijk om achtereenvolgens

  • just save: de aangegeven tekst op te slaan met de reeds bekende naam zoals weergegeven in de source selector; als een andere naam is opgegeven in het "new name" veld dan wordt deze gebruikt - op deze manier is het mogelijk om een document onder een andere naam op te slaan, bijvoorbeeld als een deel van de inhoud van de kopie moet worden aangepast zoals bij het werken met templates beschreven,

  • rename: de naam waaronder het aangegeven document is opgeslagen te wijzigen (die dan moet worden opgegeven in het "new name" veld aan het eind van de regel),

  • revert: de tekst terug te zetten naar de eerder opgeslagen waarde (dit kan maar één keer en het is dan niet meer mogelijk om verschillen met de vorige versie op te vragen),

  • delete: het aangegeven document te verwijderen. Als het document al eens is overgezet naar de target en eventueel de mirror omgeving moet de verwijdering naar die omgeving worden doorgegeven, dat kan met de "pending deletions" functie zoals beschreven in het target document.

Je kunt de save-functie gebruiken om de site waar je mee bezig bent onder te verdelen door een source naam te gebruiken die eindigt met een slash, dit werkt net als het aanmaken van een subdirectory.

new-directory.png

Door deze vervolgens te selecteren in de source selector

selecting-directory.png

en load source te gebruiken kun je zorgen dat de documenten die je daarna maakt in deze sectie terecht komen.

switching-to-subdir.png

Je kunt terug naar de hoofdsectie door de .. entry te selecteren om naar toe te gaan.

selecting-parent.png switching-to-parent.png

Bekijken en overzetten

De volgende functie maakt het mogelijk om de ReST source te bekijken zoals het omgezet wordt naar HTML:

Bij het omzetten wordt een button gegenereerd waarmee je de preview kunt afsluiten. Eerder kon dat alleen met de "terug" functie van de browser maar omdat dat niet garandeert dat vooraf gedane wijzigingen dan bewaard blijven is deze oplossing toegevoegd (onder de motorkap wordt het document opgeslagen vóór het omzetten en weer geladen bij sluiten van de preview).

Tenslotte is er dan de knop om de omzetting vast te leggen door de gegenereerde HTML te kopiëren naar de target omgeving:

Resultaatmelding

Wanneer je een source geladen hebt wordt een melding getoond met daarin het pad van de source relatief ten opzichte van de server root (na sluiten van de preview krijg je deze ook). Hetzelfde gebeurt bij het opslaan. Andere acties geven ook een melding, zo kun je altijd zien waar je net mee bezig geweest bent (en of het gelukt is).