Update README
This commit is contained in:
parent
cce5818f92
commit
c86085edb8
35
README.md
35
README.md
|
@ -32,6 +32,41 @@ Una lista di tutti gli audiolibri di Ad Alta Voce può essere recuperata al segu
|
|||
loud all
|
||||
```
|
||||
|
||||
### Generazione indice
|
||||
|
||||
Attraverso il comando `all` è possibile generare anche un indice di tutti gli audiolibri generati attraverso il comando:
|
||||
|
||||
```bash
|
||||
loud all --index
|
||||
```
|
||||
|
||||
Inoltre attraverso il flag `--index-template` è possibile specificare il template [mustache](https://mustache.github.io/mustache.5.html) dell'indice.
|
||||
Il file del template deve trovarsi nella working directory ed avere un del tipo `<nome>.<estenzione>.mustache`.
|
||||
|
||||
I parametri del template sono:
|
||||
|
||||
- `entries`: lista dei feed podcast degli audiolibri
|
||||
- `audiobook-file`: nome del file xml
|
||||
- `audiobook-author`: autore dell'audiolibro
|
||||
- `audiobook-title`: titolo dell'audiolibro
|
||||
|
||||
Di seguito è riportato un esempio di template html per l'indice.
|
||||
|
||||
```html
|
||||
<html>
|
||||
<head>
|
||||
<title>Ad alta voce - Podcast non ufficiale</title>
|
||||
<meta charset="utf-8" />
|
||||
</head>
|
||||
<h1>Lista audiobook</h1>
|
||||
<ul>
|
||||
{{#entries}}
|
||||
<li><a href='{{audiobook-file}}'>{{audiobook-title}}</a> {{audiobook-author}}</li>
|
||||
{{/entries}}
|
||||
</ul>
|
||||
</html>
|
||||
```
|
||||
|
||||
### Help page
|
||||
|
||||
È possibile visualizzare le opzioni aggiuntive attraverso la *help page* richiamabile attraverso il seguente comando:
|
||||
|
|
|
@ -5,7 +5,7 @@ cabal-version: 1.12
|
|||
-- see: https://github.com/sol/hpack
|
||||
|
||||
name: ad-alta-voce
|
||||
version: 0.0.0.1
|
||||
version: 0.0.0.2
|
||||
description: Script per la generazione dei Feed Podcast di Ad Alta Voce
|
||||
homepage: https://github.com/norangebit/ad-alta-voce#readme
|
||||
bug-reports: https://github.com/norangebit/ad-alta-voce/issues
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
name: ad-alta-voce
|
||||
version: 0.0.0.1
|
||||
version: 0.0.0.2
|
||||
github: "norangebit/ad-alta-voce"
|
||||
license: GPL-3
|
||||
author: "Raffaele Mignone"
|
||||
|
|
Loading…
Reference in New Issue