kroniek - Online in de cloud

PROGRAMMA:

NAAM

kroniek - Een eenvoudige blogcompiler.

KORTE INHOUD

kroniek [opties]

Pad opties:

--comments Specificeer het pad naar de optionele directory met opmerkingen.
--config Specificeer een configuratiebestand om te lezen.
--input Geef de te gebruiken invoermap op.
--output Geef de map op waarnaar de uitvoer moet worden geschreven.
--theme-dir Specificeer het pad naar de themasjablonen.
--theme Specificeer het te gebruiken thema.
--pattern Specificeer het patroon van bestanden om mee te werken.
--url-prefix Specificeer het voorvoegsel voor het liveblog.
--sitemap-prefix Specificeer het voorvoegsel voor de sitemap.

Opties voor bloginvoer:

--format Specificeer het formaat van uw ingangen, HTML/textiel/markdown.

Commando's voor en na het bouwen:

--pre-build Geef een opdracht op die moet worden uitgevoerd voordat de blog wordt gebouwd.
--post-build Geef een opdracht op die moet worden uitgevoerd zodra de blog is gebouwd.
--pre-filter Een opdracht om elk blogbericht te filteren vóór HTML-conversie.
--post-filter Een opdracht om elk blogbericht na HTML-conversie te filteren.

Sorteeropties:

--recent-dates-first Toon recente items eerst in de archiefweergave.
--recent-tags-first Toon recente items eerst in de tagweergave.

Opties tellen:

--entry-count=N Aantal posts om te tonen op de index.
--rss-count=N Aantal berichten dat moet worden opgenomen in de RSS-indexfeed.

Optionele functies:

--author Geef het e-mailadres van de auteur op
--comment-days Specificeer de maximale leeftijd van posts om reacties te accepteren.
--date-archive-path Voeg de datum toe aan het archief.
--force Forceer het kopiëren van statische bestanden van het blogthema.
--lang Geef de taal op die moet worden gebruikt voor het opmaken van datums.
--lower-case Kleine letters voor alle bestandsnamen die worden uitgevoerd.
--no-archive Maak geen archiefpagina aan.
--no-cache Gebruik de optionele memcached-functies niet, zelfs niet als deze beschikbaar zijn.
--no-calendar Gebruik de optionele kalender niet bij de index.
--no-comments Het plaatsen van reacties is niet toegestaan.
--no-sitemap Genereer geen sitemap.
--no-tags Produceer geen tag-pagina's.
--no-xrefs Produceer geen kruisverwijzingen.

Hulpopties:

--help Toon de help-informatie voor dit script.
--manual Lees de handleiding voor dit script.
--verbose Toon nuttige foutopsporingsinformatie.
--version Toon het versienummer en sluit af.

OVER ONS

Chronicle is een eenvoudig hulpmiddel om een ​​verzameling tekstbestanden te converteren,
binnen een enkele map, in een blog bestaande uit statisch
HTML-bestanden.

Het ondersteunt alleen het absolute minimum aan functies die nodig zijn
nuttig zijn:

* Tagging-ondersteuning.

* RSS-ondersteuning.

* Archiefondersteuning.

De voor de hand liggende tekortkomingen zijn:

* Gebrek aan ondersteuning voor direct commentaar.

* Gebrek aan ondersteuning voor pingback/trackback.

Dat gezegd hebbende, het is een robuust, stabiel en nuttig systeem.

BLOG FORMAT

Het formaat van de tekstbestanden die we verwerken, is cruciaal voor de uitvoer
Pagina's. Elk item zou er ongeveer zo uit moeten zien:

Titel: Dit is de titel van de blogpost
Datum: 2 maart 2007
Tags: een, twee, drie, lange tag

De tekst van uw invoer komt hier.

OPMERKING: de koptekst MOET ten minste a. van de hoofdtekst van het item worden gescheiden
enkele lege regel.

In dit voorbeeld kunnen we zien dat het item zelf is voorafgegaan
met een kleine kop. Een invoerkop bevat drie optionele regels,
als deze niet aanwezig zijn, zijn er redelijke gebreken zoals beschreven
hieronder.

