idocumentation update - cl-yag - Common Lisp Yet Another website Generator Err bitreich.org 70 hgit clone git://bitreich.org/cl-yag/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/cl-yag/ URL:git://bitreich.org/cl-yag/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/cl-yag/ bitreich.org 70 1Log /scm/cl-yag/log.gph bitreich.org 70 1Files /scm/cl-yag/files.gph bitreich.org 70 1Refs /scm/cl-yag/refs.gph bitreich.org 70 1Tags /scm/cl-yag/tag bitreich.org 70 1README /scm/cl-yag/file/README.md.gph bitreich.org 70 1LICENSE /scm/cl-yag/file/LICENSE.gph bitreich.org 70 i--- Err bitreich.org 70 1commit 0ff2a8a9d8d2d38a0998c17ce1a1098809051150 /scm/cl-yag/commit/0ff2a8a9d8d2d38a0998c17ce1a1098809051150.gph bitreich.org 70 1parent b6217bd19691e99255d6ea2ae57c14c6d48b073a /scm/cl-yag/commit/b6217bd19691e99255d6ea2ae57c14c6d48b073a.gph bitreich.org 70 hAuthor: Solene Rapenne URL:mailto:solene@dataswamp.org bitreich.org 70 iDate: Tue, 3 May 2016 14:10:43 +0200 Err bitreich.org 70 i Err bitreich.org 70 idocumentation update Err bitreich.org 70 i Err bitreich.org 70 iDiffstat: Err bitreich.org 70 i M README.md | 9 +++++---- Err bitreich.org 70 i Err bitreich.org 70 i1 file changed, 5 insertions(+), 4 deletions(-) Err bitreich.org 70 i--- Err bitreich.org 70 1diff --git a/README.md b/README.md /scm/cl-yag/file/README.md.gph bitreich.org 70 i@@ -23,20 +23,21 @@ Here are the files and folder of cl-yag : Err bitreich.org 70 i Err bitreich.org 70 i Edit data/articles.lisp and add a new line inside the *articles* variable like this Err bitreich.org 70 i Err bitreich.org 70 i- (list :id "2" :date "29 April 2016" :title "How do I use cl-yag" :author "Solène" :short "I will explain how to use the generator") Err bitreich.org 70 i- Err bitreich.org 70 i+ (list :id "2" :date "29 April 2016" :title "How do I use cl-yag" :author "Solène" :short "I will explain how to use the generator" :tag "example help code") Err bitreich.org 70 i Err bitreich.org 70 i The _:short_ field is used on the homepage. It it is defined, this is the text that will be shown on the homepage with all the others articles. If it's not defined, the whole article content will be used on the homepage. Sometimes when you have long articles, you may not want to display it entirely on the index so you can use _:short "view the article for the full text_. Err bitreich.org 70 i Err bitreich.org 70 i The _:author_ field is used to display who wrote the article. You can omitt it, the generator will take the name from the *config* variable Err bitreich.org 70 i Err bitreich.org 70 i+The _:tag_ field is used to create a page with all the articles with the same tag. You can omitt it if you don't want it tagged. Tags can't contain spaces. Err bitreich.org 70 i+ Err bitreich.org 70 i # How to hack it Err bitreich.org 70 i Err bitreich.org 70 i I tried to make it "hacking friendly" so it's very extensible. Err bitreich.org 70 i Err bitreich.org 70 i-## Include a template page in the layout Err bitreich.org 70 i+## Include some file in the template Err bitreich.org 70 i Err bitreich.org 70 i-Here is an example code if you want to add something like a panel on the layout. Err bitreich.org 70 i+Here is an example code if you want to include a page in the template Err bitreich.org 70 i Err bitreich.org 70 i + Add a string for the replacement to occure, like %%Panel%% in **template/layout.tpl** (because we want the panel on every page) Err bitreich.org 70 i + In **generator.lisp** modify the function *generate-layout* to add "**(template "%%Panel%%" (load-file "template/panel.tpl"))**" after one template function call Err bitreich.org 70 .