From 357c93f14e88c0147da0abe036a6df4389bef95c Mon Sep 17 00:00:00 2001 From: Simon Date: Fri, 9 Nov 2012 14:43:08 +0100 Subject: [PATCH] improve description of settings detail settings in tests/sample/sigal.conf and use this file in the docs. --- docs/_static/logo.xcf | Bin 0 -> 6141 bytes docs/index.rst | 44 +++++++--------------------------------- sigal/settings.py | 2 +- tests/sample/sigal.conf | 37 +++++++++++++++++++-------------- 4 files changed, 30 insertions(+), 53 deletions(-) create mode 100644 docs/_static/logo.xcf diff --git a/docs/_static/logo.xcf b/docs/_static/logo.xcf new file mode 100644 index 0000000000000000000000000000000000000000..6224fe337d571bb06ad0d70c4f6ac8f6ba41f537 GIT binary patch literal 6141 zcmeHLdvH|M89#R)+3aq1H=9ieff$zX3XgRF5upMCqD6%&1JtoCZP#QIRziZwrY1fJ zs6f?82WqvWRY$QZ_^J<_suhJgYQch{f{5}KK|~&!KsI~NJ^lUe?p=b?na*@N{l`1= z%YOO3@0|0U?{&_-HSzfi!p)V{;p%v8OyGGIxS9l>AfRdZ69RH4FBgKqQwTT!JJ2IT zQ?Cg6rTERS!L*V1{Af)qQqvHx0!u)yiHgQVOKmLNSYI2j8tkd4uBoiAt#1fdm_Lz* znroxs;pYxFpR*7nGNQp4dhJ<;TJrF}CpfgZaY3{)URM(yVXXyb%h{M2UZklmo(RY5 zD(A);IljKSx-pi>8pzS#XQer34y7M5k9HT_bS(W(u`|Pb9KSOF`Z8x`ye3*pfsKFg zrb=RLIg%PQ;oM zk=kfWtN|=D%EKzi3zwT4D2I2d>+A6E)OgL@@T~e9Vh!P0kXwRCWBkTg_=1sEY}4u{ zH|@Ly@#a`9{T{7L#G|$GXk)m=j6-d-uBHho7A~)Dh*URl!fT_Au}D?CAy%1)*Vlz> z6AfT~H^;Jp`#!<+xUQ)&5wC6u*T$+7oU*<-GQYkmh6-tpF=@%TAzqc38y+!w^l7Wf zo*Tm+6X7vd{$;ey^vP~xZXEkS_L-ZY&oYmFMTW4l0KT_B12=yR>_1ax--1xRD}?W# zkfBWTF96=5PHTQQXulI(MbVWXe5*9osUO_5>XxZ~5fO6K3(BYTZ8wEPg^>P-R8YyT z%f&z;`|naV)v@QMF+sbl_r;5MD5sKNxP?!2x|beT2XA!=zmNltK}jYYND^I}_N8(t zW0=Sj((}5qE29nCGN1DpbC80v#|CoeK*6{Ts`9W$c!kvN`SgF=HL>Q|l$$Jo;(Xfef z*!u-%GX{zCg|w}wWm|)wjW`|mVW}7;WY1He_4XN>I8PW0l}pK|dWn%3x)HQ)+~N@< z;G`WYSLsLNPSH!GrXPAcSL6#BTCdzn-*>eQJyv?|#ukl%SXnxkD36kx#-c6j+Khd4 z-eA!3N4v=Xa}g}oy_MVOhCyi6(tSJldS}#T`s5xgYYgC&gI=TlOGT#F){q3<^`y)X3uO5wh>QwKiYe(qNkH@zGWQXhvxJf$ zB}J6v!8+-9lHPycfo^C7C@Q4L0e{LuhFKoV>n7?ij74PXfh;qGnCp&Vx$vZM9%Y^W ztgHYV=*runb{C0)v`zAm=M1UQj~Tei&dey_=neL)JV@7g4>Nv0r92F|v50#x4b5k1 ztmN?IP=wu>O!3e&#gkYqdy5fS;{lRu?OAyNb2aZUx!ZfNTFO(*h+*`(Ie!_LMjLI~ zKb)2X-=lm!SM9;2CQ&{Bew9mo=>Kv8YggW8qrz|wd)dJyY>z>u-FV`c6#<*8_oSP* zP*kIFFzZ@>ZLFDJfj3lvlIw@i5^Xk9{NxHJjMW`gpDDl6pBt}XHr=u81e0tRdrPvS z_ThI9bYazGa@VVOUg5zuk9!WO&drauTsd}VS-_s>5W^8-w`kR_6ow|o3nRim4~cQe ziGBEM1X5>qKE)J-O0H;iI7Q0)>!Ina4%|Sz@wk$4$0ebGj6jS@f zQD#X^dxu%uF_F&dyH(|>j*SiH2kpY;E3lakdY^UEUWx$Afk$C>=k}lVv=>Z%M0u4w zhR&dCGBhI_cb=qMisTehIU^AG#Zl&?cqc2WwV3Y=$2T02$n(CK^awqs%R$j zGMHpEK-IX0R=7W>yhS7J@8o2r>OZJDh^k{iCBF{!xoEhC9VTbBtIvLA<6eF3S?$Br z?m_K7pyW|6lThQ{(KxLsO_TDe6rvK!48165+HWptwq0`)vyfx}?LunvIkhQ2Myi72 z`*Zv^d8o-$&zWso*^x{Qrl#=|YFtH)4;(lFQqCXWx1YN;HSQq)NsXSfzeepvOoPFH zJcSUZHHJ_FJBPb2BiU8PbSVD|7U??hz?@;TIf`>h+e*r}_oU~>b&{PxzNb5+e0T(| zZ$^Gv8Nn&|6l7=njYC|XQTJjl`6u=XsolUiJ{-hAao3m`PV4mnDn>3eYyCnhe3B1` z8--~F40A7G%Dp*~rrFHX_fi^cmURG3y+`YARIQ$R^a9pn-Zva+_RNy>98l4&*nrTa zcC<})qV6)Mp4p2_sZ+|mobv{1NAI|;oX3p!2>BDZ&@@o8Etj?qJk9_QW2|gz$zGR3 zhg^P=wY0^>WOTd@epmZLm1FYRMyF%@oqxZ??;bpFGxPgPPbOn?RoDJi^G7;pvg0|P zU8_gbvOn#Ka7uIrpGs|5dLjKHy^mvoOm_O-%S{+(mMvHTwVy9|#h(R!U8R`4&Vu0w#xkIVs)5=f zAe2dM;Ln%8mE@+@nKyuCh+A^_I_NFSWrA{`U>L@^wSDn zT4s^i?gJBvJCU3saz1jVIbm`JQu|h1HK0;J#xhQu>XYUa!$rn8sw@=!M5}vI7R@5n zd-c0HqD&-n5|RgRDeRcKle*0~6!qNbM=;j-1<%gAcogHvDG|mSpyY`>9-G6=6ZMFf zXS`NJ-{QF8Vf3(Q2yjc=vTHLSCN+K$j0&W5pi7TN+V$&9hmSU0Lb|ZaRE`nw$p#56p$W+^1kN_L&*;tFc%B3UdF9nd1t7fccbm`|z*VL@y`jV3jb@yYosWA(a=cQ#+$ zR@VQ<838s~_f8&Mkl5YIozboS4OU^zBnTVx1rJC~e{&pJ=sT zl+~a%vSlEAx zY|jEq&j4P8W&#y_Bf>Kn;2SI++akQA?jeQ8KdGT1{^qKNSY!cSCdtVG_|E%3eaBWx zH3QFMowL1TTkrc22Oq;9JXx#p#U;1_A6>Qrdx5Wk;J?g) zT#Wxe03CiJ%J?{I8PCH&GYLFb0pm<6eL9q7XzR0g(e!BJ^-ZxbzV|i0xwRgwGqnu|MKj{yp4j%rZM+)&TcJhv? literal 0 HcmV?d00001 diff --git a/docs/index.rst b/docs/index.rst index 7ea969c..8703177 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -72,48 +72,16 @@ Optional arguments: ``-d, --debug`` Show all message, including debug messages + Configuration ------------- The configuration for the gallery must be set in ``/sigal.conf``. +An example file with explanations on the settings is available in +``tests/sample/sigal.conf`` and is shown below: -.. code-block:: ini - - [sigal] - - # theme - theme = default - - # size of resized image - img_size = 640x480 - - # generate thumbnails - make_thumbs = 1 - - # directory of the thumbnails - thumb_dir = thumbnail - - # prefix for thumbnails name - thumb_prefix = tn- - - # thumbnail size - thumb_size = 200x150 - - # crop the image to fill the box - thumb_fit = 1 - - # keep big image - big_img = 1 - bigimg_dir = original - - # jpeg quality - jpg_quality = 90 - - # keep exif metadatas in output image - exif = 1 - - # add a copyright text on the image - copyright = An example copyright message +.. literalinclude:: ../tests/sample/sigal.conf + :language: ini Album information @@ -130,12 +98,14 @@ named `index.mkd` :: If this file does not exist the directory's name is used for the title, and the first image of the directory is used as representative. + Credits ------- * galleria: http://galleria.aino.se/ * WordPress Photography Theme: http://thethemefoundry.com/photography/ + Changelog --------- diff --git a/sigal/settings.py b/sigal/settings.py index bf62ef6..3ba10a8 100644 --- a/sigal/settings.py +++ b/sigal/settings.py @@ -30,7 +30,7 @@ _DEFAULT_CONFIG = { 'thumb_prefix': '', 'thumb_suffix': '', 'thumb_size': '150x112', - 'thumb_dir': '', + 'thumb_dir': 'thumbnails', 'thumb_fit': '1', 'keep_orig': '0', 'orig_dir': 'original', diff --git a/tests/sample/sigal.conf b/tests/sample/sigal.conf index c762624..3a6d11a 100644 --- a/tests/sample/sigal.conf +++ b/tests/sample/sigal.conf @@ -1,36 +1,43 @@ [sigal] -# theme -theme = default +# All configuration values have a default; values that are commented out serve +# to show the default. Default values are specified when modified in this +# example config file + +# theme : +# - default, galleria, or the path to a custom theme directory +# theme = default # size of resized image -img_size = 640x480 +# img_size = 640x480 # generate thumbnails -make_thumbs = 1 +# make_thumbs = 1 -# directory of the thumbnails -thumb_dir = thumbnail +# subdirectory of the thumbnails +# thumb_dir = thumbnails -# prefix for thumbnails name -thumb_prefix = +# prefix and/or suffix for thumbnail names (default: '') +# thumb_prefix = thumb_suffix = .tn -# thumbnail size +# thumbnail size (default: 150x112) thumb_size = 200x150 # crop the image to fill the box -thumb_fit = 1 +# thumb_fit = 1 -# keep big image +# keep original image (default: 0) keep_orig = 1 -orig_dir = original + +# subdirectory for original images +# orig_dir = original # jpeg quality -jpg_quality = 90 +# jpg_quality = 90 -# keep exif metadatas in output image +# keep exif metadatas in output image (default: 0) exif = 1 -# add a copyright text on the image +# add a copyright text on the image (default: '') copyright = An example copyright message