De opmaak van de uitvoerdatums kan worden gewijzigd via het gebruik van de
B<--taal> opdrachtregeloptie (of de overeenkomende "taal=frans"-optie in de
configuratiebestand), maar de datum van het item zelf moet worden opgegeven in
Engels.

Titel: Beschrijft de titel van het bericht. Indien niet aanwezig wordt de bestandsnaam van het item gebruikt
in plaats van. "Onderwerp:" kan ook worden gebruikt.
Onderwerp: Dit is een synoniem voor 'Titel:'.
Datum: de datum waarop het bericht is geschreven. Indien niet aanwezig wordt de aanmaaktijd van het bestand gebruikt
gebruiken.
Publiceren: Deze header wordt verwijderd uit alle items en wordt gebruikt door de Chronicle-spooler
scripts.
Tags: alle tags die aan het item moeten worden gekoppeld, gescheiden door komma's.

Het formaat van het item wordt verondersteld HTML te zijn, maar er is ondersteuning
voor het schrijven van uw vermeldingen in zowel textiel- als prijsverlagingsformaten.

Het formaat van ingangen wordt gespecificeerd via het B<--formaat> argument, of
via een "format: foo" instelling in uw chroniqueurbestand.

Aangenomen wordt dat het formaat van de vermeldingen globaal is; dat zijn al uw inzendingen
wordt verondersteld hetzelfde formaat te hebben. U kunt echter een toevoegen
"format: foo" pseudo-header naar specifieke vermeldingen als u wilt schrijven
specifieke vermeldingen in een ander formaat.

Om flexibiliteit bij het verwerken van inzendingen mogelijk te maken, zal elk blogbericht dat doen
worden doorgegeven via het filterscript B
waarmee u deze afhandeling op één locatie kunt wijzigen. Dit
Met het script kunnen vermeldingen zowel ervoor als erna worden bijgewerkt via filters
de conversie naar HTML. Zie voor meer details de man-pagina voor
dat schrift.

CONFIGURATIE

De configuratie van de software is minimaal en wordt over het algemeen uitgevoerd
via de opdrachtregelargumenten. Het is echter mogelijk om instellingen op te slaan
ofwel in het bestand global /etc/chroniclerc ofwel per gebruiker ~/.kroniek
bestand.

Als u wilt, kunt u de naam van een ander configuratiebestand doorgeven aan
het script met de vlag B<--config>. Dit wordt gelezen na de
vorige twee bestanden, en kan alle aanwezige instellingen overschrijven.

Het configuratiebestand bevat regels zoals deze:

invoer = /home/me/blog

uitvoer = /var/www/blog

formaat = korting

Sleutels die onbekend zijn, worden genegeerd.

OPTIONELE CACHEN

Om het opnieuw opbouwen van een grote blog te versnellen, kan de compiler een local
Memcached-daemon, indien geïnstalleerd en beschikbaar.

Om dit te installeren, voert u onder een Debian GNU/Linux-systeem het volgende uit:

apt-get update
apt-get installeer memcached liccache-memcached-perl

U kunt dit caching-gedrag uitschakelen met --no-cache, en zie de
effect met --verbose.

OPTIONELE KALENDER

Als de 'HTML::CalendarMonthSimple'-module beschikbaar is, zal elke blog dat doen
bevatten een eenvoudig maandoverzicht van de huidige maand op de index.

Om dit uit te schakelen roep je het programma aan met '--no-calendar'.

OPTIONELE COMMENTAAR

Inbegrepen bij de kroniekcode zou u het bestand moeten vinden
cgi-bin/opmerkingen.cgi.

Dit bestand is ontworpen om ingediende opmerkingen naar de local te schrijven
bestandssysteem van uw webserver. Als u dat installeert en het
pad aan het begin van het script dat u zou moeten kunnen opnemen
reacties op je blog.

In het kort zijn er drie dingen die je moet doen:

Installeer het CGI-script en bewerk het pad aan het begin.
Kopieer de uitvoercommentaar naar uw lokale blogbron.
Voer dit script opnieuw uit met --comments=./path/to/comments

Dit zou de opmerkingen in de statische uitvoer moeten bevatten. Meer
expliciete instructies worden gegeven in het bestand 'COMMENTS'
opgenomen in de distributie.

Gebruik Chronicle online met behulp van onworks.net-services