mirror of
https://github.com/lise-henry/crowbook
synced 2024-05-21 15:26:09 +02:00
3310 lines
1004 KiB
HTML
3310 lines
1004 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="generator" content="crowbook">
|
||
<meta name="viewport" content="width=device-width">
|
||
<meta name="author" content="Élisabeth Henry">
|
||
<link rel = "icon" href = "data:image/svg+xml;base64,<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
   xmlns:dc="http://purl.org/dc/elements/1.1/"
   xmlns:cc="http://creativecommons.org/ns#"
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:svg="http://www.w3.org/2000/svg"
   xmlns="http://www.w3.org/2000/svg"
   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
   xml:space="preserve"
   style="enable-background:new 0 0 144 144;"
   viewBox="19 19 106 106"
   height="144px"
   width="144px"
   y="0px"
   x="0px"
   id="Layer_1"
   version="1.1"
   inkscape:version="0.91 r13725"
   sodipodi:docname="crowbook.svg"><metadata
     id="metadata8"><rdf:RDF><cc:Work
         rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
           rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title /></cc:Work></rdf:RDF></metadata><defs
     id="defs6" /><sodipodi:namedview
     pagecolor="#ffffff"
     bordercolor="#666666"
     borderopacity="1"
     objecttolerance="10"
     gridtolerance="10"
     guidetolerance="10"
     inkscape:pageopacity="0"
     inkscape:pageshadow="2"
     inkscape:window-width="1366"
     inkscape:window-height="704"
     id="namedview4"
     showgrid="false"
     inkscape:zoom="3.2777778"
     inkscape:cx="68.481852"
     inkscape:cy="81.512552"
     inkscape:window-x="0"
     inkscape:window-y="27"
     inkscape:window-maximized="1"
     inkscape:current-layer="Layer_1" /><path
     inkscape:connector-curvature="0"
     id="path2384"
     d="m 79.57926,106.06495 c -0.430709,-0.43646 -0.810507,-0.71652 -1.786515,-1.31741 -0.970824,-0.59766 -1.297999,-0.88302 -1.515789,-1.32202 -0.0847,-0.17073 -0.116014,-0.31542 -0.139914,-0.64654 -0.024,-0.33231 -0.01148,-1.18663 0.02128,-1.45349 0.03693,-0.30088 0.09558,-0.60762 0.163548,-0.85545 0.186265,-0.678989 0.419343,-1.121389 1.08594,-2.061229 0.512803,-0.72297 0.729565,-1.17918 0.833363,-1.753871 0.08055,-0.44601 0.114859,-1.37464 0.06811,-1.84387 -0.09828,-0.98644 -0.410101,-1.67646 -0.851745,-1.88472 -0.114035,-0.0538 -0.1461,-0.0598 -0.329802,-0.0624 -0.397924,-0.005 -0.598305,-0.09 -2.936016,-1.2383 -2.044084,-1.00406 -2.440792,-1.19064 -3.439841,-1.61763 -1.180638,-0.50461 -2.153253,-0.83288 -2.925986,-0.98758 -0.622067,-0.12455 -1.015475,-0.13551 -1.551581,-0.0432 -1.825603,0.31435 -3.513623,1.0265 -4.477809,1.88902 -0.377055,0.33735 -0.450884,0.45251 -1.375171,2.14525 -0.767051,1.40474 -1.198404,2.16985 -1.584245,2.80995 -0.574143,0.9526 -0.99678,1.537351 -1.216241,1.682721 -0.15784,0.10455 -0.23215,0.0725 -0.293722,-0.12672 -0.05069,-0.16401 -0.046,-1.189901 0.0098,-2.137401 0.06878,-1.16839 0.0871,-1.78501 0.07573,-2.54848 -0.02134,-1.43186 -0.142999,-2.19258 -0.49279,-3.08143 -0.311916,-0.7926 -0.609363,-1.37247 -1.088471,-2.12207 -0.376028,-0.58835 -0.4628,-0.81168 -0.441191,-1.13582 0.02711,-0.40705 0.229844,-0.7155 1.384723,-2.10684 0.86242,-1.03897 1.229135,-1.5356 1.413329,-1.91388 0.151893,-0.31196 0.180838,-0.53928 0.08568,-0.67292 -0.148465,-0.2085 -1.572211,-0.98296 -4.334064,-2.35763 -4.547054,-2.26316 -8.76531,-4.17718 -9.205617,-4.17718 -0.03215,0 -0.210953,0.0354 -0.39735,0.0787 -0.563208,0.13084 -2.013401,0.44451 -2.055094,0.44451 -0.02144,0 -0.193501,-0.086 -0.382331,-0.19117 -1.756452,-0.9781 -3.07451,-1.52204 -3.487355,-1.43916 -0.05624,0.0113 -0.113873,0.0161 -0.128075,0.0106 -0.106678,-0.0409 -0.195382,-0.59852 -0.244866,-1.53921 -0.03551,-0.67478 -0.05943,-2.37517 -0.07894,-5.61033 -0.02183,-3.62155 -0.03866,-4.31878 -0.125858,-5.21635 -0.05475,-0.56356 -0.09124,-0.71814 -0.233572,-0.98954 -0.12039,-0.22956 -0.132226,-0.30907 -0.05719,-0.3841 0.197053,-0.19706 1.187493,0.24929 1.415002,0.63766 0.05404,0.0923 0.08117,0.23369 0.223597,1.16555 0.476219,3.11605 0.871873,4.59576 1.286035,4.80995 0.05365,0.0278 0.06365,0.0274 0.121782,-0.004 0.202032,-0.10881 0.588016,-0.81467 1.102009,-2.01529 1.102009,-2.57403 2.553254,-6.86201 2.820447,-8.33337 0.02131,-0.11723 0.04421,-0.3073 0.05092,-0.42237 0.0067,-0.11504 0.01898,-0.20225 0.02722,-0.19379 0.0083,0.008 0.08163,0.41221 0.163038,0.89717 0.234681,1.39814 0.404347,2.18315 0.602413,2.78702 0.106282,0.32409 0.284982,0.69372 0.404635,0.83689 0.104142,0.12466 0.115793,0.15963 0.102403,0.30728 -0.01252,0.13815 -0.08142,0.29076 -0.286247,0.63398 -0.334982,0.56135 -0.471565,0.85655 -0.588782,1.27252 -0.08206,0.29122 -0.176507,0.54628 -0.445942,1.20424 -0.290688,0.70988 -0.355395,0.93615 -0.294318,1.02934 0.0449,0.0685 0.123961,0.0632 0.280159,-0.019 0.213775,-0.11245 0.461441,-0.31251 0.779302,-0.62949 0.609886,-0.60822 1.176913,-1.30056 2.595518,-3.16907 0.8437,-1.1113 1.184603,-1.5213 1.264833,-1.5213 0.01853,0 0.03435,0.0262 0.04269,0.0706 0.01019,0.0543 0.05713,0.11633 0.203291,0.26846 0.212257,0.22096 0.291429,0.35798 0.344389,0.59618 0.03913,0.17593 0.0433,0.66624 0.0079,0.9252 -0.130994,0.9575 -0.530876,2.20755 -1.286609,4.02222 -0.32789,0.7873 -0.419271,1.08178 -0.396992,1.27942 0.04207,0.37321 0.484672,0.19175 1.63267,-0.66932 0.223837,-0.16789 0.677055,-0.51235 1.007166,-0.76548 1.714905,-1.31497 2.697,-1.93431 3.51792,-2.21868 0.366334,-0.12686 0.448903,-0.13628 1.385654,-0.15809 0.948356,-0.0221 1.217483,-0.0188 1.251532,0.0153 0.05641,0.0565 -0.0097,0.13726 -0.599763,0.733 -0.754659,0.7619 -1.412851,1.46407 -1.680617,1.79301 -0.255445,0.3138 -0.355684,0.49547 -0.356352,0.64592 -3.57e-4,0.0794 0.0085,0.10227 0.05679,0.14742 0.093,0.0869 0.204671,0.10772 0.562944,0.10514 0.762777,-0.005 2.164883,-0.31094 5.05995,-1.1023 1.070801,-0.29269 1.562945,-0.40139 1.833529,-0.40492 0.180932,-0.002 0.234103,0.0249 0.208742,0.10717 -0.0078,0.0252 -0.216765,0.24635 -0.464448,0.4915 -0.486318,0.48136 -0.552555,0.57016 -0.552555,0.74101 0,0.22328 0.289447,0.51681 0.794653,0.80587 0.740833,0.42388 1.678324,0.67594 2.519348,0.67729 0.407237,6.5e-4 0.608027,-0.025 1.00984,-0.12886 0.358075,-0.0926 0.605734,-0.11658 1.054089,-0.10217 0.456543,0.0147 0.731187,0.0438 1.676366,0.17777 1.614235,0.22883 2.164001,0.2628 2.78702,0.17211 0.372399,-0.0542 0.73472,-0.18753 0.955735,-0.35167 0.133637,-0.0993 0.298398,-0.27379 0.397995,-0.42159 0.619796,-0.91982 2.317198,-4.80756 4.700348,-10.76556 0.709554,-1.77393 1.489761,-3.75884 2.033772,-5.17432 0.170006,-0.44234 0.337035,-0.8517 0.371156,-0.90967 0.14465,-0.24571 0.446396,-0.50929 0.869846,-0.75987 0.49286,-0.29164 0.950479,-0.48627 2.622499,-1.11531 1.62319,-0.61067 2.368465,-0.92483 3.255743,-1.37245 1.095894,-0.55279 1.245754,-0.65186 3.682916,-2.43506 1.973645,-1.44399 2.714191,-1.97849 3.628473,-2.61939 3.211566,-2.25082 5.330964,-3.44175 6.835264,-3.84075 0.66211,-0.17568 1.91028,-0.32761 2.88827,-0.35156 0.78901,-0.0193 1.23553,0.0421 1.40019,0.19268 0.12209,0.11163 -0.0242,0.44563 -0.4856,1.1087 -0.94246,1.35435 -2.57093,3.22995 -4.241183,4.88468 -0.973095,0.96407 -1.601963,1.52563 -2.429091,2.16902 -1.188807,0.92474 -2.628234,2.3304 -3.678619,3.59194 -0.477173,0.57323 -0.790379,1.01662 -1.049716,1.48606 -0.29353,0.53126 -0.50879,0.79472 -1.47615,1.80667 -0.908456,0.95031 -1.205304,1.31655 -1.392506,1.71808 -0.114175,0.24489 -0.12593,0.3105 -0.126063,0.7038 -2.18e-4,0.69868 -0.148711,1.93825 -0.43601,3.63969 -0.544436,3.22422 -1.22271,5.92815 -1.751151,6.98116 -0.198578,0.39566 -0.627032,0.97641 -1.071326,1.45216 -0.23437,0.25095 -0.489591,0.49706 -1.004969,0.9691 -0.59248,0.54265 -0.821636,0.80559 -0.874192,1.00306 -0.137799,0.5176 -0.283954,0.79157 -0.553798,1.03821 -0.158173,0.14456 -0.303034,0.23805 -0.684411,0.44167 -0.941978,0.50293 -1.509675,0.93515 -1.668078,1.26998 -0.135519,0.28644 -0.04534,0.40638 0.590997,0.78611 0.452559,0.27006 0.936872,0.52889 1.832888,0.97954 2.033409,1.02276 3.7481,1.76619 4.362478,1.89139 0.259266,0.0528 0.292791,0.067 0.285171,0.12074 -0.0065,0.0457 -0.05621,0.0739 -0.538873,0.30521 -0.248234,0.11896 -0.413326,0.23462 -0.482379,0.33797 -0.0629,0.0941 -0.05008,0.2126 0.04335,0.40038 0.276503,0.55583 1.041811,1.30067 1.533003,1.492 0.242025,0.0943 0.286391,0.0932 0.814689,-0.0207 2.559462,-0.55148 5.601258,-1.29998 6.656898,-1.63811 1.274406,-0.40822 3.951061,-1.07432 6.821651,-1.69762 0.29313,-0.0636 0.56782,-0.13276 0.61047,-0.15362 0.2353,-0.11506 0.66631,-0.52667 1.31844,-1.2591 0.49283,-0.55353 0.82091,-0.89293 0.93823,-0.97066 0.11186,-0.0741 0.18005,-0.0702 0.19735,0.0114 0.0652,0.30757 -0.12575,1.40755 -0.38304,2.20595 -0.20737,0.64346 -0.45177,1.09862 -0.67608,1.25908 -0.0424,0.0303 -0.21659,0.14692 -0.38713,0.25912 -0.9922,0.65284 -1.85447,1.42405 -2.0395,1.82417 -0.0443,0.0958 -0.0465,0.11576 -0.0338,0.30263 0.0209,0.30582 -0.0305,0.44704 -0.3229,0.88828 -0.0866,0.13064 -0.18119,0.29011 -0.21025,0.35441 -0.0937,0.20733 -0.30721,0.36319 -1.32763,0.96925 -0.96935,0.57575 -1.351871,0.83236 -1.586328,1.06419 -0.133466,0.13198 -0.185888,0.23567 -0.186589,0.36903 -0.0023,0.43367 -0.283117,1.32508 -0.519579,1.64898 -0.09341,0.12795 -0.259408,0.19105 -1.09898,0.41772 -0.277126,0.0748 -0.709408,0.19167 -0.960626,0.25965 -1.121066,0.30337 -1.681309,0.50635 -1.942245,0.70365 -0.109053,0.0825 -0.130384,0.12396 -0.394272,0.76703 -0.324573,0.79093 -0.549834,1.21025 -0.72455,1.34862 -0.141465,0.11204 -0.372373,0.12053 -1.046109,0.0384 -0.845612,-0.10304 -1.320971,-0.12249 -1.638807,-0.0671 -0.263995,0.046 -0.447447,0.14081 -0.536226,0.27698 -0.166205,0.25497 -0.205477,0.30342 -0.301649,0.37231 -0.22481,0.16098 -0.440784,0.20708 -1.089209,0.23247 -0.610891,0.0239 -0.710365,0.0392 -1.151033,0.17657 -1.096825,0.34195 -1.868199,0.52001 -2.389929,0.5517 -0.255444,0.0155 -0.370514,-0.006 -0.567528,-0.10768 -0.309554,-0.15925 -0.93188,-0.3336 -1.462494,-0.40977 -0.230312,-0.0331 -0.349978,-0.0398 -0.581402,-0.0327 -0.358308,0.011 -0.418218,0.0315 -0.6596,0.22594 -0.126797,0.10213 -0.253774,0.17945 -0.465116,0.28324 -0.230205,0.11303 -0.620347,0.26898 -0.777842,0.31096 -0.06004,0.016 -0.05912,1.93983 0.0013,2.26503 0.03812,0.2059 0.07411,0.28896 0.137799,0.318 0.04719,0.0215 0.167749,0.0478 1.307571,0.28541 1.359079,0.28331 2.131621,0.52679 2.399962,0.75643 0.159669,0.13665 0.166377,0.13355 -0.295394,0.13673 -1.073046,0.007 -2.536062,0.19043 -2.80851,0.35138 l -0.06163,0.0364 0.0052,0.19227 c 0.0085,0.3101 0.05913,0.74515 0.110789,0.95086 0.05533,0.22032 0.18326,0.49267 0.311675,0.66349 0.264997,0.35251 0.719895,0.71732 1.392795,1.11691 0.425908,0.25291 0.40122,0.24883 -0.434816,-0.072 -0.97364,-0.37371 -1.035272,-0.39024 -1.097854,-0.29472 -0.121995,0.18617 0.111492,0.97507 0.556616,1.880641 0.0845,0.17192 0.153642,0.32672 0.153642,0.34398 0,0.14885 -0.48355,-0.21652 -0.885559,-0.66913 -0.524976,-0.591071 -0.819245,-1.051431 -0.991357,-1.550931 -0.04289,-0.12447 -0.09269,-0.25528 -0.110668,-0.29069 -0.112511,-0.2217 -0.292096,-0.35781 -0.448758,-0.34014 -0.242219,0.0273 -0.448738,0.32433 -0.562299,0.80869 -0.02624,0.11191 -0.09465,0.39969 -0.152042,0.63955 -0.144803,0.605161 -0.169598,0.760201 -0.170458,1.065881 -0.0013,0.41695 0.08435,0.65556 0.314663,0.87791 0.154783,0.14944 0.253605,0.20176 0.61156,0.32379 1.301531,0.44369 2.423596,1.293529 2.860082,2.165839 0.08301,0.16596 0.168122,0.43839 0.186917,0.59828 0.0207,0.17614 -0.02595,0.14393 -0.356067,-0.24568 -0.1934,-0.22826 -0.40122,-0.42603 -0.543174,-0.51681 -0.170522,-0.10908 -0.285816,-0.14135 -0.505112,-0.14135 -0.277388,0 -0.333499,-0.0223 -0.815953,-0.32467 -0.279941,-0.17541 -0.595798,-0.32275 -0.825169,-0.38493 -0.174106,-0.0472 -0.227269,-0.0526 -0.523257,-0.0534 -0.294964,-6.5e-4 -0.353777,0.005 -0.561583,0.0536 -0.331449,0.0777 -0.573834,0.16744 -0.950051,0.35158 -0.407834,0.19961 -0.638042,0.33412 -0.761059,0.44475 -0.228427,0.20538 -0.333668,0.58293 -0.29303,1.05115 0.05968,0.6873 0.415356,1.49652 0.692197,1.57488 0.216457,0.0613 0.659123,0.10336 1.347806,0.12809 l 0.365785,0.0132 -0.136605,0.0633 c -0.447162,0.20713 -0.726435,0.50526 -0.69413,0.74103 0.01534,0.1119 0.140092,0.33665 0.540261,0.9733 0.4144,0.65929 0.522304,0.83587 0.514808,0.84232 -0.0035,0.003 -0.128383,-0.11833 -0.277606,-0.26953 z m 0.08338,-13.89904 c 0.0032,-0.0441 -0.01599,-0.19667 -0.04271,-0.33914 -0.08883,-0.47387 -0.09862,-0.57643 -0.09871,-1.03424 -6.2e-5,-0.30162 0.0121,-0.5659 0.03758,-0.81738 0.02965,-0.29249 0.03283,-0.38229 0.01495,-0.4215 -0.02932,-0.0644 -0.08306,-0.0641 -0.194114,9.7e-4 l -0.08675,0.0509 -0.166882,-0.0406 c -0.431212,-0.10483 -0.807429,-0.13927 -1.022044,-0.0936 -0.275789,0.0587 -0.434553,0.17871 -0.693413,0.52421 -0.368529,0.49186 -0.57352,0.84647 -0.57352,0.9921 0,0.13894 0.04995,0.16296 0.457166,0.21985 0.542956,0.0759 0.590546,0.096 1.558337,0.6575 0.539256,0.31292 0.696158,0.39312 0.755804,0.38644 0.04186,-0.005 0.04924,-0.0164 0.0543,-0.0855 z" /><path
     d="m 71.95687,19.648412 c -0.166685,0 -0.325183,0.03598 -0.478759,0.0877 l 0,0.07189 c -0.292838,0.118867 -0.55085,0.317255 -0.721734,0.593777 l -2.718723,4.395101 c -0.426999,0.035 -0.856005,0.07808 -1.281006,0.125082 l -3.520969,-3.779759 c -0.357,-0.382003 -0.886336,-0.552443 -1.400336,-0.451443 -0.515,0.102 -0.939857,0.462644 -1.122857,0.954644 l -1.804335,4.827854 c -0.418,0.12 -0.831625,0.24712 -1.243625,0.378119 l -4.185194,-3.01202 c -0.425,-0.306 -0.979158,-0.37065 -1.462159,-0.16965 -0.483999,0.2 -0.830388,0.638487 -0.914388,1.154486 l -0.829562,5.090957 c -0.384007,0.198999 -0.763983,0.404467 -1.142985,0.612467 l -4.694147,-2.139323 c -0.476999,-0.217 -1.029472,-0.174107 -1.466471,0.117893 -0.436,0.289999 -0.691413,0.788196 -0.671413,1.311197 l 0.181152,5.165718 c -0.33499,0.267 -0.666014,0.539185 -0.992025,0.815185 l -5.032009,-1.186116 c -0.511,-0.12 -1.045713,0.034 -1.414713,0.403998 -0.372001,0.371 -0.523998,0.90515 -0.404,1.416151 l 1.187555,5.03201 c -0.277,0.325 -0.549623,0.656587 -0.816623,0.990587 l -5.165717,-0.179715 c -0.52601,-0.02 -1.018771,0.233976 -1.30976,0.669976 -0.29201,0.434 -0.336893,0.989909 -0.117893,1.467909 l 2.139323,4.695584 c -0.20799,0.377 -0.414468,0.756984 -0.612468,1.142985 l -5.089518,0.828125 c -0.517,0.085 -0.954487,0.431388 -1.154487,0.914388 -0.2,0.485 -0.137349,1.037159 0.169651,1.462158 l 3.012017,4.182319 c -0.13,0.413 -0.25712,0.8285 -0.37812,1.2465 l -4.827854,1.804335 c -0.491,0.183001 -0.852206,0.607857 -0.953206,1.122858 -0.103999,0.512998 0.06888,1.042336 0.452881,1.400336 l 3.775445,3.522407 c -0.04598,0.424998 -0.08808,0.851568 -0.125082,1.279568 l -4.393663,2.72016 c -0.444999,0.275001 -0.714545,0.761319 -0.714545,1.285319 0,0.524 0.270983,1.011319 0.715983,1.285319 l 4.393663,2.720161 c 0.03698,0.427 0.07908,0.854568 0.125082,1.279568 l -3.776883,3.523844 c -0.38404,0.357 -0.555443,0.886337 -0.451443,1.400337 0.1,0.514998 0.462207,0.937419 0.953207,1.121419 l 4.826415,1.804334 c 0.121,0.418 0.24812,0.833501 0.37812,1.246501 l -3.01058,4.183756 c -0.306999,0.426 -0.36965,0.977721 -0.16965,1.460722 0.199999,0.484998 0.635049,0.831387 1.153049,0.914387 l 5.090956,0.828125 c 0.19801,0.386002 0.40204,0.765422 0.61103,1.144423 l -2.137885,4.694151 c -0.219001,0.477004 -0.174108,1.031904 0.117892,1.467904 0.291,0.437 0.788771,0.69098 1.309761,0.66998 l 5.165717,-0.17971 c 0.265999,0.336 0.537747,0.66503 0.813748,0.99202 l -1.184679,5.03201 c -0.12,0.51 0.03056,1.04371 0.402561,1.41471 0.369,0.37303 0.90515,0.52113 1.416151,0.40113 l 5.030571,-1.18468 c 0.326011,0.278 0.658035,0.54674 0.992025,0.81374 l -0.179714,5.16716 c -0.019,0.524 0.233975,1.0192 0.669975,1.3112 0.434996,0.291 0.99091,0.33446 1.46791,0.11645 l 4.694146,-2.13788 c 0.379,0.207 0.758985,0.41347 1.142984,0.61247 l 0.829563,5.08808 c 0.084,0.517 0.430387,0.95549 0.914388,1.15448 0.483,0.20099 1.035721,0.13679 1.460721,-0.16821 l 4.183756,-3.01346 c 0.412999,0.13099 0.828501,0.25956 1.246501,0.37956 l 1.804335,4.82498 c 0.183,0.49 0.606419,0.8522 1.121419,0.9532 0.513,0.10401 1.043336,-0.0674 1.400336,-0.45144 l 3.522407,-3.77688 c 0.425,0.049 0.851569,0.09 1.279568,0.12796 l 2.720161,4.39366 c 0.275,0.444 0.762757,0.71599 1.286756,0.71599 0.166227,0 0.324314,-0.0361 0.477322,-0.0877 l 0,-0.0719 c 0.292583,-0.11912 0.549528,-0.31807 0.720296,-0.59378 l 2.720161,-4.39366 c 0.428,-0.0379 0.854568,-0.0791 1.279568,-0.12796 l 3.522407,3.77688 c 0.357,0.38405 0.887336,0.55544 1.400336,0.45145 0.515,-0.10101 0.93842,-0.46321 1.121419,-0.95321 l 1.804335,-4.82498 c 0.418,-0.12 0.833502,-0.24857 1.246501,-0.37956 l 4.183756,3.01346 c 0.425001,0.305 0.977721,0.36921 1.460721,0.16821 0.484001,-0.19899 0.830388,-0.63748 0.914388,-1.15449 l 0.829563,-5.08808 c 0.383999,-0.199 0.763984,-0.40546 1.142984,-0.61246 l 4.694146,2.13788 c 0.476996,0.21802 1.032916,0.17455 1.467906,-0.11645 0.436,-0.292 0.68898,-0.7872 0.66998,-1.3112 l -0.17971,-5.16716 c 0.33399,-0.267 0.66601,-0.53574 0.99202,-0.81374 l 5.03057,1.18468 c 0.511,0.12 1.04715,-0.0281 1.41615,-0.40113 0.372,-0.371 0.52256,-0.90471 0.40256,-1.41471 l -1.18468,-5.03201 c 0.276,-0.32699 0.54775,-0.65603 0.81375,-0.99202 l 5.16572,0.17971 c 0.52099,0.021 1.01876,-0.23298 1.30976,-0.66998 0.292,-0.436 0.33689,-0.99091 0.11789,-1.467914 l -2.13788,-4.694142 c 0.20899,-0.379001 0.41302,-0.75842 0.61103,-1.144422 l 5.09095,-0.828125 c 0.518,-0.083 0.95305,-0.429389 1.15305,-0.914389 0.2,-0.483 0.13735,-1.03472 -0.16965,-1.46072 l -3.01058,-4.183756 c 0.13,-0.413001 0.25712,-0.828501 0.37812,-1.246501 l 4.82642,-1.804335 c 0.491,-0.184 0.8532,-0.60642 0.9532,-1.121419 0.104,-0.514 -0.0674,-1.043337 -0.45144,-1.400336 l -3.77688,-3.523845 c 0.046,-0.425 0.0881,-0.852568 0.12508,-1.279568 l 4.39366,-2.72016 c 0.445,-0.273999 0.71598,-0.76132 0.71598,-1.28532 0,-0.524 -0.26954,-1.010319 -0.71454,-1.285319 l -4.39366,-2.72016 c -0.037,-0.428 -0.0791,-0.854569 -0.12509,-1.279568 l 3.77545,-3.522407 c 0.384,-0.358 0.55688,-0.887337 0.45288,-1.400336 -0.101,-0.515 -0.46221,-0.939857 -0.95321,-1.122857 l -4.82785,-1.804335 c -0.121,-0.418 -0.24812,-0.833499 -0.37812,-1.2465 l 3.01202,-4.182319 c 0.307,-0.424999 0.36965,-0.977158 0.16965,-1.462158 -0.2,-0.483 -0.63749,-0.829388 -1.15449,-0.914388 l -5.08952,-0.828125 c -0.198,-0.386002 -0.40447,-0.765985 -0.61246,-1.142985 l 2.13932,-4.695584 c 0.219,-0.478001 0.17412,-1.033909 -0.11789,-1.467909 -0.29099,-0.435999 -0.78375,-0.689976 -1.30976,-0.669976 l -5.16572,0.179714 c -0.267,-0.334 -0.53963,-0.665587 -0.81663,-0.990587 l 1.18756,-5.032009 c 0.12,-0.511001 -0.032,-1.045151 -0.404,-1.416151 -0.369,-0.369998 -0.90371,-0.523999 -1.41471,-0.403999 l -5.03201,1.186117 c -0.32601,-0.275999 -0.65703,-0.548186 -0.99202,-0.815186 l 0.18115,-5.165717 c 0.02,-0.523001 -0.23542,-1.021198 -0.67142,-1.311198 -0.43699,-0.292 -0.98947,-0.334893 -1.466467,-0.117892 l -4.694147,2.139322 c -0.379002,-0.208 -0.758978,-0.413468 -1.142985,-0.612468 l -0.829562,-5.090955 c -0.084,-0.516 -0.430388,-0.954487 -0.914389,-1.154487 -0.483,-0.201 -1.037157,-0.136349 -1.462158,0.169651 l -4.185194,3.012017 c -0.412,-0.130999 -0.825625,-0.25812 -1.243625,-0.37812 L 83.287518,21.60801 c -0.183,-0.492 -0.607857,-0.852644 -1.122857,-0.954644 -0.514,-0.101001 -1.043336,0.06944 -1.400336,0.451444 l -3.520969,3.779757 c -0.425001,-0.047 -0.854006,-0.09008 -1.281006,-0.125081 l -2.718723,-4.395101 c -0.275,-0.445 -0.762757,-0.715983 -1.286757,-0.715983 z m 0.181153,9.293403 c 0.02599,-6.04e-4 0.05172,0.0049 0.07764,0.0058 0.671081,0.09281 1.318124,0.390406 1.823024,0.918701 0.338919,0.356079 0.566044,0.774142 0.704482,1.213433 a 40.289779,40.289779 0 0 1 33.247211,26.252712 c 0.6824,-0.201852 1.43353,-0.185104 2.13501,0.126519 1.569,0.695999 2.27605,2.536559 1.58005,4.107558 -0.39778,0.899729 -1.17297,1.502806 -2.0545,1.735324 a 40.289779,40.289779 0 0 1 0.7965,7.780925 40.289779,40.289779 0 0 1 -13.944425,30.417783 c 1.048666,0.68278 1.628017,1.95912 1.350017,3.25643 -0.359995,1.68 -2.013619,2.74992 -3.690619,2.39092 -1.136368,-0.24516 -1.979288,-1.08699 -2.301785,-2.12494 a 40.289779,40.289779 0 0 1 -20.087782,6.27994 40.289779,40.289779 0 0 1 -19.633464,-6.24256 c -0.322497,1.03795 -1.165418,1.87978 -2.301785,2.12494 -1.677,0.359 -3.330624,-0.71092 -3.690619,-2.39092 -0.278,-1.29731 0.301352,-2.57365 1.350017,-3.25643 A 40.289779,40.289779 0 0 1 33.552574,71.120118 40.289779,40.289779 0 0 1 34.34907,63.339194 c -0.881531,-0.232517 -1.656718,-0.835595 -2.054498,-1.735324 -0.696001,-1.571 0.01105,-3.411558 1.580051,-4.107558 0.70148,-0.311622 1.45261,-0.328371 2.13501,-0.126519 A 40.289779,40.289779 0 0 1 69.256838,31.117081 c 0.138438,-0.439292 0.365563,-0.857354 0.704481,-1.213433 0.5935,-0.621 1.381579,-0.943333 2.176704,-0.961833 z"
     id="path3-4"
     inkscape:connector-curvature="0" /></svg>">
|
||
<title>Crowbook User Guide</title>
|
||
<style type = "text/css">
|
||
body {
|
||
font-family: "Linux Libertine", "Georgia", serif;
|
||
text-align: justify;
|
||
font-size: 100%;
|
||
}
|
||
|
||
p {
|
||
text-indent: 1.25em;
|
||
margin:0;
|
||
hyphens: auto;
|
||
}
|
||
|
||
blockquote {
|
||
margin: 1em;
|
||
font-style: italic;
|
||
}
|
||
code {
|
||
font-size: 80%;
|
||
font-family: "Linux Libertine Mono", monospace;
|
||
background-color: #F0F0F0;
|
||
}
|
||
pre {
|
||
font-family: "Linux Libertine Mono", monospace;
|
||
margin: 1em;
|
||
padding-top: 0;
|
||
background-color: #F0F0F0;
|
||
white-space: pre-wrap;
|
||
word-wrap: break-word;
|
||
}
|
||
/* Try to disable hyphenation in titles */
|
||
h1, h2, h3, h4, h5, h5 {
|
||
adobe-hyphenate: none;
|
||
-ms-hyphens: none; /* Trident (Windows) */
|
||
-moz-hyphens: none; /* Gecko (Firefox) */
|
||
-webkit-hyphens: none; /* Webkit */
|
||
-epub-hyphens: none; /* EPUB 3 */
|
||
hyphens: none; /* Futur standard */
|
||
}
|
||
|
||
h1, h2, h3, h4, h5, h6 {
|
||
text-align: left;
|
||
font-family: Linux Biolinum, sans-serif;
|
||
font-variant: small-caps;
|
||
}
|
||
|
||
/* Title of a part */
|
||
h1.part {
|
||
font-size: 250%;
|
||
text-align: center;
|
||
}
|
||
|
||
/* The `Part X` section of a part */
|
||
h2.part {
|
||
font-size: 175%;
|
||
text-align: center;
|
||
}
|
||
|
||
/* The "Chapter X" section of a chapter */
|
||
span.chapter-header {
|
||
font-size: 75%;
|
||
}
|
||
|
||
/* Title of the book */
|
||
h1.title {
|
||
text-align: center;
|
||
font-size: 300%;
|
||
}
|
||
/* Author */
|
||
h2.author {
|
||
text-align: right;
|
||
font-size: 200%;
|
||
}
|
||
|
||
/* Subtitle */
|
||
h2.subtitle {
|
||
text-align: center;
|
||
font-size: 200%;
|
||
}
|
||
|
||
/* When toc is displayed inlined */
|
||
#toc ol, #toc ul {
|
||
padding: 0;
|
||
margin-left: 1em;
|
||
}
|
||
#toc li {
|
||
list-style-type: none;
|
||
margin: 0; padding: 0;
|
||
}
|
||
|
||
#toc li:before {
|
||
content: none;
|
||
}
|
||
|
||
#cover img {
|
||
width: 100%;
|
||
max-height: 100%;
|
||
}
|
||
|
||
.image {
|
||
margin: auto;
|
||
width: 80%;
|
||
}
|
||
|
||
.image img {
|
||
width: 100%;
|
||
max-height: 100%;
|
||
}
|
||
|
||
.rule {
|
||
text-align: center !important;
|
||
margin-top: 1em;
|
||
margin-bottom: 1em;
|
||
font-weight: bold;
|
||
page-break-inside: avoid;
|
||
break-inside: avoid;
|
||
page-break-after: avoid;
|
||
break-after: avoid;
|
||
}
|
||
|
||
/* The number of the note in an expanded footnote (e.g. [3]) */
|
||
.note-number {
|
||
font-weight: bold;
|
||
margin-right: 1em;
|
||
}
|
||
|
||
td.note-number {
|
||
vertical-align: top;
|
||
}
|
||
|
||
/* When footnotes (try to) be diplayed as margin notes */
|
||
.sidenote {
|
||
display: block;
|
||
float: right;
|
||
width: 30%;
|
||
border: 1px solid black;
|
||
margin: 1em;
|
||
padding: .5em;
|
||
margin-right: -1.5em;
|
||
}
|
||
|
||
.sidenote .note-number {
|
||
float: left;
|
||
}
|
||
|
||
/* The div class displaying notes at the end of a chapter */
|
||
div.notes {
|
||
text-align: justify;
|
||
border-top: thin dashed black;
|
||
margin-top: 1em;
|
||
}
|
||
|
||
table.notes {
|
||
border-collapse: collapse;
|
||
border-style: hidden;
|
||
}
|
||
|
||
table.notes tr td {
|
||
margin-left: 1em;
|
||
margin-right: 1em;
|
||
}
|
||
|
||
table.notes tr td p {
|
||
text-indent: 0;
|
||
}
|
||
|
||
/* Every markdown table is included in a <div class = "table"> */
|
||
.table {
|
||
margin: 1em;
|
||
}
|
||
|
||
.table table {
|
||
width: 80%;
|
||
margin: 0 auto;
|
||
border-style: solid;
|
||
border-width: thin;
|
||
border-color: black;
|
||
border-collapse: collapse;
|
||
}
|
||
|
||
.table table th, .table table td {
|
||
border-style: solid;
|
||
border-width: 1px;
|
||
text-align: center;
|
||
}
|
||
|
||
.table table th {
|
||
font-weight: bold;
|
||
font-variant: small-caps;
|
||
}
|
||
|
||
|
||
span.initial {
|
||
float: left;
|
||
font-size: 285%;
|
||
font-weight: bold;
|
||
margin-right: 0.05em;
|
||
line-height: 0.8em;
|
||
}
|
||
|
||
p.first-para {
|
||
text-indent: 0;
|
||
}
|
||
|
||
/* Use this for escape narrow space so it is non-breaking */
|
||
.nnbsp {
|
||
/* white-space: nowrap;*/
|
||
word-spacing: -0.13em;
|
||
/* Following necessary for Kobo EPUB3 reader??? */
|
||
margin: 0;
|
||
padding: 0;
|
||
}
|
||
|
||
/* Default HTML CSS file includes default EPUB CSS file */
|
||
|
||
/* Colours for the navigation menu (toc) */
|
||
nav {
|
||
background: #181818;
|
||
color: #cdd4da;
|
||
border-right-color: #cdd4da;
|
||
}
|
||
|
||
nav {
|
||
border-right: solid thin #cdd4da;
|
||
}
|
||
|
||
#nav a:link {
|
||
color: #cdd4da;
|
||
}
|
||
|
||
#nav a:visited {
|
||
color: #cdd4da;
|
||
}
|
||
|
||
a:link {
|
||
color: #3399ff;
|
||
}
|
||
|
||
a:visited {
|
||
color: #0066cc;
|
||
}
|
||
|
||
a:hover {
|
||
color: #66b3ff;
|
||
}
|
||
|
||
body {
|
||
background-color: #181818;
|
||
color: #cdd4da;
|
||
}
|
||
|
||
pre, code {
|
||
background-color: #1d1f21;
|
||
}
|
||
|
||
/* Colours for top and footer */
|
||
#top {
|
||
background-color: #cdd4da;
|
||
color: #181818;
|
||
}
|
||
|
||
footer {
|
||
background-color: #cdd4da;
|
||
color: #181818;
|
||
}
|
||
|
||
footer a, #top a {
|
||
color: #040C62;
|
||
}
|
||
|
||
footer a:hover, #top a:hover {
|
||
color: #00A8F6;
|
||
}
|
||
|
||
/* Additional elements */
|
||
/* Grammar error */
|
||
.grammar-error {
|
||
color: red;
|
||
text-decoration-line: underline;
|
||
text-decoration-style: double;
|
||
}
|
||
|
||
|
||
p.first-para:first-letter {
|
||
font-size: 300%;
|
||
float: left;
|
||
font-weight: bold;
|
||
margin-right: 0.05em;
|
||
line-height: 1em;
|
||
}
|
||
|
||
/* The nav element corresponding to the navigation menu */
|
||
nav {
|
||
z-index: 2;
|
||
position: fixed;
|
||
left: 0;
|
||
top: 0;
|
||
bottom: 0;
|
||
width: 20%;
|
||
overflow-y: auto;
|
||
font-size: 80%;
|
||
margin-left: 0;
|
||
border-right-width: 2px;
|
||
border-right-style: dashed;
|
||
}
|
||
|
||
#nav code {
|
||
background-color: transparent;
|
||
}
|
||
|
||
#nav a:link {
|
||
text-decoration: none;
|
||
}
|
||
|
||
#nav a:visited {
|
||
text-decoration: none;
|
||
}
|
||
|
||
#nav {
|
||
text-align: left;
|
||
}
|
||
|
||
#nav h2 {
|
||
text-align: center;
|
||
}
|
||
|
||
#nav li {
|
||
list-style-type: none;
|
||
text-indent: -1em;
|
||
}
|
||
|
||
#nav li:before {
|
||
content: none;
|
||
}
|
||
|
||
#nav ul {
|
||
padding-right: 1em;
|
||
padding-left: 1.5em;
|
||
}
|
||
|
||
/* The menu containing the button to display the navigation bar */
|
||
#menu {
|
||
position: fixed;
|
||
z-index: 2;
|
||
top: 0em;
|
||
left: 1em;
|
||
transition: left 1s;
|
||
}
|
||
|
||
#menu img {
|
||
opacity: 0.5;
|
||
}
|
||
|
||
#menu img:hover {
|
||
opacity: 1.0;
|
||
cursor: pointer;
|
||
}
|
||
|
||
#menu-button {
|
||
height: 1.5em;
|
||
padding: 0.5em;
|
||
}
|
||
|
||
#book-button {
|
||
height: 1.5em;
|
||
padding: 0.5em;
|
||
float: left;
|
||
}
|
||
|
||
/* Hide navigation bar */
|
||
#nav {
|
||
left: -21%;
|
||
transition: left 1s;
|
||
}
|
||
|
||
/* The main content of the book */
|
||
#content {
|
||
overflow-y: auto;
|
||
margin-left: 0;
|
||
margin-right: 0;
|
||
margin-top: 0;
|
||
margin-bottom: 0;
|
||
transition: margin-left 1s;
|
||
}
|
||
|
||
/* Used for multifiles HTML */
|
||
.prev_chapter {
|
||
text-align: left;
|
||
text-indent: 0;
|
||
margin-bottom: 1em;
|
||
font-size: 120%;
|
||
font-variant: small-caps;
|
||
font-weight: bold;
|
||
}
|
||
|
||
.next_chapter {
|
||
text-align: right;
|
||
margin-top: 1em;
|
||
margin-bottom: 1em;
|
||
font-size: 120%;
|
||
font-variant: small-caps;
|
||
font-weight: bold;
|
||
}
|
||
|
||
/* Improving readability for the HTML format only */
|
||
p, blockquote, li, .image {
|
||
margin-right: auto;
|
||
max-width: 33em;
|
||
}
|
||
|
||
blockquote {
|
||
padding: 1em;
|
||
}
|
||
|
||
#content {
|
||
text-align: center;
|
||
}
|
||
|
||
#page {
|
||
display: inline-block;
|
||
text-align: justify;
|
||
max-width: 33em;
|
||
}
|
||
|
||
#nav-container {
|
||
top: 0;
|
||
width: 100%;
|
||
}
|
||
|
||
#nav-title {
|
||
top: 0;
|
||
}
|
||
|
||
#toolbar {
|
||
top: 0;
|
||
float: left;
|
||
}
|
||
|
||
#toolbar img {
|
||
cursor: pointer;
|
||
}
|
||
|
||
footer {
|
||
margin-top: 2em;
|
||
margin-bottom: 0;
|
||
}
|
||
|
||
#top {
|
||
margin-top: 0;
|
||
margin-bottom: 1em;
|
||
}
|
||
|
||
#top p {
|
||
font-family: "Linux Biolinum";
|
||
font-weight: bold;
|
||
font-variant: small-caps;
|
||
}
|
||
|
||
footer, #top {
|
||
padding-top: .25em;
|
||
padding-bottom: .25em;
|
||
margin-left: 0;
|
||
margin-right: 0;
|
||
text-align: center;
|
||
transition: margin-left 1s;
|
||
}
|
||
|
||
footer a, #top a {
|
||
text-decoration: none;
|
||
}
|
||
|
||
footer p, #top p {
|
||
text-indent: 0;
|
||
margin-left: auto;
|
||
margin-right: auto;
|
||
margin-bottom: 0.5em;
|
||
margin-top: 0.5em;
|
||
max-width: 33em;
|
||
}
|
||
|
||
|
||
</style>
|
||
<style type = "text/css" media = "print">
|
||
#page {
|
||
display: block;
|
||
}
|
||
|
||
.chapter {
|
||
page-break-before: always;
|
||
}
|
||
|
||
#menu {
|
||
display: none;
|
||
}
|
||
|
||
#nav {
|
||
display: none;
|
||
}
|
||
</style>
|
||
<script>
|
||
function on(name) {
|
||
var elements = document.getElementsByClassName(name);
|
||
for (var i = 0; i < elements.length; i++) {
|
||
var elem = elements[i];
|
||
elem.style.backgroundColor = "pink";
|
||
}
|
||
}
|
||
function off(name) {
|
||
var elements = document.getElementsByClassName(name);
|
||
for (var i = 0; i < elements.length; i++) {
|
||
var elem = elements[i];
|
||
elem.style.backgroundColor = "white";
|
||
}
|
||
}
|
||
|
||
var display_menu = false;
|
||
function toggle() {
|
||
if (display_menu == true) {
|
||
display_menu = false;
|
||
document.getElementById("nav").style.left = "-21%";
|
||
document.getElementById("content").style.marginLeft = "0%";
|
||
document.getElementById("menu").style.left = "1em";
|
||
/* if(document.getElementById("top")) {
|
||
document.getElementById("top").style.left = "0";
|
||
}
|
||
if(document.getElementById("footer")) {
|
||
document.getElementById("footer").style.marginLeft = "0%";
|
||
}*/
|
||
} else {
|
||
display_menu = true;
|
||
document.getElementById("nav").style.left = "0";
|
||
document.getElementById("content").style.marginLeft = "20%";
|
||
document.getElementById("menu").style.left = "20%";
|
||
/* if(document.getElementById("top")) {
|
||
document.getElementById("top").style.left = "20%";
|
||
}
|
||
if(document.getElementById("footer")) {
|
||
document.getElementById("footer").style.marginLeft = "20%";
|
||
}*/
|
||
}
|
||
}
|
||
|
||
|
||
|
||
</script>
|
||
|
||
|
||
</head>
|
||
<body>
|
||
|
||
<script type = 'application/ld+json'>
|
||
{
|
||
"@context": "http://schema.org/",
|
||
"@type": "Book",
|
||
"author": "Élisabeth Henry",
|
||
"name": "Crowbook User Guide",
|
||
"version": "0.13.0",
|
||
|
||
|
||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||
"about": "Crowbook allows to render a book written in Markdown in various formats. This is some kind of manual for it, and a way to demonstrate and test it.",
|
||
"inLanguage": "en"
|
||
|
||
|
||
|
||
|
||
}
|
||
</script>
|
||
<nav id = "nav">
|
||
<div id = "nav-title">
|
||
<h2><a href = "#link-0">Crowbook User Guide</a></h2>
|
||
</div>
|
||
<ul>
|
||
<li><a href = "#link-1">1. Crowbook</a>
|
||
<ul><li><a href = "#link-2">1.1. Example</a></li>
|
||
<li><a href = "#link-3">1.2. Installing</a></li>
|
||
<li><a href = "#link-6">1.3. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Dependencies</a></li>
|
||
<li><a href = "#link-7">1.4. Quick tour</a></li>
|
||
<li><a href = "#link-8">1.5. Current features</a></li>
|
||
<li><a href = "#link-18">1.6. Contributors</a></li>
|
||
<li><a href = "#link-19">1.7. Acknowledgements</a></li>
|
||
<li><a href = "#link-20">1.8. ChangeLog</a></li>
|
||
<li><a href = "#link-21">1.9. Contributing</a></li>
|
||
<li><a href = "#link-22">1.10. Library</a></li>
|
||
<li><a href = "#link-23">1.11. License</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-24">2. Arguments</a>
|
||
<ul><li><a href = "#link-25">2.1. <code>--create</code></a></li>
|
||
<li><a href = "#link-26">2.2. <code>--single</code></a></li>
|
||
<li><a href = "#link-27">2.3. <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span></code></a></li>
|
||
<li><a href = "#link-28">2.4. <code>--list-options</code></a></li>
|
||
<li><a href = "#link-29">2.5. <code>--print-template</code></a></li>
|
||
<li><a href = "#link-30">2.6. <code>--stats</code></a></li>
|
||
<li><a href = "#link-31">2.7. <code>--proofread</code></a></li>
|
||
<li><a href = "#link-32">2.8. <code>--verbose</code></a></li>
|
||
<li><a href = "#link-33">2.9. <code>--to</code></a></li>
|
||
<li><a href = "#link-35">2.10. <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">output</span></code></a></li>
|
||
<li><a href = "#link-36">2.11. <code>--lang</code></a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-38">3. The configuration file</a>
|
||
<ul><li><a href = "#link-39">3.1. Configuration in an inline YAML block</a></li>
|
||
<li><a href = "#link-40">3.2. The list of files</a></li>
|
||
<li><a href = "#link-43">3.3. Crowbook options</a></li>
|
||
<li><a href = "#link-58">3.4. Full list of options</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-75">4. Markdown format</a>
|
||
<ul><li><a href = "#link-76">4.1. Tables</a></li>
|
||
<li><a href = "#link-77">4.2. Footnotes</a></li>
|
||
<li><a href = "#link-78">4.3. Superscript and subscript</a></li>
|
||
<li><a href = "#link-79">4.4. <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Standalone<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> images</a></li>
|
||
<li><a href = "#link-80">4.5. Interactive fiction</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-81">5. Templates</a>
|
||
<ul><li><a href = "#link-82">5.1. Create and edit <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></a></li>
|
||
<li><a href = "#link-86">5.2. List of templates</a></li>
|
||
<li><a href = "#link-100">5.3. List of accessible variables</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-104">6. Proofreading with Crowbook</a>
|
||
<ul><li><a href = "#link-105">6.1. Enabling <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofreading</span></a></li>
|
||
<li><a href = "#link-106">6.2. Repetition detection</a></li>
|
||
<li><a href = "#link-107">6.3. Grammar checking</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-110">7. Interactive fiction</a>
|
||
<ul><li><a href = "#link-111">7.1. Basics</a></li>
|
||
<li><a href = "#link-112">7.2. The interactive fiction renderer</a></li>
|
||
<li><a href = "#link-113">7.3. Using Javascript in your interactive fiction</a></li>
|
||
<li><a href = "#link-114">7.4. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Embedding</span> Makdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">embedded</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> Markdown</a></li>
|
||
<li><a href = "#link-115">7.5. Conditional blocks</a></li>
|
||
<li><a href = "#link-116">7.6. Interactive fiction options</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-117">8. Tips and tricks</a>
|
||
<ul><li><a href = "#link-118">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||
<li><a href = "#link-120">8.2. Embedding fonts in an EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span></a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-121">9. Contributing</a>
|
||
<ul><li><a href = "#link-122">9.1. Internationalization</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-123">ChangeLog</a>
|
||
<ul><li><a href = "#link-124">0.14.0-beta (2017-10-08)</a></li>
|
||
<li><a href = "#link-125">0.13.0 (2017-07-14)</a></li>
|
||
<li><a href = "#link-126">0.12.0 (2017-06-05)</a></li>
|
||
<li><a href = "#link-127">0.11.4 (2017-03-21)</a></li>
|
||
<li><a href = "#link-128">0.11.3 (2017-03-19)</a></li>
|
||
<li><a href = "#link-129">0.11.2 (2017-03-05)</a></li>
|
||
<li><a href = "#link-130">0.11.1 (2017-01-05)</a></li>
|
||
<li><a href = "#link-131">0.11.0 (2016-12-31)</a></li>
|
||
<li><a href = "#link-132">0.10.4 (2016-12-16)</a></li>
|
||
<li><a href = "#link-133">0.10.3 (2016-11-19)</a></li>
|
||
<li><a href = "#link-134">0.10.2 (2016-10-21)</a></li>
|
||
<li><a href = "#link-135">0.10.1 (2016-10-18)</a></li>
|
||
<li><a href = "#link-136">0.10.0 (2016-10-18)</a></li>
|
||
<li><a href = "#link-137">0.9.1 (2016-09-29)</a></li>
|
||
<li><a href = "#link-138">0.9.0 (2016-09-23)</a></li>
|
||
<li><a href = "#link-139">0.8.0 (2016-09-19)</a></li>
|
||
<li><a href = "#link-140">0.7.0 (2016-09-11)</a></li>
|
||
<li><a href = "#link-141">0.6.0 (2016-09-09)</a></li>
|
||
<li><a href = "#link-142">0.5.1 (2016-04-14)</a></li>
|
||
<li><a href = "#link-143">0.5.0 (2016-04-02)</a></li>
|
||
<li><a href = "#link-144">0.4.0 (2016-03-01)</a></li>
|
||
<li><a href = "#link-145">0.3.0 (2016-02-27)</a></li>
|
||
<li><a href = "#link-146">0.2.2 (2016-02-25)</a></li>
|
||
<li><a href = "#link-147">0.2.1 (2016-02-25)</a></li>
|
||
<li><a href = "#link-148">0.2.0 (2016-02-25)</a></li>
|
||
<li><a href = "#link-149">0.1.0 (2016-02-21)</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href = "#link-150">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
|
||
<div id = "content">
|
||
<div id = "top"><p id = "para-342">Crowbook User Guide 0.13.0</p>
|
||
</div>
|
||
<div id = "page">
|
||
<header>
|
||
|
||
<div id = "menu">
|
||
<img id = "menu-button" onclick="toggle();"
|
||
src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjwhLS0gQ3JlYXRlZCB3aXRoIElua3NjYXBlIChodHRwOi8vd3d3Lmlua3NjYXBlLm9yZy8pIC0tPgoKPHN2ZwogICB4bWxuczpkYz0iaHR0cDovL3B1cmwub3JnL2RjL2VsZW1lbnRzLzEuMS8iCiAgIHhtbG5zOmNjPSJodHRwOi8vY3JlYXRpdmVjb21tb25zLm9yZy9ucyMiCiAgIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyIKICAgeG1sbnM6c3ZnPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIgogICB4bWxuczpzb2RpcG9kaT0iaHR0cDovL3NvZGlwb2RpLnNvdXJjZWZvcmdlLm5ldC9EVEQvc29kaXBvZGktMC5kdGQiCiAgIHhtbG5zOmlua3NjYXBlPSJodHRwOi8vd3d3Lmlua3NjYXBlLm9yZy9uYW1lc3BhY2VzL2lua3NjYXBlIgogICB3aWR0aD0iMjAwbW0iCiAgIGhlaWdodD0iMjAwbW0iCiAgIHZpZXdCb3g9IjAgMCA3MDguNjYxNDIgNzA4LjY2MTQxIgogICBpZD0ic3ZnMiIKICAgdmVyc2lvbj0iMS4xIgogICBpbmtzY2FwZTp2ZXJzaW9uPSIwLjkxIHIxMzcyNSIKICAgc29kaXBvZGk6ZG9jbmFtZT0ibWVudS5zdmciPgogIDxkZWZzCiAgICAgaWQ9ImRlZnM0IiAvPgogIDxzb2RpcG9kaTpuYW1lZHZpZXcKICAgICBpZD0iYmFzZSIKICAgICBwYWdlY29sb3I9IiNmZmZmZmYiCiAgICAgYm9yZGVyY29sb3I9IiM2NjY2NjYiCiAgICAgYm9yZGVyb3BhY2l0eT0iMS4wIgogICAgIGlua3NjYXBlOnBhZ2VvcGFjaXR5PSIwLjAiCiAgICAgaW5rc2NhcGU6cGFnZXNoYWRvdz0iMiIKICAgICBpbmtzY2FwZTp6b29tPSIwLjQ5NDk3NDc1IgogICAgIGlua3NjYXBlOmN4PSIxMDUuNjEyNzUiCiAgICAgaW5rc2NhcGU6Y3k9IjQwNy4wNjM5MSIKICAgICBpbmtzY2FwZTpkb2N1bWVudC11bml0cz0icHgiCiAgICAgaW5rc2NhcGU6Y3VycmVudC1sYXllcj0ibGF5ZXIxIgogICAgIHNob3dncmlkPSJmYWxzZSIKICAgICBpbmtzY2FwZTp3aW5kb3ctd2lkdGg9IjEzNjYiCiAgICAgaW5rc2NhcGU6d2luZG93LWhlaWdodD0iNzA0IgogICAgIGlua3NjYXBlOndpbmRvdy14PSIwIgogICAgIGlua3NjYXBlOndpbmRvdy15PSIyNyIKICAgICBpbmtzY2FwZTp3aW5kb3ctbWF4aW1pemVkPSIxIiAvPgogIDxtZXRhZGF0YQogICAgIGlkPSJtZXRhZGF0YTciPgogICAgPHJkZjpSREY+CiAgICAgIDxjYzpXb3JrCiAgICAgICAgIHJkZjphYm91dD0iIj4KICAgICAgICA8ZGM6Zm9ybWF0PmltYWdlL3N2Zyt4bWw8L2RjOmZvcm1hdD4KICAgICAgICA8ZGM6dHlwZQogICAgICAgICAgIHJkZjpyZXNvdXJjZT0iaHR0cDovL3B1cmwub3JnL2RjL2RjbWl0eXBlL1N0aWxsSW1hZ2UiIC8+CiAgICAgICAgPGRjOnRpdGxlPjwvZGM6dGl0bGU+CiAgICAgIDwvY2M6V29yaz4KICAgIDwvcmRmOlJERj4KICA8L21ldGFkYXRhPgogIDxnCiAgICAgaW5rc2NhcGU6bGFiZWw9IkxheWVyIDEiCiAgICAgaW5rc2NhcGU6Z3JvdXBtb2RlPSJsYXllciIKICAgICBpZD0ibGF5ZXIxIgogICAgIHRyYW5zZm9ybT0idHJhbnNsYXRlKDAsLTM0My43MDA3OSkiPgogICAgPHBhdGgKICAgICAgIHN0eWxlPSJmaWxsOm5vbmU7ZmlsbC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlOiMwMDAwMDA7c3Ryb2tlLXdpZHRoOjEwMDtzdHJva2UtbGluZWNhcDpyb3VuZDtzdHJva2UtbGluZWpvaW46cm91bmQ7c3Ryb2tlLW1pdGVybGltaXQ6NDtzdHJva2UtZGFzaGFycmF5Om5vbmU7c3Ryb2tlLW9wYWNpdHk6MSIKICAgICAgIGQ9Im0gMTA0LjMzMDcxLDQ2OS41MDUxIDUwMCwwIgogICAgICAgaWQ9InBhdGg0MTM2IgogICAgICAgaW5rc2NhcGU6Y29ubmVjdG9yLWN1cnZhdHVyZT0iMCIgLz4KICAgIDxwYXRoCiAgICAgICBzdHlsZT0iZmlsbDpub25lO2ZpbGwtcnVsZTpldmVub2RkO3N0cm9rZTojMDAwMDAwO3N0cm9rZS13aWR0aDoxMDA7c3Ryb2tlLWxpbmVjYXA6cm91bmQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjQ7c3Ryb2tlLWRhc2hhcnJheTpub25lO3N0cm9rZS1vcGFjaXR5OjEiCiAgICAgICBkPSJtIDEwNC4zMzA3MSw3MDQuNTA1MSA1MDAsMCIKICAgICAgIGlkPSJwYXRoNDEzNi01IgogICAgICAgaW5rc2NhcGU6Y29ubmVjdG9yLWN1cnZhdHVyZT0iMCIKICAgICAgIGlua3NjYXBlOnRyYW5zZm9ybS1jZW50ZXIteD0iNzEuNDI4NTcyIgogICAgICAgaW5rc2NhcGU6dHJhbnNmb3JtLWNlbnRlci15PSItMjQyLjg1NzE2IiAvPgogICAgPHBhdGgKICAgICAgIHN0eWxlPSJmaWxsOm5vbmU7ZmlsbC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlOiMwMDAwMDA7c3Ryb2tlLXdpZHRoOjEwMDtzdHJva2UtbGluZWNhcDpyb3VuZDtzdHJva2UtbGluZWpvaW46cm91bmQ7c3Ryb2tlLW1pdGVybGltaXQ6NDtzdHJva2UtZGFzaGFycmF5Om5vbmU7c3Ryb2tlLW9wYWNpdHk6MSIKICAgICAgIGQ9Im0gMTA0LjMzMDcxLDkzOS41MDUwNiA1MDAsMCIKICAgICAgIGlkPSJwYXRoNDEzNi01LTMiCiAgICAgICBpbmtzY2FwZTpjb25uZWN0b3ItY3VydmF0dXJlPSIwIgogICAgICAgaW5rc2NhcGU6dHJhbnNmb3JtLWNlbnRlci14PSI3MS40Mjg1NzIiCiAgICAgICBpbmtzY2FwZTp0cmFuc2Zvcm0tY2VudGVyLXk9Ii0yNDIuODU3MTYiIC8+CiAgPC9nPgo8L3N2Zz4K"
|
||
alt = "Table of contents" title = "Table of contents" />
|
||
</div>
|
||
<h2 class="author">Élisabeth Henry</h2>
|
||
<h1 id = "link-0" class="title" >Crowbook User Guide</h1>
|
||
|
||
</header>
|
||
|
||
<div id = "chapter-0" class = "chapter">
|
||
<h1 id = 'link-1'><span class = 'chapter-header'>Chapter 1</span><br />Crowbook</h1><p id = "para-1"><a href = "https://travis-ci.org/lise-henry/crowbook"><img src = "https://travis-ci.org/lise-henry/crowbook.svg?branch=master" title = "" alt = "Travis status" /></a> <a href = "https://ci.appveyor.com/project/lise-henry/crowbook"><img src = "https://ci.appveyor.com/api/projects/status/bnj1rg76khth0aia?svg=true" title = "" alt = "Appveyor status" /></a></p>
|
||
<p id = "para-2"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Crowbook</span>’s aim is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> allow you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> write a book in Markdown without worrying about formatting or typography, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> let the program <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">generate</span> HTML, PDF <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> EPUB output for you. Its focus is novels <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> fiction, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> the default settings should (hopefully) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">generate</span> readable books with correct typography without requiring you to worry about it.</p>
|
||
<h2 id = "link-2">1.1. Example</h2>
|
||
<p id = "para-3"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">To</span> see what Crowbook’s output looks like, you can read the Crowbook guide rendered in <a href = "http://lise-henry.github.io/crowbook/book/book.html">HTML</a>, <a href = "http://lise-henry.github.io/crowbook/book/book.pdf">PDF</a> or <a href = "http://lise-henry.github.io/crowbook/book/book.epub">EPUB</a>.</p>
|
||
<p id = "para-4">You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> also play with the <a href = "http://vps.crowdagger.fr/crowbook/">online demo version</a>.</p>
|
||
<h2 id = "link-3">1.2. Installing</h2>
|
||
<p id = "para-5">There are two ways to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">install</span> Crowbook: either <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">using</span> precompiled binaries, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> compiling it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">using</span> <code>cargo</code>.</p>
|
||
<h3 id = "link-4"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Binaries</h3>
|
||
<p id = "para-6">See <a href = "https://github.com/lise-henry/crowbook/releases">the releases page</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> download a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">precompiled</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">binary</span> for your architecture (currently: Linux, Windows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> MacOSX). Just extract the archive <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> run <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>crowbook</code> (or <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span>.exe</code> on Windows). You might also want to copy the binary somewhere in your <code>PATH</code> for later usage.</p>
|
||
<p id = "para-7">If you are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">on</span> Debian GNU/Linux or Ubuntu (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">on</span> a PC architecture), you can also download <code>.deb</code> packages <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">on</span> <a href = "https://github.com/lise-henry/crowbook/releases">the releases page</a>.</p>
|
||
<h3 id = "link-5">Using Cargo</h3>
|
||
<p id = "para-8"><a href = "https://crates.io/">Cargo</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> the <a href = "https://www.rust-lang.org/">Rust</a>’s <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">package</span> manager. You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> <a href = "https://www.rust-lang.org/downloads.html">install it here</a>. Once it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> done:</p>
|
||
<pre><span style="color:#839496;">$ cargo </span><span style="color:#859900;">install</span><span style="color:#839496;"> crowbook
|
||
</span></pre><p id = "para-9"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> automatically download the latest <code>crowbook</code> release <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> <a href = "https://crates.io/crates/crowbook">crates.io</a>, compile it, and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">install</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> your system.</p>
|
||
<blockquote><p id = "para-10">Some dependencies <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">also</span> require <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">building</span> C libraries; you might thus <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">also</span> need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">install</span> a C <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">compiler</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>make</code>/<code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>cmake</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">build</span> tools. You can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">also</span> try <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">build</span> a version of Crowbook without optional <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">features</span>: <code>cargo <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">install</span> crowbook --no-default-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">features</span> --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">features</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>clap<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code> will disable syntactic highlighting and proofreading, requiring <span title = "Did you mean 'fewer'? The noun dependencies is countable." class = "grammar-error">less</span> dependencies.</p>
|
||
</blockquote>
|
||
<h2 id = "link-6">1.3. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Dependencies</h2>
|
||
<p id = "para-11">While there should <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span>, strictly speaking, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">no</span> real <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">dependencies</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> able <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> run Crowbook (it is published as a statically compiled binary), some features require additional commands <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> work correctly:</p>
|
||
<ul>
|
||
<li>EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">requires</span> the <code>zip</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">command</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> be present on your system;</li>
|
||
<li>PDF <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">requires</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">working</span> installation of LaTeX (preferably <code>xelatex</code>).</li>
|
||
</ul>
|
||
<h2 id = "link-7">1.4. Quick tour</h2>
|
||
<p id = "para-12">The simplest <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">command</span> is:</p>
|
||
<pre><span style="color:#839496;">$ crowbook </span><span style="color:#859900;"><</span><span style="color:#839496;">BOOK</span><span style="color:#859900;">></span><span style="color:#839496;">
|
||
</span></pre><p id = "para-13"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span title = "“where” at the beginning of a sentence requires a 2nd clause. Maybe a comma, question or exclamation mark is missing, or the sentence is incomplete and should be joined with the following sentence. " class = "grammar-error"></span>where</span> <code>BOOK</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>. Crowbook will parse this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> generate HTML, EPUB, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span>/or PDF output formats, according to the settings in the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>.</p>
|
||
<p id = "para-14"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">To</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">create</span> a new book, assuming you have a list of Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span>, you can generate a template <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> with the <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">create</span></code> argument:</p>
|
||
<pre><span style="color:#839496;">$ crowbook my.book --create chapter_</span><span style="color:#859900;">*</span><span style="color:#839496;">.md
|
||
</span></pre><p id = "para-15"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> will <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">generate</span> a default <code>my.book</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>, which you’ll need to complete. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> contains some metadata, options, and lists the Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span>.</p>
|
||
<p id = "para-16">For short <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">books</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">containing</span> only a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span> Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>, it is possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> embed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">metadata</span> at the beginning of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> use the <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span></code> or <code>-s</code> option <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> run <code>crowbook</code> directly on this Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> avoid creating a separate book configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>:</p>
|
||
<pre><span style="color:#839496;">$ crowbook -s text.md
|
||
</span></pre><p id = "para-17">For more information, see the chapters <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">on</span> <a href = "#chapter-1">the arguments supported by <code>crowbook</code></a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">on</span> <a href = "#chapter-2">the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span></a>.</p>
|
||
<h2 id = "link-8">1.5. Current features</h2>
|
||
<h3 id = "link-9">Output formats</h3>
|
||
<p id = "para-18"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Crowbook</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">supports</span> HTML, PDF <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> EPUB (either version 2 or 3) as <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">formats</span>. See the Crowbook User Guide rendered in <a href = "http://lise-henry.github.io/crowbook/book/book.html">HTML</a>, <a href = "http://lise-henry.github.io/crowbook/book/book.epub">EPUB</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <a href = "http://lise-henry.github.io/crowbook/book.pdf">PDF</a>.</p>
|
||
<h3 id = "link-10">Input <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">format</span></h3>
|
||
<p id = "para-19">Crowbook uses <a href = "https://crates.io/crates/pulldown-cmark">pulldown-cmark</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> thus should support most of <a href = "http://commonmark.org/">CommonMark Markdown</a>. Inline HTML, however, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> not implemented, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> probably won’t <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span>, as the goal <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> to have books that can also <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> generated in PDF (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> maybe ODT).</p>
|
||
<h3 id = "link-11">Typographic <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>cleaning<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></h3>
|
||
<p id = "para-20"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Maybe</span> the most specific <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>feature<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> of Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> it does its best <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>clean<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> the input text before rendering it. By default, it removes superfluous spaces and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tries</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> use curly quotes. If the book’s language <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">french</span>, it also <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tries</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> respect <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">french</span> typography by replacing spaces with non-breaking ones when it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> appropriate (e.g. before ‘?’, ‘!’, ‘;’ or ‘:’).</p>
|
||
<blockquote><p id = "para-21">Please <a href = "https://github.com/lise-henry/crowbook/issues/new">open an issue</a> describing <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">typographic</span> rules if you want them to be implemented for other languages.</p>
|
||
</blockquote>
|
||
<h3 id = "link-12">Links handling</h3>
|
||
<p id = "para-22">Crowbook tries <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> correctly translate local <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">links</span> in the input Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>: e.g. if you have a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">link</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> a Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> that is part of your book, it will be transformed into a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">link</span> inside the document.</p>
|
||
<h3 id = "link-13">Inline YAML blocks</h3>
|
||
<p id = "para-23">Crowbook supports <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span> YAML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span>:</p>
|
||
<pre><span style="color:#839496;">---</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Me</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">My title</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">---</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-24">This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> mostly useful when Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> run with the <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span></code> argument (receiving a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span> Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> instead of a book configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>), for short texts that only contain one <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>chapter<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.</p>
|
||
<h3 id = "link-14">Proofreading</h3>
|
||
<p id = "para-25">Crowbook can also generate <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>proofreading<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> copies in HTML or PDF, highlighting grammar errors and repetitions. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">For</span> more information, see <a href = "#chapter-5">the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">proofreading</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> of the guide</a>.</p>
|
||
<h3 id = "link-15">Interactive fiction</h3>
|
||
<p id = "para-26">Crowbook has experimental support <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> writing <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">interactive</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">fiction</span> (only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> HTML). <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">For</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">more</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">information</span>, read the <a href = "#chapter-6"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">interactive</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">fiction</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span></a>.</p>
|
||
<h3 id = "link-16">Customization</h3>
|
||
<p id = "para-27">While the default settings will hopefully generate something that should look <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>good enough<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, it is possible to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">customize</span> the output, essentially by providing different <a href = "#chapter-4">templates</a>.</p>
|
||
<h3 id = "link-17">Bugs</h3>
|
||
<p id = "para-28">See the <a href = "https://github.com/lise-henry/crowbook/issues">github’s issue tracker</a>.</p>
|
||
<h2 id = "link-18">1.6. Contributors</h2>
|
||
<ul>
|
||
<li><a href = "http://stephanemourey.fr/">Stéphane Mourey</a> <code><s+crowbook AT stephanemourey DOT fr></code></li>
|
||
<li><a href = "https://github.com/hirschenberger">Falco Hirschenberger</a></li>
|
||
</ul>
|
||
<h2 id = "link-19">1.7. Acknowledgements</h2>
|
||
<p id = "para-29">Besides the <a href = "https://www.rust-lang.org/">Rust</a> compiler and standard <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">library</span>, Crowbook uses the following <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">libraries</span>: <a href = "https://crates.io/crates/pulldown-cmark">pulldown-cmark</a>, <a href = "https://crates.io/crates/yaml-rust">yaml-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rust</span></a>, <a href = "https://crates.io/crates/mustache">mustache</a>, <a href = "https://github.com/kbknapp/clap-rs">clap</a>, <a href = "https://crates.io/crates/chrono">chrono</a>, <a href = "https://crates.io/crates/uuid">uuid</a>, <a href = "https://crates.io/crates/mime_guess">mime_guess</a>, <a href = "https://crates.io/crates/crossbeam">crossbeam</a>, <a href = "https://crates.io/crates/walkdir">walkdir</a>, <a href = "https://crates.io/crates/rustc-serialize"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rustc</span>-serialize</a>, <a href = "https://crates.io/crates/caribon">caribon</a>, <a href = "https://crates.io/crates/hyper">hyper</a>, <a href = "https://crates.io/crates/url">url</a>, <a href = "https://crates.io/crates/lazy_static">lazy_static</a>, <a href = "https://crates.io/crates/regex">regex</a>, <a href = "https://crates.io/crates/term">term</a>, <a href = "https://crates.io/crates/numerals">numerals</a>, <a href = "https://crates.io/crates/syntect">syntect</a>.</p>
|
||
<p id = "para-30">It can also embed <a href = "https://highlightjs.org/">Highlight.js</a> in HTML output to enable syntax highlighting for code blocks.</p>
|
||
<p id = "para-31">It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">uses</span> configuration files from <a href = "https://github.com/japaric/rust-everywhere">rust-everywhere</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> <a href = "https://travis-ci.org/">Travis</a> and <a href = "http://www.appveyor.com/">Appveyor</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> generate binaries <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> various platforms on each release.</p>
|
||
<p id = "para-32">While Crowbook directly doesn’t <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> them, there was also inspiration from <a href = "http://pandoc.org/">Pandoc</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <a href = "https://github.com/azerupi/mdBook">mdBook</a>.</p>
|
||
<p id = "para-33"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Also</span>, the <a href = "https://validator.w3.org/">W3C HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">validator</span></a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> the <a href = "http://validator.idpf.org/">IDPF EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">validator</span></a> prove very <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">useful</span> during development <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> testing.</p>
|
||
<h2 id = "link-20">1.8. ChangeLog</h2>
|
||
<p id = "para-34">See <a href = "#chapter-9">ChangeLog</a>.</p>
|
||
<h2 id = "link-21">1.9. Contributing</h2>
|
||
<p id = "para-35"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">See</span> <a href = "#chapter-8">how you can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contribute</span> to Crowbook</a>.</p>
|
||
<p id = "para-36">If you find this project <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">useful</span>, you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> also support its author by <a href = "https://www.paypal.me/crowdagger">making a Paypal donation</a>.</p>
|
||
<h2 id = "link-22">1.10. Library</h2>
|
||
<p id = "para-37">While the main purpose of Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> be run <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> a standalone program, the code <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> written <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">library</span>, so if you want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> build <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> it you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> use it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> such. You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> look at the generated documentation <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> <a href = "https://docs.rs/releases/search?query=crowbook">docs.rs</a>.</p>
|
||
<p id = "para-38">Note that, in order <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> facilitate code reuse, some features have been split <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> separate libraries:</p>
|
||
<ul>
|
||
<li><a href = "https://github.com/lise-henry/epub-builder"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"></span>epub-builder</a> makes it easier <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> generate EPUB files.</li>
|
||
<li><a href = "https://github.com/lise-henry/crowbook-text-processing/"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span>-text-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">processing</span></a> contains all the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>typographic<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> functions (smart quotes, handling of non-breaking spaces in french, ...).</li>
|
||
<li><a href = "https://github.com/lise-henry/crowbook-intl/"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span>-intl</a> is used for the internationalization (translation) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">process</span>.</li>
|
||
</ul>
|
||
<h2 id = "link-23">1.11. License</h2>
|
||
<p id = "para-39"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Crowbook</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> free software: you can redistribute it and/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> modify it under the terms of the GNU Lesser General Public License (LGPL), <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">version</span> 2.1 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> (at your option) any ulterior <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">version</span>. See <a href = "#chapter-10">LICENSE</a> for more information.</p>
|
||
<p id = "para-40">Crowbook’s <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">logo</span> is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">licensed</span> under the <a href = "https://creativecommons.org/licenses/by/4.0/deed.en">Creative Commons Attribution 4.0 International <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">license</span></a>, based on the <a href = "https://commons.wikimedia.org/wiki/File:Rust_programming_language_black_logo.svg">Rust <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">logo</span></a> by Mozilla Corporation.</p>
|
||
<p id = "para-41"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Crowbook</span> includes binary (minified) CSS and Javascript files from <a href = "https://highlightjs.org/">Highlight.js</a>, written <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> Ivan Sagalaev, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">licensed</span> under the following terms:</p>
|
||
<blockquote><p id = "para-42">Copyright <span title = "This notation is nonstandard, use this symbol instead: '©'" class = "grammar-error">(c)</span> 2006, Ivan Sagalaev</p>
|
||
<p id = "para-43">All rights reserved.</p>
|
||
<p id = "para-44"><span title = "Add a space between sentences" class = "grammar-error">Redistribution</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> use in <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">source</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> binary forms, with or without modification, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> permitted provided that the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">following</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">conditions</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> met:</p>
|
||
<ul>
|
||
<li>Redistributions of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">source</span> code <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">must</span> retain the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">above</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copyright</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">notice</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">conditions</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">following</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">disclaimer</span>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Redistributions</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> binary form <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">must</span> reproduce the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">above</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copyright</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">notice</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">conditions</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">following</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">disclaimer</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the documentation <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> other materials provided with the distribution.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Neither</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">name</span> of highlight.js nor the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">names</span> of its contributors may be used to endorse <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> promote products derived from <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> software without specific prior written permission.</li>
|
||
</ul>
|
||
<p id = "para-45"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">THIS</span> SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS <span title = "Use a smart opening quote here: '“'." class = "grammar-error">``</span>AS IS’’ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
|
||
</blockquote>
|
||
|
||
</div><div id = "chapter-1" class = "chapter">
|
||
<h1 id = 'link-24'><span class = 'chapter-header'>Chapter 2</span><br />Arguments</h1><p id = "para-46">Crowbook can take a number of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">arguments</span>, generally in the form:</p>
|
||
<pre><span style="color:#839496;">crowbook [OPTIONS] [BOOK]
|
||
</span></pre><p id = "para-47">The <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">most</span> important <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">argument</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> obviously the book configuration file. It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> mandatory <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">most</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cases</span>: if you don’t <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">pass</span> it, Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> simply display an error. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">In</span> a normal use <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">case</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> the only argument you’ll need to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">pass</span>, as most options <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> be set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> configuration file.</p>
|
||
<p id = "para-48">It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span>, however, possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">pass</span> more <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">arguments</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code>crowbook</code>:</p>
|
||
<h2 id = "link-25">2.1. <code>--create</code></h2>
|
||
<p id = "para-49"><b>Usage</b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> [BOOK] --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">create</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>_1.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">md</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>_2.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">md</span> ...</code></p>
|
||
<p id = "para-50">(or <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">crowbook</span> [BOOK] -c <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>_1.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">md</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>_2.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">md</span> ...</code>)</p>
|
||
<p id = "para-51"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Creates</span> a new <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> from a list of Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span>. It will generate a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> with all <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> names <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specified</span> as chapters. It either prints the result to stdout (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> <code>BOOK</code> is not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specified</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> generate the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <code>BOOK</code> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> abort <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> it already exists).</p>
|
||
<pre><span style="color:#839496;">crowbook foo.book --create chapter_1.md chapter_2.md chapter_3.md
|
||
</span></pre><p id = "para-52"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> thus <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">generate</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <code>foo.book</code> containing:</p>
|
||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Your name</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Your title</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">lang</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">en</span><span style="color:#839496;">
|
||
|
||
</span><span style="color:#586e75;">#</span><span style="color:#586e75;"># Output formats
|
||
|
||
# Uncomment and fill to generate files
|
||
# output.html: some_file.html
|
||
# output.epub: some_file.epub
|
||
# output.pdf: some_file.pdf
|
||
|
||
# Or uncomment the following to generate PDF, HTML and EPUB files based on this file's name
|
||
# output: [pdf, epub, html]
|
||
|
||
# Uncomment and fill to set cover image (for EPUB)
|
||
# cover: some_cover.png
|
||
|
||
## List of chapters
|
||
+ chapter_1.md
|
||
+ chapter_2.md
|
||
+ chapter_3.md
|
||
</span></pre><p id = "para-53"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"></span>while</p>
|
||
<pre><span style="color:#839496;">crowbook --create chapter_1.md chapter_2.md chapter_3.md
|
||
</span></pre><p id = "para-54"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>will</span> print the same result, but to stdout (without creating a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>).</p>
|
||
<h2 id = "link-26">2.2. <code>--single</code></h2>
|
||
<p id = "para-55"><b>Usage</b>: <code>crowbook --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span> <FILE></code></p>
|
||
<p id = "para-56">(or <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> -s <FILE></code>)</p>
|
||
<p id = "para-57"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> argument allows you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> give <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>crowbook</code> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">single</span> Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contain</span> an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span> YAML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">block</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> set some book options. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Inline</span> YAML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span> must start and end with a line <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">containing</span> only <code>---</code> (three dashes). E.g:</p>
|
||
<pre><span style="color:#839496;">---</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Joan Doe</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">A short story</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">html</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">---</span><span style="color:#839496;">
|
||
|
||
</span><span style="color:#2aa198;">Content of the story in Markdown.</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-58">If this YAML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">block</span> is not at the beginning of a file, it must also be preceded by a blank line.</p>
|
||
<p id = "para-59"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> allows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">have</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> write a <code>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> for a short story or an article. <code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">crowbook</span> -s foo.md</code> is rougly equivalent <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">having</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> containing:</p>
|
||
<pre><span style="color:#268bd2;">!</span><span style="color:#839496;"> </span><span style="color:#2aa198;">foo.md</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-60">That <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span>, the chapter heading (if any) won’t be displayed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the output documents (though they still appear <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the TOC).</p>
|
||
<blockquote><p id = "para-61">Note <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">default</span>, using <code>--single</code> or <code>-s</code> sets the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">default</span> LaTeX class of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> to <code>article</code> instead of <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>book</code>.</p>
|
||
</blockquote>
|
||
<h2 id = "link-27">2.3. <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span></code></h2>
|
||
<p id = "para-62"><b>Usage</b>: <code>crowbook <BOOK> --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> [KEY] [VALUE]...</code></p>
|
||
<p id = "para-63">This argument takes a list of<span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span><code>KEY</code> <code>VALUE</code> pairs and allows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">setting</span> or overriding a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span>. All <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">valid</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> in the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">valid</span> as keys. For more information, see <a href = "#chapter-2">the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span></a>.</p>
|
||
<pre><span style="color:#839496;">$ crowbook foo.book --</span><span style="color:#859900;">set</span><span style="color:#839496;"> tex.paper.size a4paper
|
||
</span></pre><p id = "para-64"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">override</span> the paper size <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> PDF generation.</p>
|
||
<h2 id = "link-28">2.4. <code>--list-options</code></h2>
|
||
<p id = "para-65"><b>Usage</b>: <code>crowbook --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span></code></p>
|
||
<p id = "para-66">(or <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> -l</code>)</p>
|
||
<p id = "para-67">Displays all the valid <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">options</span> that can be used, whether <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> a book configuration file, with <code>--set</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> an inline YAML block.</p>
|
||
<h2 id = "link-29">2.5. <code>--print-template</code></h2>
|
||
<p id = "para-68"><b>Usage</b>: <code>crowbook --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">print</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> <TEMPLATE></code></p>
|
||
<p id = "para-69"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Prints</span> the built-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> stdout. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Useful</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">want</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> customize the appearance of your document. E.g., <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">want</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> modify the CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">used</span> for HTML rendering:</p>
|
||
<pre><span style="color:#839496;">$ crowbook --print-template html.css </span><span style="color:#859900;">></span><span style="color:#839496;"> my_style.css
|
||
</span><span style="color:#586e75;">#</span><span style="color:#586e75;"> edit my_style.css in your favourite editor
|
||
</span><span style="color:#839496;">$ crowbook my.book --</span><span style="color:#859900;">set</span><span style="color:#839496;"> html.css my_style.css
|
||
</span><span style="color:#586e75;">#</span><span style="color:#586e75;"> or add "html.css: my_style.css" in my.book
|
||
</span></pre><h2 id = "link-30">2.6. <code>--stats</code></h2>
|
||
<p id = "para-70"><b>Usage</b>: <code>crowbook --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stats</span> <BOOK></code></p>
|
||
<p id = "para-71">(or <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> -S <BOOK></code>)</p>
|
||
<p id = "para-72">Display some statistics (word and character counts) about the book.</p>
|
||
<h2 id = "link-31">2.7. <code>--proofread</code></h2>
|
||
<p id = "para-73"><b><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Usage</b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">crowbook</span> --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">proofread</span> <BOOK></code></p>
|
||
<p id = "para-74">(<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">crowbook</span> -p <BOOK></code>)</p>
|
||
<p id = "para-75">Equivalent to <code>--set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span> true</code>. Enable <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofreading</span>. See <a href = "#chapter-5">Proofreading</a>.</p>
|
||
<h2 id = "link-32">2.8. <code>--verbose</code></h2>
|
||
<p id = "para-76"><b><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>Usage</b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">crowbook</span> <BOOK> --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">verbose</span></code></p>
|
||
<p id = "para-77">If this flag is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span>, Crowbook will print more warnings it detects while parsing and rendering.</p>
|
||
<h2 id = "link-33">2.9. <code>--to</code></h2>
|
||
<p id = "para-78"><b><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>Usage</b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">crowbook</span> <BOOK> --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> [FORMAT]</code></p>
|
||
<p id = "para-79">(or <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">crowbook</span> <BOOK> -t [FORMAT]</code>)</p>
|
||
<p id = "para-80">Generate only the specified <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">format</span>. <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>FORMAT</code> must be either <code>epub</code>, <code>pdf</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>html</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.dir</code>, <code>odt</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code>tex</code>.</p>
|
||
<p id = "para-81">If an output <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> for the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">format</span> is not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specified</span> in the book configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>, <code>crowbook</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> fail <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> render PDF, ODT <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> EPUB, whereas it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> print HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> TeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> on stdout. It is, however, possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> specify a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> with the <code>--output</code> option.</p>
|
||
<h3 id = "link-34">Examples</h3>
|
||
<pre><span style="color:#839496;">crowbook --to html foo.book
|
||
</span></pre><p id = "para-82"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>will</span> generate some HTML, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> prints it either <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">specified</span> by <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span>.html</code> in <code>foo.book</code>, or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> stdout if it is not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">specified</span>.</p>
|
||
<pre><span style="color:#839496;">crowbook --to pdf --output foo.pdf foo.book
|
||
</span></pre><p id = "para-83"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> generate a <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span>.pdf</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>.</p>
|
||
<h2 id = "link-35">2.10. <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">output</span></code></h2>
|
||
<p id = "para-84"><b>Usage</b>: <code>crowbook <BOOK> --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <FORMAT> --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> <FILE></code></p>
|
||
<p id = "para-85">(<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> -t <FORMAT> -o <FILE> <BOOK></code>)</p>
|
||
<p id = "para-86"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">Specifies</span> an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>. Only valid when <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span></code> is used.</p>
|
||
<h2 id = "link-36">2.11. <code>--lang</code></h2>
|
||
<p id = "para-87"><b>Usage</b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">crowbook</span> --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">lang</span> <LANG></code></p>
|
||
<p id = "para-88">(<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">crowbook</span> -L <LANG></code>)</p>
|
||
<p id = "para-89">Set the runtime <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> Crowbook. Currently, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">only</span> a french translation <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> available. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">By</span> default, Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">uses</span> the <code>LANG</code> environment variable <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> determine which <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span>, but this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span> allows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> override it (e.g. for operating systems that don’t <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">such</span> an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">such</span> as Windows).</p>
|
||
<h3 id = "link-37">Example</h3>
|
||
<p id = "para-90"><code>$ crowbook --lang fr --help</code></p>
|
||
<p id = "para-91"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> display Crowbook’s <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">help</span> message in french.</p>
|
||
<blockquote><p id = "para-92">Note <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> this argument has nothing to do with the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>lang</code> option <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> you can set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> configuration file, which <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specifies</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span> <em>of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span></em>. This argument <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specifies</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span> of the text messages that Crowbook will display while running, but has no effect on the generated documents.</p>
|
||
</blockquote>
|
||
|
||
</div><div id = "chapter-2" class = "chapter">
|
||
<h1 id = 'link-38'><span class = 'chapter-header'>Chapter 3</span><br />The configuration file</h1><p id = "para-93">If you want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> use Crowbook for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span>, this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> is all you’ll have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> add, beside the Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">files</span> containing the text of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span>.</p>
|
||
<p id = "para-94">The format <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> not very complicated. This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> an example of it:</p>
|
||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> metadata
|
||
author: Joan Doe
|
||
title: Some book
|
||
lang: en
|
||
|
||
output: [html, pdf, epub]
|
||
|
||
# list of chapters
|
||
- preface.md
|
||
+ chapter_1.md
|
||
+ chapter_2.md
|
||
+ chapter_3.md
|
||
+ chapter_4.md
|
||
- epilogue.md
|
||
</span></pre><p id = "para-95">Basically, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> divided in two parts:</p>
|
||
<ul>
|
||
<li><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">a</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span> of options, under the form <code>key: value</code>, following YAML syntax.</li>
|
||
<li>a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span> of Markdown files.</li>
|
||
</ul>
|
||
<p id = "para-96">Lines starting with the <code>#</code> characters <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> comments and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> discarded.</p>
|
||
<h2 id = "link-39">3.1. Configuration in an inline YAML block</h2>
|
||
<p id = "para-97">Sometimes, you only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">have</span> one Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> might not want to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">have</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">separate</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">In</span> this case, you can specify options at the beginning of your Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>, using an inline YAML block, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">separated</span> by two lines containing only <code>---</code>:</p>
|
||
<pre><span style="color:#839496;">---</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">author: Joan Doe
|
||
title: Some (short) book
|
||
lang: en
|
||
</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">output: [html, pdf, epub]
|
||
</span><span style="color:#b58900;">---</span><span style="color:#839496;">
|
||
|
||
</span><span style="color:#b58900;">#</span><span style="color:#b58900;"> </span><span style="color:#cb4b16;">Some (short) book</span><span style="color:#b58900;">
|
||
|
||
</span><span style="color:#839496;">The book content, formatted in Markdown.
|
||
</span></pre><p id = "para-98"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">This</span> method <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">only</span> allows to set up options: you can’t <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">include</span> a list of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapters</span> in <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> way, since the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">only</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>chapter<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> that will be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">included</span> is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> Markdown file itself.</p>
|
||
<p id = "para-99">You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> then use</p>
|
||
<pre><span style="color:#839496;">crowbook -s some_book.md
|
||
</span></pre><p id = "para-100"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">to</span> generate output formats from <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>.</p>
|
||
<blockquote><p id = "para-101"><span title = "Did you mean: 'By default,'?" class = "grammar-error">By default</span> (unless <code>input.yaml_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> true), Crowboook will only read those inline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span> when it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> runned with <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> --single</code> (or <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> -s</code>).</p>
|
||
</blockquote>
|
||
<h2 id = "link-40">3.2. The list of files</h2>
|
||
<p id = "para-102">There are various options to include a Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>.</p>
|
||
<ul>
|
||
<li><code>+ <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">name</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">md</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">includes</span> a numbered <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>.</li>
|
||
<li><code>- <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">name</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">md</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">includes</span> an unnumbered <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>.</li>
|
||
<li><code>! <span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">name</span></span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">md</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">includes</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> whose title won’t be displayed (except in the table of contents); this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> useful <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> e.g. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">including</span> a copyright at the beginning <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> the book, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> short stories <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">where</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">there</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> only one <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>.</li>
|
||
<li><code>42. <span title = "This sentence does not start with an uppercase letter" class = "grammar-error">file_name</span>.md</code> specifies the number <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>.</li>
|
||
<li><code>@</code> includes a part instead of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>.</li>
|
||
</ul>
|
||
<p id = "para-103">So a typical usage might look like this:</p>
|
||
<pre><span style="color:#268bd2;">!</span><span style="color:#839496;"> </span><span style="color:#2aa198;">copyright.md</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">preface.md</span><span style="color:#839496;">
|
||
</span><span style="color:#2aa198;">0. chapter_0.md</span><span style="color:#839496;"> </span><span style="color:#586e75;">#</span><span style="color:#586e75;"> We want to start at chapter 0 instead of 1
|
||
# Next chapters can be numbered automatically
|
||
+ chapter_1.md
|
||
+ chapter_2.md
|
||
...
|
||
</span></pre><p id = "para-104">There are two important things to note:</p>
|
||
<ol>
|
||
<li><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">you</span> must <em>not</em> use quotes around the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> names.</li>
|
||
<li>the paths of these <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">files</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> relative <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the directory where your configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> is. This means you can run <code>crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">books</span>/my_trilogy/first_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span>/config.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span></code> without being in the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span>’s directory.</li>
|
||
</ol>
|
||
<p id = "para-105"><span title = "Did you forget a comma after a conjunctive/linking adverb?" class = "grammar-error">Also</span> <span title = "Consider using third-person verb forms for singular and mass nouns: 'notes'." class = "grammar-error">note</span> that you don’t have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> specify a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">title</span>. This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> because the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">title</span> of the chapter <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> inferred from the Markdown document. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">To</span> go back <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> our previous example:</p>
|
||
<pre><span style="color:#839496;">+ chapter_1.md
|
||
</span></pre><p id = "para-106"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">does</span> not specify a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">title</span>, because it will read it directly in <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>_1.md</code>, e.g.:</p>
|
||
<pre><span style="color:#b58900;">#</span><span style="color:#b58900;"> </span><span style="color:#cb4b16;">The day I was born</span><span style="color:#b58900;"> </span><span style="color:#b58900;">#</span><span style="color:#b58900;">
|
||
</span><span style="color:#839496;">...
|
||
</span></pre><p id = "para-107">Ideally, you should <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">have</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">one</span> and only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">one</span> level-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">one</span> header (i.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">e</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> title) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> each Markdown file. If you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">have</span> more than <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">one</span>, it might mess with the table of contents <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> some cases (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">e</span>.g. for EPUB).</p>
|
||
<h3 id = "link-41">Parts</h3>
|
||
<p id = "para-108"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Parts</span> are included using the <code>@</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">character</span>, followed by the same <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">characters</span> than <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> chapters:</p>
|
||
<pre><span style="color:#839496;">@+ numbered_part.md
|
||
+ chapter_01.md
|
||
+ chapter_02.md
|
||
@- unnumbered_part.md
|
||
+ chapter_03.md
|
||
+ chapter_04.md
|
||
@42. part_with_number_42.md
|
||
+ chapter_05.md
|
||
</span></pre><p id = "para-109">However, you usually don’t really want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> have a content directly below the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>, only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapters</span> (though it can be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">useful</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> add an introduction before the first <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>), so there is also a more straighforward way <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">parts</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">using</span> only the <code>@</code> character followed by the (markdown-formatted) title of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>:</p>
|
||
<pre><span style="color:#839496;">@ Beginning
|
||
+ chapter_01.md
|
||
+ chapter_02.md
|
||
@ Middle
|
||
+ chapter_03.md
|
||
+ chapter_04.md
|
||
@ Appendix
|
||
- notes.md
|
||
</span></pre><p id = "para-110">With <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">this</span> shortcut, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">parts</span> are always numbered.</p>
|
||
<h3 id = "link-42">Subchapters</h3>
|
||
<p id = "para-111">If you write your book <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> be rendered <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> Crowbook, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> better <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> have one Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> per chapter. It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span>, however, possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> work with divisions at lower levels. In order <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> properly include these <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>, you can use the following syntax:</p>
|
||
<pre><span style="color:#839496;">-- section.md
|
||
--- subsection.md
|
||
---- subsubsection.md
|
||
</span></pre><blockquote><p id = "para-112">Note that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">there</span> isn’t different <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">syntax</span> for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">numbered</span> or unnumbered sections/subsections: you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> only change the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">numbering</span> scheme at the chapter level.</p>
|
||
</blockquote>
|
||
<p id = "para-113">When <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">including</span> those files, Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">include</span> them in the table of content as part of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">previous</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> (or section for subsections, and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">so</span> on). It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">will</span> also adjust the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">header</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">levels</span> of the Markdown files, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">so</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">previous</span> example, a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">level</span>-1 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">header</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> <code>section.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">md</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">will</span> be displayed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">level</span>-2 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">header</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> the book, and a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">level</span>-1 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">header</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> <code>subsection.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">md</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">level</span>-3 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">header</span>.</p>
|
||
<blockquote><p id = "para-114">This can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cause</span> issues <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> only six <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">levels</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">headers</span> are supported; hence, if you include a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">level</span>-5 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">header</span> in <code>subsubsection.md</code>, it will <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cause</span> an error.</p>
|
||
</blockquote>
|
||
<h2 id = "link-43">3.3. Crowbook options</h2>
|
||
<p id = "para-115">The first part of the configuration file <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> dedicated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> pass <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> Crowbook. This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <a href = "https://en.wikipedia.org/wiki/YAML">YAML syntax</a>, so each line should be of the form <code>key: value</code>. Note that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> most cases you don’t have to put string <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> quotes, e.g.:</p>
|
||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">My title</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-116">It is however possible (and sometimes necessary) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> escape some characters using <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">quotes</span> around <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">strings</span>:</p>
|
||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">My: title!</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-117">It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">possible</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> multiline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">strings</span> with <code>>-</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> then indenting the lines that are part of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">string</span>:</p>
|
||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#859900;">></span><span style="color:#93a1a1;">-</span><span style="color:#839496;">
|
||
</span><span style="color:#2aa198;"> A
|
||
long
|
||
title
|
||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">Joan Doe</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-118"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> set <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>title</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>A long <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">title</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code>. See <a href = "https://en.wikipedia.org/wiki/YAML#Block_literals">block literals in YAML</a> for more information on the various <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">way</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">insert</span> multiline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">strings</span> (which mostly change the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">way</span> newlines will or won’t be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inserted</span>).</p>
|
||
<p id = "para-119">A final note <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> the syntax: all options must <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> set <em>before</em> the first chapter inclusion (that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span>, a line beginning with ‘+’, ‘-’, '<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">x</span>.’ (where <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>x</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> a number) or ‘!’).</p>
|
||
<h3 id = "link-44">Metadata</h3>
|
||
<p id = "para-120"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Metadata</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> data about the book. Except for <code>cover</code>, which points to an image file, all its fields <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> strings. The main <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">metadata</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span>:</p>
|
||
<ul>
|
||
<li><code>author</code></li>
|
||
<li><code>title</code></li>
|
||
<li><code>subtitle</code></li>
|
||
<li><code>lang</code>, the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span>. The unicode <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span> code should be used, e.g. <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">en</span>_GB</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>en</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fr</span>_FR</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>fr</code>...</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>cover</code>, a path to an image file for the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cover</span> of the book (not displayed in all output formats).</li>
|
||
</ul>
|
||
<p id = "para-121">There are also additional metadata:</p>
|
||
<ul>
|
||
<li><code>subject</code></li>
|
||
<li><code>description</code></li>
|
||
<li><code>license</code></li>
|
||
<li><code>version</code></li>
|
||
<li><code>date</code></li>
|
||
</ul>
|
||
<p id = "para-122">You can define your own <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">metadata</span> by starting an option name with <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">metadata</span>.foo</code>.</p>
|
||
<p id = "para-123"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">All</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span> <span title = "Possible agreement error - use third-person verb forms for singular and mass nouns: 'is'." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>are</span> accessible from templates, see <a href = "#chapter-4">Templates</a>.</p>
|
||
<h3 id = "link-45">The <code>import</code> special <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span></h3>
|
||
<p id = "para-124">The <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">special</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>import</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">option</span> allows you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> include the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">options</span> of another <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span> configuration file. E.g., assuming that you want some <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">common</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">options</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> be applied <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> both <code>foo.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span></code> and <code>bar.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span></code>, you can create a <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">common</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span></code> file:</p>
|
||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Joan Doe</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">lang</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">en</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">license</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">Copyright (C) Joan Doe. All rights reserved.</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||
|
||
</span><span style="color:#268bd2;">html.header</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">[Joan Doe's website](http://joan-doe.com)</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_template.tex</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-125">You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> then include this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> in <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span></code>:</p>
|
||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">common.book</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">Foo</span><span style="color:#839496;">
|
||
|
||
</span><span style="color:#2aa198;">+ foo_01.md</span><span style="color:#839496;">
|
||
</span><span style="color:#2aa198;">+ foo_02.md</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-126">Or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">include</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">bar</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span></code>, but override some of its features:</p>
|
||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">common.book</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Bar</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">license</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">CC-BY-SA</span><span style="color:#839496;"> </span><span style="color:#586e75;">#</span><span style="color:#586e75;"> Override the license from common.book
|
||
|
||
+ bar_01.md
|
||
</span></pre><h3 id = "link-46">Output options</h3>
|
||
<p id = "para-127">These <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> specify which <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">files</span> to generate.</p>
|
||
<p id = "para-128">Note that all <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> paths are relative <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> the directory <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">where</span> the configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> is, not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> the one <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">where</span> you run <code>crowbook</code>. <span title = "“So if” at the beginning of a sentence requires a 2nd clause. Maybe a comma, question or exclamation mark is missing, or the sentence is incomplete and should be joined with the following sentence. " class = "grammar-error">So if</span> you set</p>
|
||
<pre><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">foo.epub</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-129"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">run</span></p>
|
||
<pre><span style="color:#839496;">$ crowbook some/</span><span style="color:#859900;">dir</span><span style="color:#839496;">/config.book
|
||
</span></pre><p id = "para-130"><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">foo</span>.epub</code> will be generated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <code>some/dir</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> your current directory.</p>
|
||
<p id = "para-131"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Crowbook</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> try <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">generate</span> each of the <code>output.xxx</code> files <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> are specified. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">That</span> means <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> you’ll have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> set at least one of those if you want a call <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span></p>
|
||
<pre><span style="color:#839496;">$ crowbook my.book
|
||
</span></pre><p id = "para-132"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">generate</span> anything. (It’s still possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">generate</span> a specific format, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> only this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">one</span>, by using the <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code>--output</code> argument on the command line).</p>
|
||
<p id = "para-133">Note that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">formats</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">depend</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">on</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">commands</span> being installed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">on</span> your system. Most notably, Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">depends</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">on</span> LaTeX (<code>xelatex</code> by default, though you can specify another <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">command</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> use with <code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">command</span></code>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> generate a PDF file, so PDF rendering won’t work if it is not installed on your system. Crowbook also uses the <code>zip</code> command to generate the EPUB and ODT files.</p>
|
||
<p id = "para-134">Current output options are:</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renders</span> a standalone HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.dir</code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renders</span> <span title = "Use 'an' instead of 'a' if the following word starts with a vowel sound, e.g. 'an article', 'an hour'" class = "grammar-error">a</span> HTML directory with one page by chapter.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.epub</code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renders</span> an EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tex</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renders</span> a LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.pdf</code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renders</span> a PDF <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> (using <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tex</span>.command</code>).</li>
|
||
</ul>
|
||
<p id = "para-135">(There are other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> options for generating proofreading <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">see</span> <a href = "#chapter-5">Proofreading</a>, and interactive <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fiction</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">see</span> <a href = "#chapter-6">Interactive <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fiction</span></a>.)</p>
|
||
<h4 id = "link-47">The <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>output</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span></h4>
|
||
<p id = "para-136">Setting <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> names manually <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> be a bit tedious, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> is not always necessary. You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> also specify a list of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> formats with the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>output</code> option:</p>
|
||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">html</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-137">This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> similar to the alternative syntax for YAML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span>:</p>
|
||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">html</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-138"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span> will set default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> path <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> PDF, EPUB and HTML according <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span> configuration file name. So, if your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span> is <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">my</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span></code> (or <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">my</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span>.md</code>), it will generate <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">my</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span>.pdf</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">my</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span>.html</code> and <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">my</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span>.epub</code>.</p>
|
||
<blockquote><p id = "para-139">You can also infer the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> file name by specifying <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>auto<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> to e.g. <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span></code>. The previous example is thus equivalent to</p>
|
||
<pre><span style="color:#268bd2;">output.pdf</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">auto</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">auto</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">output.html</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">auto</span><span style="color:#839496;">
|
||
</span></pre></blockquote>
|
||
<h4 id = "link-48"><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>output</span>.base_path</code></h4>
|
||
<p id = "para-140">Additionally, the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">path</span></code> option allows you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> set where the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> will be written (relatively <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the book configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>). E.g.,</p>
|
||
<pre><span style="color:#268bd2;">output.base_path</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">docs/book</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">book.epub</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-141"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>will</span> render the EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> in <code>docs/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span>.epub</code>.</p>
|
||
<h3 id = "link-49">Input options</h3>
|
||
<p id = "para-142">Crowbook does its best <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> improve the typography of your text. Default settings should be good enough for most usages, but you can enable/disable specific options:</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">input</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">clean</span></code> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">default</span>: <code>true</code>): if <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> to <code>false</code>, will <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">disable</span> all typographic <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>cleaning<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>. The algorithm <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> dependent on the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span>, though currently there <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> only a variant implemented <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> <code>fr</code> (french), dealing with the specific non-breaking spaces rules <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span>.</li>
|
||
<li><code>input.clean.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">smart</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">quotes</span></code> (default: <code>true</code>): if set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>false</code>, disable the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">smart</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">quote</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> feature, that (tries <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span>) replace straight <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">quotes</span> with curly ones. As it is <span title = "Use 'a' instead of 'an' if the following word doesn't start with a vowel sound, e.g. 'a sentence', 'a university'" class = "grammar-error">an</span> heuristics and can’t be perfect, you might want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> disable it in some circumstances.</li>
|
||
<li><code>input.clean.ligature_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">dashes</span></code> (default: <code>false</code>): <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">if</span> set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>true</code>, will convert <code>--</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> en <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">dash</span> (<code>–</code>) and <code>---</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> em <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">dash</span> (<code>—</code>). This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span> be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">useful</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">if</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">want</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> these characters but <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span>’t access them easily on your keymap; however, as it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span> also cause problems <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">if</span> you <em>do</em> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">want</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> have two successive dashes, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> disabled by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">default</span>.</li>
|
||
<li><code>input.clean.ligature_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">guillemets</span></code> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">default</span>: <code>false</code>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> a similar feature for french '<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">guillemets</span>’, replacing <code><<</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code>>></code> to <code>«</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code>»</code>.</li>
|
||
</ul>
|
||
<h3 id = "link-50">Generic options <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> rendering</h3>
|
||
<p id = "para-143">These <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> allow <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> configure the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>; they are used (or at least should be) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> all formats.</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span></code> (default: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>syntect</code>): specify if and how <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">perform</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">syntax</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlighting</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> code blocks. Valid values are:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>syntect</code>: uses the <a href = "https://crates.io/crates/syntect"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>syntect</a> library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">perform</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">syntax</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlighting</span>. This has the advantage of also enabling <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">syntax</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlighting</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> LaTeX/PDF <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> EPUB formats; however <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">syntect</span> support doesn’t seem to work on Windows.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">js</span></code>: this<span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> use (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> embed) <a href = "https://highlightjs.org/"><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">js</span></code></a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> HTML rendering, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> not perform any <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">syntax</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlighting</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> other output formats.</li>
|
||
<li><code>none</code>: disable <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">syntax</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlighting</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">If</span> your version of Crowbook (as is the case <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> Windows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">builds</span>) isn’t <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">built</span> with <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>syntect</code> support, it will default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>none</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">if</span> you try <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> it.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span></code>: only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">if</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">highlight</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>syntect</code>, selects the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> for syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">highlighting</span>. Default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>InspiredGitHub<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>. Valid <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span> names are <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>InspiredGitHub<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Solarized (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dark</span>)<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Solarized (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">light</span>)<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>16-eighties.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dark</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>16-mocha.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dark</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>16-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ocean</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dark</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> and <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>16-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ocean</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">light</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.</li>
|
||
<li><code>rendering.num_depth</code>: an integer that represents the maximum level of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbering</span> for your book. E.g., <code>1</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapters</span>, while <code>2</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapters</span>, sections, but not anything below that. <code>6</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> the maximum<span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">level</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> turns <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbering</span> on for all headers. (Default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <code>1</code>.) This also affects what <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">levels</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> displayed in the table of contents.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span></code>: the strings that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> used <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> design <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>. E.g., if you want your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">parts</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> show as <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Book III<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> instead of <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Part III<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, you can set <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>: Book</code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">roman</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numerals</span></code> and <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">roman</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numerals</span></code>: these two booleans allow you to specify <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">roman</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numerals</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span> or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbers</span> (default is <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>true</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbers</span>, and <code>false</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbers</span>).</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> set to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">true</span>, Crowbook will include a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">table</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contents</span> at the beginning of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">document</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">name</span></code>: the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">name</span> of this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">table</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contents</span> as it should be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displayed</span> in the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">document</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">initials</span></code>: if <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> to true, Crowbook will use <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">initials</span>, or <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>lettrines<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displaying</span> the first letter of each <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> bigger than the others.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">part</span>.reset_counter</code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <code>false</code> if you don’t want your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> numbers <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> start again <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> 1 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> each <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">part</span>.</li>
|
||
</ul>
|
||
<h3 id = "link-51">HTML Options</h3>
|
||
<p id = "para-144">These options allow you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> customize the HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span> (used both by the default HTML standalone <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">renderer</span> and the HTML multifile <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">renderer</span>):</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>html</span>.icon</code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> a <code>favicon</code> for the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">page</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.header</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.footer</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">allow</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> a custom (Markdown) string <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the top <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the bottom of the HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">page</span>. This is actually a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span>, so you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span> access metadata, such as <code>{{{author}}}</code>, <code>{{{title}}}</code>, or <code>{{{version}}}</code> in it. See the <a href = "#chapter-4"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>template</a> chapter for more information on the fields you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">css</span></code> allows <span title = "Did you mean 'setting'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error">to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span></span> up a custom CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>. You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span> also redefine the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">colours</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">using</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">css</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">colours</span></code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">css</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">add</span></code> allows you to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">add</span> some specific lines of CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> your book configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>, that will be appended after the default CSS template.</li>
|
||
<li><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span></code> is similar to <code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span></code> but only sets the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span> for HTML output.</li>
|
||
</ul>
|
||
<h4 id = "link-52">Options <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> standalone HTML</h4>
|
||
<p id = "para-145"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">There</span> are a few <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> specific <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">standalone</span> HTML renderer (default, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> with <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span>.html</code>):</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">standalone</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">one</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span></code>, if <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> true, will only display <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">one</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> at a time (using Javascript), making it look similarly <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the multifile HTML.</li>
|
||
<li><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">standalone</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span></code> allows you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> change or modify the HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">standalone</span> HTML.</li>
|
||
</ul>
|
||
<h3 id = "link-53">Options <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> LaTeX/PDF rendering</h3>
|
||
<p id = "para-146">These <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">allow</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> customize the LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span> (and, thus, the generated PDF documents):</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span></code> specifies a different LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">class</span></code> changes the LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">class</span> used.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">paper</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">size</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">font</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">size</span></code> (default <code>a5<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">paper</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code>10pt</code>) allows to modify the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">page</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">font</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">size</span><span title = "Don't put a space before the full stop" class = "grammar-error"> .</span></li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.left</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.right</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.top</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.bottom</code> specify the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">page</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">links</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">footnotes</span></code> can be set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code>false</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you don’t want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">links</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> also appear <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">footnotes</span> (which means losing them <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> it is actually printed).</li>
|
||
<li><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span></code>: similar <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span></code>, but only sets the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span> for LaTeX/PDF <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.</li>
|
||
</ul>
|
||
<h3 id = "link-54">Options <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span></h3>
|
||
<p id = "para-147"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">There</span> are also <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> specific <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the EPUB format:</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>epub</span>.version</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> 2 or 3 (default 2).</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">epub</span>.css</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> useful if you want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> a customized stylesheet.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">epub</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span></code>: similar <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span></code> but only sets a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">theme</span> for EPUB output.</li>
|
||
</ul>
|
||
<h3 id = "link-55">Resources options</h3>
|
||
<p id = "para-148"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">These</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> allow <span title = "Did you mean 'embedding'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> embed</span> additional files <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> some formats (currently, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">only</span> EPUB). This can be useful <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> embedding fonts.</p>
|
||
<h4 id = "link-56"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span></h4>
|
||
<p id = "para-149">A list of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">files</span> or directories that should <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> added.</p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">font1.otf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">font2.otf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-150">It is also possible to specify a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">directory</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> multiple <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">directories</span>). So if you have a <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>fonts</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">directories</span> containing <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">font</span>1.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">otf</span></code> and <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">font</span>2.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">otf</span></code>,</p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-151"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> be equivalent <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span>:</p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-152"><b><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"></span>default</b>: not set</p>
|
||
<h4 id = "link-57"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">resources</span>.out_path</h4>
|
||
<p id = "para-153">This option determine where (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> which <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">directory</span>), <em><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> the resulting document</em>, those <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> copied. The <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">default</span> is <code>data</code>, so by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">default</span> the <code>resources.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> the first example above <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">will</span> search <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">font</span>1.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">otf</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">font</span>2.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">otf</span></code> <em><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> the same directory than the <code>.book</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>file</em>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">will</span> copy them to <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">data</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">font</span>1.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">otf</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">data</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">font</span>2.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">otf</span></code> <em><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> the EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span></em>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> is therefore <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> last path that you should use if you want to access those <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> e.g. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> a custom CSS stylesheet.</p>
|
||
<p id = "para-154">Note <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you pass <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">directories</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <code>resources.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span></code>, the whole <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">directory</span> would be copied. So assuming <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">fonts</span>/</code> contains <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">font</span>1.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">otf</span></code> and <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">font</span>2.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">otf</span></code></p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">resources.path</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">data</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-155"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copy</span> these two <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">data</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">fonts</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">font</span>1.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">otf</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">data</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">fonts</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">font</span>2.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">otf</span></code> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> not <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">data</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">font</span>1.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">otf</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">data</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">font</span>2.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">otf</span></code>).</p>
|
||
<p id = "para-156">Similarly, the whole path of <code>resources.files</code> is copied, so</p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-157"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> yield the same result.</p>
|
||
<p id = "para-158"><b><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"></span>default</b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>data</code></p>
|
||
<h2 id = "link-58">3.4. Full list of options</h2>
|
||
<p id = "para-159">Here <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> the complete <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">list</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">options</span>. You can always look at it by running <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">list</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">options</span></code> or <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> -l</code>.</p>
|
||
<h3 id = "link-59">Metadata</h3>
|
||
<ul>
|
||
<li><b><code>author</code></b><ul>
|
||
<li><b>type</b>: metadata</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>"</code></li>
|
||
<li>Author of the book</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>title</code></b><ul>
|
||
<li><b>type</b>: metadata</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>"</code></li>
|
||
<li>Title of the book</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>lang</code></b><ul>
|
||
<li><b>type</b>: metadata</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>en</code></li>
|
||
<li>Language of the book</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>subject</code></b><ul>
|
||
<li><b>type</b>: metadata</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> set</code></li>
|
||
<li>Subject of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">metadata</span>)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>description</code></b><ul>
|
||
<li><b>type</b>: metadata</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> set</code></li>
|
||
<li>Description of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">metadata</span>)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>cover</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> set</code></li>
|
||
<li>Path to the cover of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-60">Additional <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">metadata</span></h3>
|
||
<ul>
|
||
<li><b><code>subtitle</code></b><ul>
|
||
<li><b>type</b>: metadata</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Subtitle of the book</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>license</code></b><ul>
|
||
<li><b>type</b>: metadata</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>License of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span>. This information will be displayed on PDF documents</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>version</code></b><ul>
|
||
<li><b>type</b>: metadata</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Version of the book</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>date</code></b><ul>
|
||
<li><b>type</b>: metadata</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Date the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span> was revised</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-61">Output options</h3>
|
||
<ul>
|
||
<li><b><code>output</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span> of strings</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Specify a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span> formats to render</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.epub</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Output <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> EPUB rendering</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.html</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Output <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> HTML rendering</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.html.dir</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Output directory <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> HTML rendering</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.tex</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Output <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> LaTeX rendering</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.pdf</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Output <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> PDF rendering</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.odt</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Output <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> ODT rendering</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.html.if</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Output <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> HTML (interactive fiction) rendering</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.base_path</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>"</code></li>
|
||
<li>Directory where those output <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> will we <span title = "Possible grammatical error. You used a past participle without using any required verb ('be' or 'have'). Did you mean 'wrote'?" class = "grammar-error">written</span></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-62">Rendering options</h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>rendering</span>.highlight</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>syntect</code></li>
|
||
<li>If/how <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highligh</span> code blocks. Possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">values</span>: <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>syntect<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> (default, performed at runtime), <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.js<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> (HTML-only, uses Javascript), <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>none<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.theme</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>InspiredGitHub</code></li>
|
||
<li>Theme <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlighting</span> (if <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span> is set to ‘syntect’)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.initials</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>Use initials (‘lettrines’) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> first letter of a chapter (experimental)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span>_toc</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>Display a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">table</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">content</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the document</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span>.name</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>{{{loc_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span>}}}<span title = "Unpaired symbol: ''' seems to be missing" class = "grammar-error"><span title = "Use a smart closing quote here: '”'." class = "grammar-error"></span>"</span></code></li>
|
||
<li>Name of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">table</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contents</span> if it is displayed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> document</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>rendering.num_depth</code></b><ul>
|
||
<li><b>type</b>: integer</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>1</code></li>
|
||
<li>The<span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span>maximum heading levels that should be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">numbered</span> (0: no <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">numbering</span>, 1: only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapters</span>, ..., 6: all)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.chapter</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> set</code></li>
|
||
<li>How <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">call</span> chapters</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>rendering.part</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> set</code></li>
|
||
<li>How <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">call</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">parts</span> <span title = "Unpaired symbol: ')' seems to be missing" class = "grammar-error">(</span>or ‘books’, ‘episodes’, ...</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">roman</span>_numerals</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">true</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">roman</span> numerals</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">roman</span>_numerals</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">true</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">roman</span> numerals</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">reset</span>_counter</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">true</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">reset</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span> at each part</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span>.template</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span>}}}. {{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">title</span>}}}<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code></li>
|
||
<li>Naming <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">scheme</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapters</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> TOC</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">part</span>.template</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span>}}}. {{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">part</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">title</span>}}}<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code></li>
|
||
<li>Naming <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">scheme</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">parts</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> TOC</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-63">Special option</h3>
|
||
<ul>
|
||
<li><b><code>import</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>not set</code></li>
|
||
<li>Import another book configuration file</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-64">HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span></h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>html</span>.icon</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Path <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> an icon <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> be used <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> the HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>(s)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>.theme</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> theme <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlighting</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> HTML output (syntect only)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.header</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Custom header <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the beginning of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>(s)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.footer</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Custom footer <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the end of HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>(s)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.css</code></b><ul>
|
||
<li><b>type</b>: template path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Path of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">stylesheet</span> for HTML rendering</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span>.add</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Some inline CSS added to the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">stylesheet</span> template</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span>.colours</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Path of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">stylesheet</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> the colours <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> HTML</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.js</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Path of a javascript file</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.css.print</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Path of a media print stylesheet <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> HTML rendering</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.js</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">another</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">js</span> version <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">than</span> the bundled one</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.css</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">another</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">js</span> CSS theme <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">than</span> the default one</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">side</span>_notes</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>Display footnotes as <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">side</span> notes in HTML/Epub (experimental)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.escape_nb_spaces</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>Replace unicode non breaking spaces with HTML entities and CSS</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>.template</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">h</span>1 id = '<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">link</span>-{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">link</span>}}}'>{{#<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">has</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span>}}<<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">span</span> class = '<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">header</span>’>{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">header</span>}}} {{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span>}}}</<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">span</span>>{{#<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">has</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">title</span>}}<br />{{/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">has</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">title</span>}}{{/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">has</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span>}}{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">title</span>}}}</<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">h</span>1><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code></li>
|
||
<li>Inline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> formatting</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.template</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default value</b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">h</span>2 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">class</span> = '<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>’>{{{header}}} {{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span>}}}</<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">h</span>2> <<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">h</span>1 id = '<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">link</span>-{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">link</span>}}}’ <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">class</span> = '<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>’>{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">title</span>}}}</<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">h</span>1><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code></li>
|
||
<li>Inline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span> formatting</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-65">Standalone HTML options</h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">standalone</span>.template</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">value</span></b>: <code>not set</code></li>
|
||
<li>Path of an HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">standalone</span> HTML</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">standalone</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">one</span>_chapter</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">value</span></b>: <code>false</code></li>
|
||
<li>Display only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">one</span> chapter at a time (with a button to display all)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">standalone</span>.js</code></b><ul>
|
||
<li><b>type</b>: template path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">value</span></b>: <code>not set</code></li>
|
||
<li>Path of a javascript file</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-66">Multifile HTML options</h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>html</span>.dir.template</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> set</code></li>
|
||
<li>Path of <span title = "Use 'an' instead of 'a' if the following word starts with a vowel sound, e.g. 'an article', 'an hour'" class = "grammar-error">a</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span> for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">multifile</span> HTML</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-67">Interactive fiction HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span></h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span>.js</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Path of a javascript file</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span>.new_turn</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">run</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">at</span> the beginning of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">each</span> segment</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span>_turn</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">run</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">at</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">each</span> segment</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span>.new_game</code></b><ul>
|
||
<li><b>type</b>: template path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">run</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">at</span> the beginning of a ‘game’</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-68">EPUB options</h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>epub</span>.version</code></b><ul>
|
||
<li><b>type</b>: integer</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>2</code></li>
|
||
<li>EPUB version to generate (2 or 3)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">epub</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>.theme</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> theme <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlighting</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> EPUB output (syntect only)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">epub</span>.css</code></b><ul>
|
||
<li><b>type</b>: template path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Path of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stylesheet</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> EPUB</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>epub.css.add</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Inline CSS added to the EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stylesheet</span> template</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>epub.chapter.xhtml</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">not</span> set</code></li>
|
||
<li>Path of <span title = "Use 'a' instead of 'an' if the following word doesn't start with a vowel sound, e.g. 'a sentence', 'a university'" class = "grammar-error">an</span> xhtml <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> for each chapter</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>epub.toc.extras</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>Add ‘Title’ <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> (if set) ‘Cover’ in the EPUB table of contents</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>epub.escape_nb_spaces</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>Replace unicode non breaking spaces with HTML entities <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> CSS</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-69">LaTeX options</h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>.theme</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>not set</code></li>
|
||
<li>If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> theme <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlighting</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> LaTeX/PDF output (syntect only)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">links</span>_as_footnotes</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>Add foontotes <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> URL of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">links</span> so they are readable when printed</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.command</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>xelatex</code></li>
|
||
<li>LaTeX command <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> use for generating PDF</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.template</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span> path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> set</code></li>
|
||
<li>Path of a LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span> file</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span>.add</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> set</code></li>
|
||
<li>Inline code added in the LaTeX template</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.class</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>book</code></li>
|
||
<li>LaTeX class to use</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.paper.size</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>a5paper</code></li>
|
||
<li>Specifies the size of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">page</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.left</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>not set</code></li>
|
||
<li>Specifies <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">left</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span> (note that with <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">class</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">left</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> right <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margins</span> are reversed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> odd <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">pages</span>, thus the default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span> is 1.5<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cm</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">class</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> 2<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cm</span> else)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.right</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>not set</code></li>
|
||
<li>Specifies <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">right</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>(note that with <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">class</span> left <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">right</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margins</span> are reversed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> odd pages, thus the default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span> is 2.5<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">cm</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">book</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">class</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> 2<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">cm</span> else)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.top</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>2<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">cm</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code></li>
|
||
<li>Specifies top margin</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.bottom</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>1.5<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">cm</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code></li>
|
||
<li>Specifies left margin</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.title</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>If true, generate a title with \maketitle</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">font</span>.size</code></b><ul>
|
||
<li><b>type</b>: integer</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>not set</code></li>
|
||
<li>Specify latex <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">font</span> size (in pt, 10 (default), 11, or 12 are accepted)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.hyperref</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>If disabled, don’t try <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> find references inside the document</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>tex.stdpage</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>If set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> true, use ‘stdpage’ package <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> format a manuscript according <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> standards</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-70">Resources option</h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>resources</span>.files</code></b><ul>
|
||
<li><b>type</b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span> of strings</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>not set</code></li>
|
||
<li>Whitespace-separated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">list</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">files</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> embed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">e</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">g</span>. EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>; useful for including <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">e</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">g</span>. fonts</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>resources.out_path</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>data</code></li>
|
||
<li>Paths <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">where</span> additional <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">resources</span> should be copied <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> the EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> or HTML directory</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>resources.base_path</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>not set</code></li>
|
||
<li>Path <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">where</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> find <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">resources</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> the source tree). By default, links and images are relative <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> the Markdown file. If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> is set, it will be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span>.links</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>not set</code></li>
|
||
<li>Set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">but</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">only</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> links. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">Useless</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> set</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>resources.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span>.images</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>.</code></li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>Set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">but</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">only</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> images. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">Useless</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> set</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>resources.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span>.files</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>.</code></li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>Set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">but</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">only</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> additional <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">Useless</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">set</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span>.templates</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>.</code></li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>Set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">but</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">only</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> templates <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">Useless</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">set</span></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-71">Input options</h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>input</span>.clean</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>Toggle typographic <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">cleaning</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">input</span> markdown according <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> lang</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>input.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">clean</span>.smart_quotes</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">enabled</span>, tries <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">replace</span> vertical quotations marks <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> curly ones</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>input.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">clean</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ligature</span>.dashes</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">enabled</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">replaces</span> ‘--’ <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> en <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">dash</span> ('–') <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> ‘---’ <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> em <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">dash</span> ('—')</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">input</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">clean</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ligature</span>.guillemets</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">enabled</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">replaces</span> ‘<<’ <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> ‘>>’ <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> french <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>guillemets<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> ('«’ <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> ‘»’)</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">input</span>.yaml_blocks</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>Enable inline YAML blocks <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> override options set in config file</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-72">Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span></h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>crowbook</span>.html_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span>_text</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>Consider HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> text. This avoids having <foo> being considered <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> thus ignored.</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">crowbook</span>.markdown.superscript</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>If enabled, allow support for superscript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> subscript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">using</span> respectively foo<sup>up</sup><span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> bar<sub>down</sub> syntax.</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">crowbook</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">temp</span>_dir</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <span title = "Use a smart opening quote here: '“'." class = "grammar-error">``</span></li>
|
||
<li>Path where <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> create a temporary directory (default: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">uses</span> result from Rust’s std::env::<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">temp</span>_dir())</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">crowbook</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">zip</span>.command</code></b><ul>
|
||
<li><b>type</b>: string</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>zip</code></li>
|
||
<li>Command <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span title = "Did you mean 'used'?" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>use</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">zip</span> files (for EPUB/ODT)</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-73">Output options (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> proofreading)</h3>
|
||
<ul>
|
||
<li><b><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.html</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> set</code></li>
|
||
<li>Output <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">with</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span> features</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.html.dir</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> set</code></li>
|
||
<li>Output directory <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">with</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span> features</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>output.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.pdf</code></b><ul>
|
||
<li><b>type</b>: path</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> set</code></li>
|
||
<li>Output file <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">name</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> PDF <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">with</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span> features</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-74"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">Proofreading</span> options (only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> output.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.* targets)</h3>
|
||
<ul>
|
||
<li><b><code>proofread</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>If set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> false, will disactivate <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofreading</span> even if one of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.x is present</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.languagetool</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>If true, try <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> use language tool server <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> grammar check the book</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">languagetool</span>.port</code></b><ul>
|
||
<li><b>type</b>: integer</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>8081</code></li>
|
||
<li>Port <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> connect <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">languagetool</span>-server</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.grammalecte</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>If true, try <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> use <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">grammalecte</span> server <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> grammar check the book</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">grammalecte</span>.port</code></b><ul>
|
||
<li><b>type</b>: integer</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>8080</code></li>
|
||
<li>Port <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> connect <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">grammalecte</span> server</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.repetitions</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>false</code></li>
|
||
<li>If set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> true, use Caribon <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> detect repetitions</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.max_distance</code></b><ul>
|
||
<li><b>type</b>: integer</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>25</code></li>
|
||
<li>Max distance between two occurences so it is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">considered</span> a repetition</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.fuzzy</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>Enable <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fuzzy</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">string</span> matching</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fuzzy</span>.threshold</code></b><ul>
|
||
<li><b>type</b>: float</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>0.2</code></li>
|
||
<li>Max <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">threshold</span> of differences <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">consider</span> two <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">strings</span> a repetition</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.ignore_proper</code></b><ul>
|
||
<li><b>type</b>: boolean</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>true</code></li>
|
||
<li>Ignore proper nouns for repetitions</li>
|
||
</ul>
|
||
</li>
|
||
<li><b><code>proofread.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.threshold</code></b><ul>
|
||
<li><b>type</b>: float</li>
|
||
<li><b>default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">value</span></b>: <code>2.0</code></li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Threshold</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> detect a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetition</span></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p id = "para-160">Note that these options have a type, which in most case should <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> pretty straightforward (a boolean can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> <code>true</code> or <code>false</code>, an integer must <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> composed by a number, a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">string</span> is, well, any <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">string</span> (note <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> you might need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> use quotes if it includes some characters <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> may lead the YAML parser <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> read it as <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">an</span> array, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">an</span> integer or a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">list</span>), and a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">list</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">strings</span> is a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">list</span> containing only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">strings</span>, see <a href = "https://en.wikipedia.org/wiki/YAML#Basic_components">YAML syntax</a>). The <code>path</code> type might puzzle you a bit, but it’s equivalent <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">string</span>, except Crowbook will consider it relatively <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the book file. The <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">path</span></code> type is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">just</span> the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>path</code> of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span>. Metadata <span title = "Consider using third-person verb forms for singular and mass nouns: 'is'." class = "grammar-error">are</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">just</span> strings.</p>
|
||
|
||
</div><div id = "chapter-3" class = "chapter">
|
||
<h1 id = 'link-75'><span class = 'chapter-header'>Chapter 4</span><br />Markdown format</h1><p id = "para-161">Crowbook uses <a href = "https://github.com/google/pulldown-cmark">pulldown-cmark</a>, which is an implementation of <a href = "http://commonmark.org/">CommonMark</a>, so for more information on Markdown syntax, you can refer to this website.</p>
|
||
<p id = "para-162">However, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">pulldown</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cmark</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">implements</span> a handful of unofficial extensions, and Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> adds its own variants, so there <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> a few syntax elements that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> not covered by the CommonMark reference.</p>
|
||
<h2 id = "link-76">4.1. Tables</h2>
|
||
<p id = "para-163"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Tables</span> can be included in your Markdown file. E.g.:</p>
|
||
<pre><span style="color:#839496;">|</span><span style="color:#839496;"> Author </span><span style="color:#839496;">|</span><span style="color:#839496;"> Book </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">|</span><span style="color:#657b83;">--------------------</span><span style="color:#839496;">|</span><span style="color:#657b83;">----------------------------</span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">|</span><span style="color:#839496;"> Anne Rice </span><span style="color:#839496;">|</span><span style="color:#839496;"> Interview With the Vampire </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">|</span><span style="color:#839496;"> Terry Pratchett </span><span style="color:#839496;">|</span><span style="color:#839496;"> Hogfather </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">|</span><span style="color:#839496;"> George Martin </span><span style="color:#839496;">|</span><span style="color:#839496;"> A Dance with Dragons </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-164"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> render as</p>
|
||
<div class = "table">
|
||
<table>
|
||
<tr>
|
||
<th> Author </th><th> Book </th></tr>
|
||
<tr>
|
||
<td> Anne Rice </td><td> Interview With the Vampire </td></tr>
|
||
<tr>
|
||
<td> Terry Pratchett </td><td> Hogfather </td></tr>
|
||
<tr>
|
||
<td> George Martin </td><td> A Dance with Dragons </td></tr>
|
||
|
||
</table>
|
||
</div>
|
||
<blockquote><p id = "para-165">Crowbook doesn’t currently support specifying column alignment.</p>
|
||
</blockquote>
|
||
<h2 id = "link-77">4.2. Footnotes</h2>
|
||
<p id = "para-166"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Footnotes</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specified</span> the following way:</p>
|
||
<pre><span style="color:#839496;">Footnotes can be useful[^1] and make you look clever.
|
||
</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">[</span><span style="color:#2aa198;">^1</span><span style="color:#839496;">]</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">But</span><span style="color:#839496;"> </span><span style="color:#839496;">you shouldn't use them too much.</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-167"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendered</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span>:</p>
|
||
<blockquote><p id = "para-169"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Footnotes</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">be</span> useful<a href = "#note-dest-1"><sup id = "note-source-1">[1]</sup></a> and make you look clever.</p>
|
||
</blockquote>
|
||
<p id = "para-170">You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> multiple paragraphs in a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">footnote</span> definition. This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">can</span> sometimes <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">be</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">useful</span>, but it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">be</span> tricky, as if you only let an empty line before the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">next</span> paragraph, it will <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">be</span> included in the footnote. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">And</span> probably the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">next</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">one</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> the following <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">one</span> too:</p>
|
||
<pre><span style="color:#839496;">This is a footnote usage[^1].
|
||
</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">[</span><span style="color:#2aa198;">^1</span><span style="color:#839496;">]</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">This</span><span style="color:#839496;"> </span><span style="color:#839496;">is obviously part of the footnote definition.</span><span style="color:#839496;">
|
||
|
||
</span><span style="color:#839496;">This is less obviously ALSO part of the footnote definition.
|
||
|
||
</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">This is NOT part of the foonote.
|
||
</span></pre><p id = "para-171">Due to its own quirks, Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> duplicate <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">footnotes</span> if you reference them multiple times:</p>
|
||
<pre><span style="color:#839496;">This footnote is unique[^2] but referenced twice[^2].
|
||
</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">[</span><span style="color:#2aa198;">^2</span><span style="color:#839496;">]</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">Or</span><span style="color:#839496;"> </span><span style="color:#839496;">is it?</span><span style="color:#839496;">
|
||
</span></pre><blockquote><p id = "para-174">This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">footnote</span> is unique<a href = "#note-dest-2"><sup id = "note-source-2">[2]</sup></a> but referenced twice<a href = "#note-dest-3"><sup id = "note-source-3">[3]</sup></a>.</p>
|
||
</blockquote>
|
||
<h2 id = "link-78">4.3. Superscript and subscript</h2>
|
||
<p id = "para-175">Crowbook 0.12.0 added experimental support for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">superscript</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">subscript</span>, using respectively <code>foo^up^</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code>bar~down~</code> syntax, which will render <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>foo<sup>up</sup><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>bar<sub>down</sub><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> ; this feature is quite a hack above the Markdown parsing library, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> such might cause issue if you mix it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> other Markdown syntax elements (or, in the previous example, for smart quote detection). This is why you’ll need to enable it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> <code>crowbook.mardown.superscript</code>.</p>
|
||
<h2 id = "link-79">4.4. <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Standalone<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> images</h2>
|
||
<p id = "para-176"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> not <em>per se</em> a new syntactic element, but Crowbook distinguish two <span title = "Possible agreement error. The noun 'kind' seems to be countable, so consider using: 'kinds'." class = "grammar-error">kind</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">images</span>, according to their position in the document:</p>
|
||
<ul>
|
||
<li><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">standalone</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">images</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">which</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> the only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">elements</span> of a paragraph;</li>
|
||
<li>inline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">images</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">which</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> placed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">container</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">containing</span> other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">elements</span>.</li>
|
||
</ul>
|
||
<p id = "para-177"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Standalone</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">images</span> will typically be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">resized</span> to fill the width of the page, while inline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">images</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">resized</span>.</p>
|
||
<p id = "para-178">This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">image</span> is on its own paragraph, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> thus considered <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>standalone<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">resized</span> to fit width:</p>
|
||
<div class = "image">
|
||
<img src = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAYAAACOEfKtAAAACXBIWXMAADAPAAAwDwEQo/h8AAAAB3RJTUUH4QcOERMAPzhBcQAACalJREFUeNrtnHtwVsUVwH9JDI8IUgoaFQHBiJiA4ZkWBRQcKY5YtDZDoUxFaam2CHQ6Mlo7KmmnVXHoY7StnbZW2/HRTqvTB+1UHXG0Kmh5k9pOQ4OmFAQKkgARCekf93yTzc3eu7v37pf7RT0zO/N9d++ePXvu7tnz2oXChunADD6ESBgHNAE1mrppQLuUmZr6qcDeiLYfCCgCNihMmhaq26bU1cuzHMxQ6l4Hit/PjDofWA2UhJ5/FHhHYUQrUC51i5XnufIlqRsCHFeeHwYGhXCXAj8ExvR05hUD/5aBvg1crdQt1DDpCLBG8zxXHgSOaZ4vUvBeBxyU542aD9ej4CPAntBgvyuD2hPDKNeyD+gLPBR6vkdo6LFwDtDikVGu5YjQkNcl5gNGCMEbgUuAMnneDzg1Ic5jwHPAn4GjCXGUAf0VWmYAbwitFYU0074c+vKNwG3AphSz5xMK/stT4NkB1AFvhZ4v9THwUzwxsCX0fzjwbYf2e4CdMtj1osJsUOqfAy6S8jGgGhhpuTwrpYThcCHNwE8lnB2PABcAfRx3y2JpM1R25iR9X5sVs6qB8RqTy5bw9cBNwgCfsnwR8KIDHdNDemMNMDnfzBsbIuIFUXrrLQg+DFzaDR+4BvifBT3/ApYBr4WeV+eTuDEJlspJsSKKunmlLA5ZLLalMt+EuRBTr6gRWUAZsMWR5rzDnywJudvjLp8GSoDlQJsFzb/vDoIWGIg4AawoIA2hHHjM8qPP960HngdcAzRL2Qd8zdBmjlgPhQBXAk8Ap1m+f7dYPYNF9PQHfiOiKO/y7kTI25Il9IrRD48nsM8Tw0sOnSwtEOaNEJVJR+Mx4MwIf2NUWZeGmMmihpg6ubcAGFcE3AG8G0HjVuBc5f06SxVsYhqi+oiNGtfJFtHks2JaGXCDyK4oGl+PkP8bDWNrAHqnJXKFoZMhGTFvJvBHC6vj1RgmlBvaLk+qNw0UQ/1Cw1f6YkbMu9NSfu2XHTjOCroxpv028QANJ4i7GFdahfjy9oo3N464A54dAi7LdqclA+da4OstjI7D0yoqXBMwOg7ZKofdaV5Gs2+iJX0r8+SOu8vkFmqyQLI9w912qwV9jyfAa2Mz78IiDHKFBaIbMmLeKMtZcl4C3Ndb4LVOM6mLsTbeBc6KaHdNnhn4dUsGJlGrykXWnYjAeUdaM+4+YECM/Twy4dJxgUYL5rV6cIF9Q4PX6M8slq36c7LjqI3fDH3VIg0ja4H3lP9n5kHvs5l9mz30VSryTsXbTBB9HIwmfjNOtPUoG3KHZlm8QpDfkoPH5d1LhLnNQJVHBv7TkoG/8MTAqDDFEdlwOsVPGgxEtQETQp1sonNwKZdKAfCy/B+g0bn6JhjQGOzd81/xwMAaCx9Ag9pgrKVsUYn7q/j+AG5VdMPVGlVnuKgfzaLZu8K3HPS0tAmZK2McEmq5INxwkoWfbJny/vOysQDsFvlXpzHzvhqh/pwuDs8zLGTzSQcGpjX+b8EcXRwf1XggcCim8ZXKu3+RXXE0XeMNraKLqQmUz8vsu4sg5e2k4DDB9x2Yt8aTFzvOfDV6t1fHIBirvLdWQaqTmUctB/2kKLG1snyWALPkKy9wwPOip80qTpzdbzLSbzQQqSrQvyO7tLV8mpZnGfpaoTPnpgsRJkLV6ft0ATGw3CMDT7Po7x/A7FyDKQ6EqirIkwXAuPV0zY9OC30d+p9ajFtWlLrDNWccA2knCFke8ICrStFZXXbxttyPWXRkbsaVoUrjq0QXbMt4FtbLztkrIfNGigMhB8OwS9q8VLeJLDM0nKBx/w8VdeRe4JOCvLuZeFLs91ssGXkqQTrcszIBHnZw2C4xORbi1Bhbd9XFwC8dFWAfpS1kn6t+xOsJEjp3adSovpbe6ftMA+9viA+sdFwefQhSI7qTiUvFGTCbICcmzobWpSHfFvP+ITE2tFBN55NDuvLzFHLmngJSe3JllIbWRw1tWtBkstq6ytP62voRxHKPZ8y4A6oelyDm0k7oGFmDQ+c+Mk1vz3jXjlJVShzwNIT9X1swx4Lbgc+nZF5v7HKq81VujqHtZov2zeJ8rta5jQYLkji31u6UDHwloyV7q/gl48KScef39ouvYJBNaLPIoHMlPUa6JAPmtVnSdpFB7Yp0VhKxlccxtzYhA32YXbZm3s9Ex7PVXecZ5HtdFDPCcJk4P+OgNWFsA/H6RAWbNouMmWSBv00CWc+K9VAh4mEjwbm4rQ40FcmYTFbMLOAZk/u80XJpPJCQgRM03utvaj5mrcjbtpD4qCQ4d/K2xxn7kOWY3zLJvzsdZMsx4OwExBYL03IMOdfw/hQ6jlY0iRydS5AX6AOGKPTYlFVxyEYLkfvQH633EYMtUczFLzi0G0dwtOw9xWI6Avw0wqKwhV9ZjPOozPhGLPJuSmWrHi470zb8JhrlGHiIjoPZLjBP6XuOWDdJ8xRvMoxtE0GS6TCxgRMdHDK5uA46utRz2v5nEg56oLR/WWzzpMw728L2X55WPvQmONVoI1xt4RTg1yloGiVLeSBBwL1PQvNyt8W4dpIyzjzRwaf3tIPKMCAFTX8Avqf47pLAWgdHbaozxOsctf58p7fNVfq6J+HyfcpxTC+l1ehdy6N5ZOBa4Mei7M8Xr7eLWflEwjHFLqc4qAQ+Tcdhw/0S+zCpDReLVeAbniFIQVbhQuDvFm1rCMKgcbCDIIHqdDoOGz4Vdl2lhfmGr/WdPM7ATcDHSX4Xzf0G2j+bxCpwhQWG+jc1z3p5YmAtQZxjpsW7Ovn4X0Obhd3l6Ygrr4Xev1yWgK/0i1LMma/DCKJvszXOikyP/FdaCt1XCeKut9M56/1HJEuwdFG7Hg75AleJ/bzZkvaqfDJwnGa2LbdUttVB/Q2/d7TkkqNcsiTqCc4Nv0B0Cl9eoEZKaWgASdSDRnEGLBTb2xYq6AiU/ydh39NDOMeT4M4YX3e5XAv81hOudSICtouJWCrMrRLX1hRP/Vzng2Zf15L4vBvmMin5hn4+kPi6PzCcN9xEcNqnnuxhi2xmu/L40VNDhciVN0RHy33d0WSfvpE731tGcAgod6fhCHoAnINdsD5fpYUecgVoFLTQNZP1JzIb9nnsZ6/I8zWa/lvowVBCR5TvoDgmcrAIfaDqQYOdrZvRqgk2hyB+0U5wHqXHX9JdBfyArocVB9H5cONxOm4A0eWoLJa6M+gcRXuHrkmVxQSJoufzPoZiOl9+ODOkn6oJSNtDOutUpW4D3X83YcHAJJFfUzV16vngaZr6yaJoV/MhRMIMjclVUPB/QxRWXpMKRCkAAAAASUVORK5CYII=" title = "" alt = "Logo" />
|
||
</div><p id = "para-179"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">While</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> one <img src = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAYAAACOEfKtAAAACXBIWXMAADAPAAAwDwEQo/h8AAAAB3RJTUUH4QcOERMAPzhBcQAACalJREFUeNrtnHtwVsUVwH9JDI8IUgoaFQHBiJiA4ZkWBRQcKY5YtDZDoUxFaam2CHQ6Mlo7KmmnVXHoY7StnbZW2/HRTqvTB+1UHXG0Kmh5k9pOQ4OmFAQKkgARCekf93yTzc3eu7v37pf7RT0zO/N9d++ePXvu7tnz2oXChunADD6ESBgHNAE1mrppQLuUmZr6qcDeiLYfCCgCNihMmhaq26bU1cuzHMxQ6l4Hit/PjDofWA2UhJ5/FHhHYUQrUC51i5XnufIlqRsCHFeeHwYGhXCXAj8ExvR05hUD/5aBvg1crdQt1DDpCLBG8zxXHgSOaZ4vUvBeBxyU542aD9ej4CPAntBgvyuD2hPDKNeyD+gLPBR6vkdo6LFwDtDikVGu5YjQkNcl5gNGCMEbgUuAMnneDzg1Ic5jwHPAn4GjCXGUAf0VWmYAbwitFYU0074c+vKNwG3AphSz5xMK/stT4NkB1AFvhZ4v9THwUzwxsCX0fzjwbYf2e4CdMtj1osJsUOqfAy6S8jGgGhhpuTwrpYThcCHNwE8lnB2PABcAfRx3y2JpM1R25iR9X5sVs6qB8RqTy5bw9cBNwgCfsnwR8KIDHdNDemMNMDnfzBsbIuIFUXrrLQg+DFzaDR+4BvifBT3/ApYBr4WeV+eTuDEJlspJsSKKunmlLA5ZLLalMt+EuRBTr6gRWUAZsMWR5rzDnywJudvjLp8GSoDlQJsFzb/vDoIWGIg4AawoIA2hHHjM8qPP960HngdcAzRL2Qd8zdBmjlgPhQBXAk8Ap1m+f7dYPYNF9PQHfiOiKO/y7kTI25Il9IrRD48nsM8Tw0sOnSwtEOaNEJVJR+Mx4MwIf2NUWZeGmMmihpg6ubcAGFcE3AG8G0HjVuBc5f06SxVsYhqi+oiNGtfJFtHks2JaGXCDyK4oGl+PkP8bDWNrAHqnJXKFoZMhGTFvJvBHC6vj1RgmlBvaLk+qNw0UQ/1Cw1f6YkbMu9NSfu2XHTjOCroxpv028QANJ4i7GFdahfjy9oo3N464A54dAi7LdqclA+da4OstjI7D0yoqXBMwOg7ZKofdaV5Gs2+iJX0r8+SOu8vkFmqyQLI9w912qwV9jyfAa2Mz78IiDHKFBaIbMmLeKMtZcl4C3Ndb4LVOM6mLsTbeBc6KaHdNnhn4dUsGJlGrykXWnYjAeUdaM+4+YECM/Twy4dJxgUYL5rV6cIF9Q4PX6M8slq36c7LjqI3fDH3VIg0ja4H3lP9n5kHvs5l9mz30VSryTsXbTBB9HIwmfjNOtPUoG3KHZlm8QpDfkoPH5d1LhLnNQJVHBv7TkoG/8MTAqDDFEdlwOsVPGgxEtQETQp1sonNwKZdKAfCy/B+g0bn6JhjQGOzd81/xwMAaCx9Ag9pgrKVsUYn7q/j+AG5VdMPVGlVnuKgfzaLZu8K3HPS0tAmZK2McEmq5INxwkoWfbJny/vOysQDsFvlXpzHzvhqh/pwuDs8zLGTzSQcGpjX+b8EcXRwf1XggcCim8ZXKu3+RXXE0XeMNraKLqQmUz8vsu4sg5e2k4DDB9x2Yt8aTFzvOfDV6t1fHIBirvLdWQaqTmUctB/2kKLG1snyWALPkKy9wwPOip80qTpzdbzLSbzQQqSrQvyO7tLV8mpZnGfpaoTPnpgsRJkLV6ft0ATGw3CMDT7Po7x/A7FyDKQ6EqirIkwXAuPV0zY9OC30d+p9ajFtWlLrDNWccA2knCFke8ICrStFZXXbxttyPWXRkbsaVoUrjq0QXbMt4FtbLztkrIfNGigMhB8OwS9q8VLeJLDM0nKBx/w8VdeRe4JOCvLuZeFLs91ssGXkqQTrcszIBHnZw2C4xORbi1Bhbd9XFwC8dFWAfpS1kn6t+xOsJEjp3adSovpbe6ftMA+9viA+sdFwefQhSI7qTiUvFGTCbICcmzobWpSHfFvP+ITE2tFBN55NDuvLzFHLmngJSe3JllIbWRw1tWtBkstq6ytP62voRxHKPZ8y4A6oelyDm0k7oGFmDQ+c+Mk1vz3jXjlJVShzwNIT9X1swx4Lbgc+nZF5v7HKq81VujqHtZov2zeJ8rta5jQYLkji31u6UDHwloyV7q/gl48KScef39ouvYJBNaLPIoHMlPUa6JAPmtVnSdpFB7Yp0VhKxlccxtzYhA32YXbZm3s9Ex7PVXecZ5HtdFDPCcJk4P+OgNWFsA/H6RAWbNouMmWSBv00CWc+K9VAh4mEjwbm4rQ40FcmYTFbMLOAZk/u80XJpPJCQgRM03utvaj5mrcjbtpD4qCQ4d/K2xxn7kOWY3zLJvzsdZMsx4OwExBYL03IMOdfw/hQ6jlY0iRydS5AX6AOGKPTYlFVxyEYLkfvQH633EYMtUczFLzi0G0dwtOw9xWI6Avw0wqKwhV9ZjPOozPhGLPJuSmWrHi470zb8JhrlGHiIjoPZLjBP6XuOWDdJ8xRvMoxtE0GS6TCxgRMdHDK5uA46utRz2v5nEg56oLR/WWzzpMw728L2X55WPvQmONVoI1xt4RTg1yloGiVLeSBBwL1PQvNyt8W4dpIyzjzRwaf3tIPKMCAFTX8Avqf47pLAWgdHbaozxOsctf58p7fNVfq6J+HyfcpxTC+l1ehdy6N5ZOBa4Mei7M8Xr7eLWflEwjHFLqc4qAQ+Tcdhw/0S+zCpDReLVeAbniFIQVbhQuDvFm1rCMKgcbCDIIHqdDoOGz4Vdl2lhfmGr/WdPM7ATcDHSX4Xzf0G2j+bxCpwhQWG+jc1z3p5YmAtQZxjpsW7Ovn4X0Obhd3l6Ygrr4Xev1yWgK/0i1LMma/DCKJvszXOikyP/FdaCt1XCeKut9M56/1HJEuwdFG7Hg75AleJ/bzZkvaqfDJwnGa2LbdUttVB/Q2/d7TkkqNcsiTqCc4Nv0B0Cl9eoEZKaWgASdSDRnEGLBTb2xYq6AiU/ydh39NDOMeT4M4YX3e5XAv81hOudSICtouJWCrMrRLX1hRP/Vzng2Zf15L4vBvmMin5hn4+kPi6PzCcN9xEcNqnnuxhi2xmu/L40VNDhciVN0RHy33d0WSfvpE731tGcAgod6fhCHoAnINdsD5fpYUecgVoFLTQNZP1JzIb9nnsZ6/I8zWa/lvowVBCR5TvoDgmcrAIfaDqQYOdrZvRqgk2hyB+0U5wHqXHX9JdBfyArocVB9H5cONxOm4A0eWoLJa6M+gcRXuHrkmVxQSJoufzPoZiOl9+ODOkn6oJSNtDOutUpW4D3X83YcHAJJFfUzV16vngaZr6yaJoV/MhRMIMjclVUPB/QxRWXpMKRCkAAAAASUVORK5CYII=" title = "" alt = "L<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">og</span>o" /> is embedded i<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">n a parag</span>r<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">aph</span> and its s<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">iz</span>e is unchanged.</p>
|
||
<h2 id = "link-80">4.5. Interactive fiction</h2>
|
||
<p id = "para-180">Crowbook also adds some syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">interactive</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">fiction</span>, to make <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">embedding</span> Javascript code easier. It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> only enabled <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">interactive</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">fiction</span> renderer. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">For</span> more information, see the <a href = "#chapter-6">chapter on this matter</a>.</p>
|
||
|
||
</div><div id = "chapter-4" class = "chapter">
|
||
<h1 id = 'link-81'><span class = 'chapter-header'>Chapter 5</span><br />Templates</h1><p id = "para-182">Crowbook allows the user to specify a number of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">templates</span>.<a href = "#note-dest-4"><sup id = "note-source-4">[4]</sup></a></p>
|
||
<p id = "para-183">Each of this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span> can be overriden <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> a custom one, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> setting e.g.:</p>
|
||
<pre><span style="color:#268bd2;">html.css</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_template.css</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-184"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">in</span> the book configuration file. The <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span> that you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> most susceptible to modify <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> the following:</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stylesheet</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span>;</li>
|
||
<li><code>epub.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stylesheet</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span>;</li>
|
||
<li><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> of a LaTeX file.</li>
|
||
</ul>
|
||
<h2 id = "link-82">5.1. Create and edit <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></h2>
|
||
<p id = "para-185">Except <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> inline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span>, which are set directly in the book configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>:</p>
|
||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> Template that modify how a chapter title is displayed
|
||
rendering.chapter.template: "{{{loc_chapter}}} {{{number}}}: {{{chapter_title}}}"
|
||
|
||
# CSS code added to default CSS templates (but don't override it)
|
||
html.css.add: "h1 { background-color: red; }"
|
||
epub.css.add: "h1 { background-color: gray; }"
|
||
|
||
# LaTeX code added to default LaTeX template (but doesn't override it)
|
||
template.tex.add: "\usepackage{libertineotf}"
|
||
</span></pre><p id = "para-186"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">most</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span> must be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> a separate <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>:</p>
|
||
<pre><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_template.tex</span><span style="color:#839496;">
|
||
</span></pre><h3 id = "link-83"><code>--print-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></code></h3>
|
||
<p id = "para-187">The easiest way <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> create a new <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> start with the default one. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">In</span> order <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> do so, you can use the <code>--print-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></code> argument:</p>
|
||
<pre><span style="color:#839496;">$ crowbook --print-template tex.template </span><span style="color:#859900;">></span><span style="color:#839496;"> my_template.tex
|
||
</span></pre><p id = "para-188"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">In</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">order</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> get the <code>chapter.xhtml</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> for EPUB3, you’ll also have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> <code>--set epub.version 3</code>:</p>
|
||
<pre><span style="color:#839496;">$ crowbook --print-template epub.chapter.xhtml --</span><span style="color:#859900;">set</span><span style="color:#839496;"> epub.version 3 </span><span style="color:#859900;">></span><span style="color:#839496;"> my_epub3_template.xhtml
|
||
</span></pre><h3 id = "link-84">Mustache syntax</h3>
|
||
<p id = "para-189">Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">uses</span> <a href = "https://crates.io/crates/mustache">rust-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">mustache</span></a> as its <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templating</span> engine, which allows <span title = "Did you mean 'using'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span></span> <a href = "http://mustache.github.io/">Mustache</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">syntax</span> in the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span>.</p>
|
||
<p id = "para-191">It mainly boils down <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">using</span> <code>{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span>}}}</code><a href = "#note-dest-5"><sup id = "note-source-5">[5]</sup></a> to insert the value of variable <code>foo</code> in the document:</p>
|
||
<pre><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1</span><span style="color:#657b83;"> </span><span style="color:#b58900;">class</span><span style="color:#657b83;"> </span><span style="color:#657b83;">=</span><span style="color:#657b83;"> </span><span style="color:#839496;">"</span><span style="color:#657b83;">title</span><span style="color:#839496;">"</span><span style="color:#657b83;"> </span><span style="color:#586e75;">></span><span style="color:#839496;">{{{title}}}</span><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1</span><span style="color:#586e75;">></span><span style="color:#839496;">
|
||
</span><span style="color:#586e75;"><</span><span style="color:#268bd2;">h2</span><span style="color:#657b83;"> </span><span style="color:#b58900;">class</span><span style="color:#657b83;"> </span><span style="color:#657b83;">=</span><span style="color:#657b83;"> </span><span style="color:#839496;">"</span><span style="color:#657b83;">author</span><span style="color:#839496;">"</span><span style="color:#586e75;">></span><span style="color:#839496;">{{{author}}}</span><span style="color:#586e75;"></</span><span style="color:#268bd2;">h2</span><span style="color:#586e75;">></span><span style="color:#839496;">
|
||
</span></pre><p id = "para-192">Mustache also provides the possibility of checking whether a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">variable</span> is set:</p>
|
||
<pre><span style="color:#839496;">{{#foo}}
|
||
Foo exists
|
||
{{/foo}}
|
||
{{^foo}}
|
||
Foo does not exist
|
||
{{^foo}}
|
||
</span></pre><p id = "para-193">Crowbook uses this and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">sets</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">variables</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code>true</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> allow templates <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> conditionally include <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> portions. E.g., in <code>html.css</code>:</p>
|
||
<pre><span style="color:#657b83;">{</span><span style="color:#839496;">{#</span><span style="color:#839496;">lang</span><span style="color:#839496;">_</span><span style="color:#839496;">fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||
</span><span style="color:#586e75;">/*</span><span style="color:#586e75;"> Make list displays '–' instead of bullets </span><span style="color:#586e75;">*/</span><span style="color:#657b83;">
|
||
</span><span style="color:#b58900;">ul</span><span style="color:#657b83;"> </span><span style="color:#b58900;">li</span><span style="color:#657b83;"> </span><span style="color:#657b83;">{</span><span style="color:#839496;">
|
||
</span><span style="color:#859900;">list-style-type</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">'</span><span style="color:#2aa198;">–</span><span style="color:#839496;">'</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||
</span><span style="color:#859900;">padding-left</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#6c71c4;">.5</span><span style="color:#859900;">em</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||
</span><span style="color:#657b83;">}</span><span style="color:#839496;">
|
||
</span><span style="color:#657b83;">{</span><span style="color:#839496;">{/</span><span style="color:#839496;">lang</span><span style="color:#839496;">_</span><span style="color:#839496;">fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||
</span></pre><p id = "para-194"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">In</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> case, Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">sets</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">variable</span> whose name is equal <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>lang_foo</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>true</code>, allowing <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> have different styles for some elements according <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the language.</p>
|
||
<p id = "para-195"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">For</span> more information about Mustache syntax, see the <a href = "http://mustache.github.io/mustache.5.html">Mustache manual</a>.</p>
|
||
<h4 id = "link-85"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Syntax</span> in LaTeX</h4>
|
||
<p id = "para-197">Since LaTeX already uses a lot of curly brackets, the default template sets an altenative <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">syntax</span> to access variables, with <code><<&foo>></code><a href = "#note-dest-6"><sup id = "note-source-6">[6]</sup></a>:</p>
|
||
<pre><span style="color:#859900;">\</span><span style="color:#859900;">title</span><span style="color:#839496;">{</span><span style="color:#839496;"><<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">title>></span><span style="color:#839496;">}</span><span style="color:#839496;">
|
||
</span><span style="color:#859900;">\</span><span style="color:#859900;">author</span><span style="color:#839496;">{</span><span style="color:#839496;"><<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">author>></span><span style="color:#839496;">}</span><span style="color:#839496;">
|
||
<<#has_date>></span><span style="color:#859900;">\</span><span style="color:#859900;">date</span><span style="color:#839496;">{</span><span style="color:#839496;"><<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">date>></span><span style="color:#839496;">}</span><span style="color:#839496;"><</has_date>
|
||
</span></pre> <h3 id = "link-87"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.js</h3>
|
||
<p id = "para-198">The javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">used</span> by both the standalone HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span> and the multiple <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span>.</p>
|
||
<p id = "para-199">This is not currently an actual template, just a plain javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> which cannot contain <code>mustache</code> tags.</p>
|
||
<h3 id = "link-88"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.css</h3>
|
||
<p id = "para-200">The main CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> used by both the standalone HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span> and the multiple <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span>.</p>
|
||
<h3 id = "link-89"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span>.colours</h3>
|
||
<p id = "para-201">A CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> containing only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">colour</span> settings. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">css</span></code>.</p>
|
||
<p id = "para-202">This is not currently an actual template, just a plain CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> which cannot <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contain</span> <code>mustache</code> tags.</p>
|
||
<h3 id = "link-90"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">css</span>.print</h3>
|
||
<p id = "para-203"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">An</span> additional CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> used by both the standalone HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span> and the multiple <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span>. Its purpose is to provide CSS instructions for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">printing</span> (i.e., when the user clicks the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>print</code> button in her browser).</p>
|
||
<p id = "para-204">This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> not currently an actual template, just a plain CSS file which cannot contain <code>mustache</code> tags.</p>
|
||
<h3 id = "link-91"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.highlight.js</h3>
|
||
<p id = "para-205">A javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> used by both HTML renderers to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">highlight</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">codes</span> in <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> blocks. It should be a variant of <a href = "https://highlightjs.org/"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">js</span></a>.</p>
|
||
<p id = "para-206">This is not an actual template, just a plain javascript file.</p>
|
||
<h3 id = "link-92"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.css</h3>
|
||
<p id = "para-207">A CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> used by both HTML renderers to set the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">theme</span> of <a href = "https://highlightjs.org/"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">js</span></a>. It should, though, be <span title = "Use 'a' instead of 'an' if the following word doesn't start with a vowel sound, e.g. 'a sentence', 'a university'" class = "grammar-error">an</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">js</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">theme</span>.</p>
|
||
<p id = "para-208">This is not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">an</span> actual template, just a plain CSS file.</p>
|
||
<h3 id = "link-93"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.standalone.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">js</span></h3>
|
||
<p id = "para-209">A javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> used only by the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">standalone</span> HTML renderer. Its main purpose <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> handle the displaying of a single <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> at a time when <code>one_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> true.</p>
|
||
<h3 id = "link-94"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.standalone.template</h3>
|
||
<p id = "para-210">The main HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">standalone</span> HTML renderer.</p>
|
||
<h3 id = "link-95"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>html</span>.dir.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span></h3>
|
||
<p id = "para-211">The <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">main</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> multiple files HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span>.</p>
|
||
<h3 id = "link-96"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></h3>
|
||
<p id = "para-212">The <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">main</span> (and currently only) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> used by the LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">renderer</span>.</p>
|
||
<h3 id = "link-97"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">epub</span>.chapter.xhtml</h3>
|
||
<p id = "para-213">This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> is the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">main</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> the Epub <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renderer</span>. It contains the XHTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> that will be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">used</span> for each <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span>.</p>
|
||
<h3 id = "link-98"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">epub</span>.css</h3>
|
||
<p id = "para-214">This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">by</span> the Epub <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renderer</span> and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contains</span> the style sheet.</p>
|
||
<h3 id = "link-99">Inline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span></h3>
|
||
<p id = "para-215">Crowbook also has some <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span>, that are set in the book configuration file:</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">add</span></code>, <code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">add</span></code> and <code>epub.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">add</span></code> allow <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> specify <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span> directly <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span> will be added respectively <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></code>, <code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code>epub.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">For</span> CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inserted</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> (allowing <span title = "Did you mean 'redefining'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> redefine</span> rules that are set by the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span>); <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> the LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span>, the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inserted</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span> of the preambule, just before the <code>\begin{document}</code> tag, allowing <span title = "Did you mean 'redefining'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error">to redefine</span> commands.</li>
|
||
<li><code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">name</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">sets</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">name</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span> table of content, if it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> displayed. By default, <span title = "Possible typo: you repeated a word" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span></span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> to <code>{{{loc_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span>}}}</code>, that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span>, a localised version of <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Table of Contents<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">sets</span> the naming scheme <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapters</span>, while <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></code> does the same <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>. These are used <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">only</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> text-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">only</span> output, such as in the TOC. <code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span></code> allow to change the HTML formatting <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">parts</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapters</span>. <em>These options should probably <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">only</span> be used <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you know what you’re doing, as they can break the document.</em> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">If</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">only</span> need to change the name of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapters</span> or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">parts</span>, use <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">part</span></code> and <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span></code> instead.</li>
|
||
</ul>
|
||
<h2 id = "link-100">5.3. List of accessible variables</h2>
|
||
<h3 id = "link-101">Metadata</h3>
|
||
<p id = "para-216">For every template, Crowbook exports <span title = "Consider using 'all the'." class = "grammar-error">all of the</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">metadata</span>:</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"></span>author</code>;</li>
|
||
<li><code>title</code>;</li>
|
||
<li><code>subtitle</code>;</li>
|
||
<li><code>lang</code>;</li>
|
||
<li><code>subject</code>;</li>
|
||
<li><code>description</code>;</li>
|
||
<li><code>license</code>;</li>
|
||
<li><code>version</code>;</li>
|
||
<li><code>date</code>;</li>
|
||
<li>any option <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span></code> defined in the book configuration file will also be exported as <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span></code>.</li>
|
||
</ul>
|
||
<p id = "para-217"><span title = "Did you mean 'this metadata' or ''?" class = "grammar-error">These <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span></span> can contain Markdown, which <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendered</span>. E.g., setting <code>date: <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>20th of **<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">september</span>**<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">render</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>september</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> bold, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">using</span> <code><b></code> tag <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> HTML or <code>\textbf</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> LaTeX. If you need to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> these data <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> places that don’t support formatted text (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">e</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">g</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> meta tags), you can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">raw</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">content</span> by accessing <code>xxx_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">raw</span></code> instead (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">e</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">g</span>., <code>author_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">raw</span></code>, <code>title_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">raw</span></code>, ...). (Note that the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">content</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">raw</span> metadata is <em>not</em> HTML-escaped, so in this case you might want to use <code>{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">xxx</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">raw</span>}}</code> instead of <code>{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">xxx</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">raw</span>}}}</code>.)</p>
|
||
<p id = "para-218"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">For</span> each <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">metadata</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>foo</code> that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span>, Crowbook also inserts a <code>has_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span></code> bool <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> true. This allows <span title = "Did you mean 'using'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> use</span> Mustache’s section <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> some logic, e.g.:</p>
|
||
<pre><span style="color:#839496;">{{{title}}}
|
||
{{#has_version}}, version {{{version}}}{{/has_version}}
|
||
</span></pre><p id = "para-219"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">will</span> avoid rendering <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">version</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> when <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>version</code> is not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span>.</p>
|
||
<h3 id = "link-102">Localisation strings</h3>
|
||
<p id = "para-220"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">For</span> all templates, Crowbook also exports <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">localisation</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">strings</span> <code>loc_foo</code>. They currently include:</p>
|
||
<div class = "table">
|
||
<table>
|
||
<tr>
|
||
<th> Localisation key </th><th> Value in english </th></tr>
|
||
<tr>
|
||
<td> <code>loc_toc</code> </td><td> Table of contents </td></tr>
|
||
<tr>
|
||
<td> <code>loc_cover</code> </td><td> Cover </td></tr>
|
||
<tr>
|
||
<td> <code>loc_title</code> </td><td> Title </td></tr>
|
||
<tr>
|
||
<td> <code>loc_chapter</code> </td><td> Chapter </td></tr>
|
||
<tr>
|
||
<td> <code>loc_part</code> </td><td> Part </td></tr>
|
||
<tr>
|
||
<td> <code>loc_notes</code> </td><td> Notes </td></tr>
|
||
<tr>
|
||
<td> <code>loc_display_all</code> </td><td> Display all chapters </td></tr>
|
||
<tr>
|
||
<td> <code>loc_display_one</code> </td><td> Display one chapter </td></tr>
|
||
|
||
</table>
|
||
</div>
|
||
<h3 id = "link-103"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Template</span>-dependent values</h3>
|
||
<p id = "para-221">Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">exports</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">some</span> additional fields <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">some</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">templates</span>, see below.</p>
|
||
<div class = "table">
|
||
<table>
|
||
<tr>
|
||
<th> Mustache tag </th><th> Value </th><th> Available in... </th></tr>
|
||
<tr>
|
||
<td> <code>content</code> </td><td> A rendered version of the book or chapter’s content </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code>, <code>tex.template</code>, <code>epub.chapter.xhtml</code> </td></tr>
|
||
<tr>
|
||
<td> <code>toc</code> </td><td> A rendered version of the table of contents </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>has_toc</code></td><td> Set to <code>true</code> if the table of contents is not empty </td><td> <code>html.standalone.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>colours</code></td><td> The content of <code>html.css.colours</code> </td><td> <code>html.css</code> </td></tr>
|
||
<tr>
|
||
<td> <code>footer</code> </td><td> The content of <code>html.footer</code> </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>header</code> </td><td> The content of <code>html.header</code> </td><td> <code>html.standalone.template</code>, <code>html.dirtemplate</code> </td></tr>
|
||
<tr>
|
||
<td> <code>script</code> </td><td> The javascript file for this HTML document </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>style</code> </td><td> The CSS file for this HTML document, that is, a rendered version of <code>html.css</code> </td><td> <code>html.standalone.template</code> </td></tr>
|
||
<tr>
|
||
<td> A variable whose name corresponds to <code>lang</code> in book options (e.g. <code>lang_en</code> if lang is set to “en”, <code>lang_fr</code> if it is set to “fr”, ...) </td><td> <code>true</code> </td><td> <code>html.css</code>, <code>epub.css</code> </td></tr>
|
||
<tr>
|
||
<td> <code>chapter_title</code> </td><td> The title of current chapter </td><td> <code>html.dir.template</code>, <code>epub.chapter.xhtml</code>, <code>rendering.chapter.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>chapter_title_raw</code> </td><td> The title of current chapter (raw text without HTML formatting) </td><td> <code>html.dir.template</code>, <code>epub.chapter.xhtml</code>, <code>rendering.chapter.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>json_data</code> </td><td> Contains structured data with book’s metadata in JSON-LD format </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>highlight_code</code> </td><td> True if <code>html.highlight_code</code> is true </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>highlight_css</code> </td><td> The content of <code>html.highlight.css</code> </td><td> <code>html.standalone.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>highlight_js</code> </td><td> The base64-encoded content of <code>html.highlight.js</code> </td><td> <code>html.standalone.tempate</code> </td></tr>
|
||
<tr>
|
||
<td> <code>common_script</code> </td><td> The content of <code>html.js</code> </td><td> <code>html.single.js</code> </td></tr>
|
||
<tr>
|
||
<td> <code>one_chapter</code> </td><td> True if <code>html.standalone.one_chapter</code> is true, else not present </td><td> <code>html.standalone.template</code>, <code>html.standalone.js</code> </td></tr>
|
||
<tr>
|
||
<td> <code>book.svg</code> </td><td> The base64-encoded image of the button to display all chapters </td><td> <code>html.standalone.js</code>, <code>html.standalone.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>pages.svg</code> </td><td> The base64-encoded image of the button to display one chapter at a time </td><td> <code>html.standalone.js</code>, <code>html.standalone.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>favicon</code> </td><td> The <code><link rel = “icon” ...></code> tag if <code>html.icon</code> is set </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>menu_svg</code> </td><td> The base64-encoded image of the hamburger menu image </td><td> <code>html.standalone.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>prev_chapter</code> </td><td> Title and a link of previous chapter </td><td> <code>html.dir.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>next_chapter</code> </td><td> Title and a link of nexts chapter </td><td> <code>html.dir.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>class</code> </td><td> The content of <code>tex.class</code> </td><td> <code>tex.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>book</code> </td><td> True if <code>tex.class</code> is <code>book</code>, not set else </td><td> <code>tex.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>tex_lang</code> </td><td> The babel equivalent of <code>lang</code> </td><td> <code>tex.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>tex_title</code> </td><td> Set to true to run <code>\maketitle</code> </td><td> <code>tex.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>tex_size</code> </td><td> The font size to pass to the LaTeX class </td><td> <code>tex.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>has_tex_size</code> </td><td> Set to true if <code>tex_size</code> is set </td><td> <code>tex.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>margin_left</code>, <code>margin_right</code>, <code>margin_top</code>, <code>margin_bottom</code> </td><td> The margins of the document </td><td> <code>tex.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>initials</code> </td><td> True if <code>rendering.initials</code> is true, not set else </td><td> <code>tex.template</code> </td></tr>
|
||
<tr>
|
||
<td> <code>additional_code</code> </td><td> Set to the content of <code>tex.template.add</code>, <code>html.css.add</code> or <code>epub.css.add</code> </td><td> <code>tex.template</code>, <code>html.css</code>, <code>epub.css</code> </td></tr>
|
||
|
||
</table>
|
||
</div>
|
||
|
||
</div><div id = "chapter-5" class = "chapter">
|
||
<h1 id = 'link-104'><span class = 'chapter-header'>Chapter 6</span><br />Proofreading with Crowbook</h1><p id = "para-222">Crowbook includes some <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">proofreading</span> features, that can be enabled if you set one of the</p>
|
||
<ul>
|
||
<li><code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.html</code></li>
|
||
<li><code>output.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.html_dir</code></li>
|
||
<li><code>output.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.pdf</code></li>
|
||
</ul>
|
||
<p id = "para-223"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>output</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> (or include <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">pdf</span></code> in the list of formats <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> render <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>output</code>). This allows you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> generate different <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">publishing</span> and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofreading</span> (you probably don’t want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">publish</span> a version that highlights <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> grammar errors or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> repetitions).</p>
|
||
<p id = "para-224">Current <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofreading</span> features are:</p>
|
||
<ul>
|
||
<li><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>repetition</span> detection;</li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">grammar</span> check.</li>
|
||
</ul>
|
||
<h2 id = "link-105">6.1. Enabling <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofreading</span></h2>
|
||
<p id = "para-225">Since <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofreading</span> can take quite a lot of time, particularly for a long book, it is disabled by default. You’ll have to run</p>
|
||
<pre><span style="color:#839496;">$ crowbook --proofread my.book
|
||
</span></pre><p id = "para-226"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"></span>or</p>
|
||
<pre><span style="color:#839496;">$ crowbook -p my.book
|
||
</span></pre><p id = "para-227"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>to</span> generate proofreading copies. Alternatively, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">want</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> be activated each time you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">run</span> <code>crowbook</code> on this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> (which is <em>not</em> recommanded for long <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">books</span>, particularly <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">want</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> perform a grammar check), you can set</p>
|
||
<pre><span style="color:#268bd2;">proofread</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#b58900;">true</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-228"><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">in</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span> configuration file.</p>
|
||
<h2 id = "link-106">6.2. Repetition detection</h2>
|
||
<p id = "para-229"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Repetition</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">detection</span> is enabled with:</p>
|
||
<pre><span style="color:#268bd2;">proofread.repetitions</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#b58900;">true</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-230">It uses <a href = "https://github.com/lise-henry/caribon">Caribon</a> library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">detect</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetition</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> your text. Since the notion of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetition</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> relatively arbitrary, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> adapt the settings. Default are:</p>
|
||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> The maximum distance between two identical words to
|
||
# consider them a repetition
|
||
proofread.repetitions.max_distance: 25
|
||
# The minimal number of occurences to consider it a repetition
|
||
proofread.repetitions.threshold: 2.0
|
||
# Ignore proper nouns (words starting by a capital,
|
||
# not at a beginning of a sentence)
|
||
proofread.repetitions.ignore_proper: true
|
||
|
||
# Activate fuzzy string matching
|
||
proofread.repetitions.fuzzy: true
|
||
# The maximal ratio of difference to consider
|
||
# that two words are identical
|
||
# (E.g., with 0.2, "Rust" and "Lust" won't be
|
||
# considered as the same word, but they will be with 0.5)
|
||
proofread.repetitions.fuzzy.threshold: 0.2
|
||
</span></pre><p id = "para-231">For more information, see <a href = "https://github.com/lise-henry/caribon">Caribon</a>’s documentation.</p>
|
||
<blockquote><p id = "para-232">Currently, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> not displayed in PDF proofreading output.</p>
|
||
</blockquote>
|
||
<h2 id = "link-107">6.3. Grammar checking</h2>
|
||
<h3 id = "link-108">With Languagetool</h3>
|
||
<p id = "para-233">Crowbook can use <a href = "https://languagetool.org/">LanguageTool</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> detect <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">grammar</span> errors <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> your text. It is, however, a bit more complex <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> activate.</p>
|
||
<p id = "para-234">First, you’ll have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">activate</span> this feature <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> book configuration file:</p>
|
||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> Activate language tool support
|
||
proofread.languagetool: true
|
||
# (Optional) Sets the port number to connect to (default below)
|
||
proofread.languagetool.port: 8081
|
||
</span></pre><p id = "para-235">You’<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">ll</span> then <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">have</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> download the stand-alone version of <a href = "https://languagetool.org/">LanguageTool</a>. It includes a server mode, which you’<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">ll</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">have</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> launch:</p>
|
||
<pre><span style="color:#839496;">$ </span><span style="color:#859900;">java</span><span style="color:#839496;"> -</span><span style="color:#859900;">cp</span><span style="color:#839496;"> languagetool-server.</span><span style="color:#859900;">jar</span><span style="color:#839496;"> org.languagetool.server.HTTPServer --port 8081
|
||
</span></pre><p id = "para-236">You can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> use the LanguageTool GUI (<code>languagetool.jar</code>) and start the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">server</span> from the menu <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Text Checking -> Options<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>. This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> allows you to configure LanguageTool more precisely by activating or deactivating rules.</p>
|
||
<p id = "para-237">You can then run Crowbook, and it will highlight grammar errors in HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> PDF proofreading output files.</p>
|
||
<blockquote><p id = "para-238">Note: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">running</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">grammar</span> check on a long book (like a novel) can take up to a few minutes.</p>
|
||
</blockquote>
|
||
<h3 id = "link-109">With Grammalecte</h3>
|
||
<p id = "para-239"><a href = "http://grammalecte.net/">Grammalecte</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">grammar</span> checker specialized for the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">french</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span>. If the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">language</span> of your book <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">french</span>, you can use it <span title = "Consider replacing 'in a similar fashion' with adverb for 'similar'; eg, 'in a hasty manner' with 'hastily'." class = "grammar-error">in a similar fashion</span> to languagetool:</p>
|
||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> Activate grammalecte support
|
||
proofread.grammalecte: true
|
||
# (Optional) Sets the port number to connect to (default below)
|
||
proofread.grammalecte.port: 8080
|
||
</span></pre><p id = "para-240">You’ll also need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> run the Grammalecte <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">server</span>. First <a href = "https://www.dicollecte.org/#download_div">download the CLI and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">server</span> version</a>, then:</p>
|
||
<pre><span style="color:#839496;">$ </span><span style="color:#859900;">python3</span><span style="color:#839496;"> server.</span><span style="color:#859900;">py</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-241">You can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">then</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">run</span> Crowbook with <code>--proofread</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> check the grammar of your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span>. It is possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">run</span> both LanguageTool and Grammalecte on the same <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span> (though might take a while for a long <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">book</span>...).</p>
|
||
|
||
</div><div id = "chapter-6" class = "chapter">
|
||
<h1 id = 'link-110'><span class = 'chapter-header'>Chapter 7</span><br />Interactive fiction</h1><p id = "para-242">Version <code>0.12.0</code> added experimental support for writing <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">interactive</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fiction</span>.</p>
|
||
<blockquote><p id = "para-243">Since this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">support</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">experimental</span>, it means it can change at anytime, and there <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> no guarentee that the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">interactive</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">fiction</span> you write for the current version of Crowbook will work with the next <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">release</span>, even if it isn’t a major <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">release</span>.</p>
|
||
</blockquote>
|
||
<h2 id = "link-111">7.1. Basics</h2>
|
||
<p id = "para-244"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">If</span> you want to have a non-linear story, you can simply use Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">links</span> just as you would for any other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">link</span>:</p>
|
||
<pre><span style="color:#839496;">*</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#839496;">Open the treasure chest</span><span style="color:#839496;">]</span><span style="color:#839496;">(</span><span style="color:#2aa198;">open_chest.md</span><span style="color:#839496;">)</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;">*</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#839496;">It might be trapped, stay away from it</span><span style="color:#839496;">]</span><span style="color:#839496;">(</span><span style="color:#2aa198;">stay_away.md</span><span style="color:#839496;">)</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-245"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">All</span> Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">renderers</span> should <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">render</span> this correctly, allowing the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">reader</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>choose her adventure<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>. Note, however, that you still need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> include <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">all</span> these Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> in you book configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>.</p>
|
||
<h2 id = "link-112">7.2. The interactive fiction renderer</h2>
|
||
<p id = "para-246">While the above allows you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> generate correct EPUB and PDF <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">files</span>, it will still display all the content if the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">reader</span> chooses <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> read your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> linearly. While this may not be a problem, you might want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> only display the part of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> that the reader is actually exploring.</p>
|
||
<p id = "para-247">In order <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> do so, you can use the interactive fiction html <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span>:</p>
|
||
<pre><span style="color:#268bd2;">output.html.if</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_book.html</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-248">This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> similar <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the standalone HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span>, except the option <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> only a chapter at a time <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> always true, and there <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> no way <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> the table of contents.</p>
|
||
<h2 id = "link-113">7.3. Using Javascript in your interactive fiction</h2>
|
||
<p id = "para-249">While the above allows the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">reader</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> choose his own path, its <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">interactivity</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> quite limited. With the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">interactive</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fiction</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span>, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> include Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> in your Markdown files, using a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> block element:</p>
|
||
<pre><span style="color:#839496;">You open the chest, and you find a shiny sword. Yay!
|
||
</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;"> user_has_sword = true;
|
||
</span></pre><p id = "para-250">This Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> can return a string value, which will be displayed inside the document according to the reader’s previous choices:</p>
|
||
<pre><span style="color:#839496;">You encounter a goblin, armed with a knife!
|
||
</span><span style="color:#839496;">
|
||
</span><span style="color:#839496;"> if (user_has_sword) {
|
||
</span><span style="color:#839496;"> return "You kill him with your sword, congratulations!";
|
||
</span><span style="color:#839496;"> } else {
|
||
</span><span style="color:#839496;"> return "You don't have any weapon, you die :(";
|
||
</span><span style="color:#839496;"> }
|
||
</span></pre><blockquote><p id = "para-251">Note that <em>only</em> the interactive fiction <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renderer</span> supports this way of embedding Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span>. If you try <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">render</span> a document containing such <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> EPUB, PDF, or the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>normal<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renderer</span>, they will be displayed as regular <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span>.</p>
|
||
</blockquote>
|
||
<h2 id = "link-114">7.4. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Embedding</span> Makdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">embedded</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> Markdown</h2>
|
||
<p id = "para-252">If you want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> include Markdown formatting <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> the Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> display a passage or another without having <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> write HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span>), you can use the <code>@<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>...<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>@</code> syntax:</p>
|
||
<pre><span style="color:#839496;"> @"You face a troll!"@
|
||
</span><span style="color:#839496;"> if (user_has_sword) {
|
||
</span><span style="color:#839496;"> @"* [Attack him with your sword](fight_troll.md)"@
|
||
</span><span style="color:#839496;"> } else {
|
||
</span><span style="color:#839496;"> @"* [Better run away](run_away.md)"@
|
||
</span><span style="color:#839496;"> }
|
||
</span></pre><p id = "para-253">Note that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> case you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">don</span>'<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">t</span> need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> return a value, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> is done behind your back. Similarly, <code>@<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>...<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>@</code> blocks <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">don</span>'<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">t</span> require semicolons.</p>
|
||
<p id = "para-254">If you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">need</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> access the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">value</span> of a Javascript variable inside <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">this</span> Markdown code, you can use the <code>{{...}}</code> syntax:</p>
|
||
<pre><span style="color:#839496;"> var name = prompt("Enter your name", "world");
|
||
</span><span style="color:#839496;"> @"Hello, {{name}}"@
|
||
</span></pre><h2 id = "link-115">7.5. Conditional blocks</h2>
|
||
<p id = "para-255">Sometimes, you want some text (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> only be displayed (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> run) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> the reader reads this passage the first time, <span title = "Consider using 'or'." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> alternatively</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> she goes back <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> it. While it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> trivial <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> add some <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> check that, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> a common enough pattern <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> justify its own variant : you’ll juste have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> insert a named <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> block with the number:</p>
|
||
<pre><span style="color:#839496;">```1
|
||
@"Only displayed at first passage"@
|
||
```
|
||
|
||
```2
|
||
@"Only displayed at second passage"@
|
||
```
|
||
|
||
```>2
|
||
@"Displayed at passage 3, 4 and so on.
|
||
```
|
||
</span></pre><h2 id = "link-116">7.6. Interactive fiction options</h2>
|
||
<p id = "para-256">As other renderers, there are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> specific <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">interactive</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fiction</span>.</p>
|
||
<p id = "para-257"><b><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.if.new_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">game</span></b> allows you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> the path <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> a Javascript<span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span>that will be run <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">beginning</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">game</span>. Since this code <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> not embedded in a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">function</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the root (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">beginning</span>) of the document, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> a good place to declare all the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">functions</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> the global variables you might need for your interactive fiction mechanics. e.g.:</p>
|
||
<pre><span style="color:#268bd2;">html.if.new_game</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">some_file.js</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-258"><b><span title = "This sentence does not start with an uppercase letter" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span>.new_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">turn</span></b> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <b><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">turn</span></b> allow you to specify some Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> that will be executed at the beginning <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span> of each segment. Unlike <code>html.if.new_game</code>, the (usually shorter) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> specified inline, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> can return a string value that will be displayed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">beginning</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">each</span> segment. This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> exactly like including code blocks <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">beginning</span> or the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">each</span> of your Markdown file. E.g.:</p>
|
||
<pre><span style="color:#268bd2;">html.if.new_turn</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">nb_turns += 1;</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">html.end_turn</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">return 'Turn: ' + nb_turns;</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-259"><b><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.if.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">script</span></b> allows you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> specify the name of a Javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> override the default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">script</span>.</p>
|
||
|
||
</div><div id = "chapter-7" class = "chapter">
|
||
<h1 id = 'link-117'><span class = 'chapter-header'>Chapter 8</span><br />Tips and tricks</h1><h2 id = "link-118">8.1. Using Crowbook with Emacs’ markdown mode</h2>
|
||
<p id = "para-260">If you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> <a href = "https://www.gnu.org/software/emacs/">Emacs</a> as a text editor, there is a nice <a href = "http://jblevins.org/projects/markdown-mode/">Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">mode</span></a> to edit Markdown files.</p>
|
||
<p id = "para-261">It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> Crowbook for HTML previewing in this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">mode</span>, which <a href = "http://xkcd.com/1742/">requires only minimal configuration and tweaking</a>:</p>
|
||
<pre><span style="color:#839496;">(</span><span style="color:#839496;">custom</span><span style="color:#657b83;">-</span><span style="color:#859900;">set</span><span style="color:#657b83;">-</span><span style="color:#839496;">variables
|
||
'</span><span style="color:#839496;">(</span><span style="color:#839496;">markdown</span><span style="color:#657b83;">-</span><span style="color:#839496;">command </span><span style="color:#839496;">"</span><span style="color:#2aa198;">crowbook - -qs --to html --output -</span><span style="color:#839496;">"</span><span style="color:#839496;">)</span><span style="color:#839496;">)</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-262">You can then <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">markdown</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">preview</span></code> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code><span title = "Possible typo: you repeated a word" class = "grammar-error">C-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">c</span> C-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">c</span></span> p</code>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">run</span> Crowbook on this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">preview</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">browser</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">run</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">markdown</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">live</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">preview</span>-mode</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> see a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">live</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">preview</span> (updated each time you save <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> Emacs’ integrated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">browser</span>.</p>
|
||
<h3 id = "link-119">Some explanations if it looks a bit cryptic <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> you</h3>
|
||
<p id = "para-263">We set <code>markdown-command</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>crowbook</code>, the reason for this is a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">bit</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">obvious</span>. The arguments we give <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> might be a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">bit</span> less <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">obvious</span>:</p>
|
||
<ul>
|
||
<li><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">the</span> fist <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">argument</span>, <code>-</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> actually the book <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>: it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tells</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>crowbook</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> read it from standard input.</li>
|
||
<li><code>-qs</code> or <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">quiet</span> --single</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tells</span> Crowbook that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span title = "Possible typo: you repeated a word" class = "grammar-error"><span title = "Use 'an' instead of 'a' if the following word starts with a vowel sound, e.g. 'an article', 'an hour'" class = "grammar-error">a</span> a</span> standalone markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> not a book configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> a bit <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">quiet</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> error/info messages;</li>
|
||
<li><code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span></code> specifies that HTML must <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> generated;</li>
|
||
<li><code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span> -</code> tells Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> display the result <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> the stdout, even if you set <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>some_file.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span></code>.</li>
|
||
</ul>
|
||
<h2 id = "link-120">8.2. Embedding fonts in an EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span></h2>
|
||
<p id = "para-264"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">In</span> order <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> embed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fonts</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">an</span> EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>, you’ll <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">first</span> have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> edit the stylesheet, which you can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">first</span> obtain with:</p>
|
||
<pre><span style="color:#839496;">$ crowbook --print-template epub.css </span><span style="color:#859900;">></span><span style="color:#839496;"> my_epub_stylesheet.css
|
||
</span></pre><p id = "para-265">You’<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ll</span> need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> use the <a href = "https://developer.mozilla.org/fr/docs/Web/CSS/@font-face"><code>@font-face</code> attribute</a>:</p>
|
||
<pre><span style="color:#859900;">@</span><span style="color:#859900;">font-face</span><span style="color:#839496;"> </span><span style="color:#657b83;">{</span><span style="color:#839496;">
|
||
</span><span style="color:#859900;">font-family</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">MyFont</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||
</span><span style="color:#859900;">src</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#859900;">url</span><span style="color:#839496;">(</span><span style="color:#2aa198;">d</span><span style="color:#2aa198;">a</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">a</span><span style="color:#2aa198;">/</span><span style="color:#2aa198;">m</span><span style="color:#2aa198;">y</span><span style="color:#2aa198;">_</span><span style="color:#2aa198;">f</span><span style="color:#2aa198;">o</span><span style="color:#2aa198;">n</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">.</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">f</span><span style="color:#839496;">)</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||
</span><span style="color:#657b83;">}</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-266">Then you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> add <code>my_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">font</span>.ttf</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">need</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> be added <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the EPUB zip <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>:</p>
|
||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">My Book</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Me</span><span style="color:#839496;">
|
||
|
||
</span><span style="color:#268bd2;">cover</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">cover.png</span><span style="color:#839496;">
|
||
</span><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">book.epub</span><span style="color:#839496;">
|
||
|
||
</span><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">my_font.ttf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||
</span></pre><p id = "para-267">(Note <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> you’ll have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> repeat the process for the different <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">font</span>-weight</code> and <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">font</span>-style</code> variants of your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">font</span> if you want it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> display correctly when there is some text in <b>bold</b>, <em>italics</em>, or <b><em>both</em></b>.)</p>
|
||
|
||
</div><div id = "chapter-8" class = "chapter">
|
||
<h1 id = 'link-121'><span class = 'chapter-header'>Chapter 9</span><br />Contributing</h1><p id = "para-268">Crowbook is a free software, and you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contribute</span> to it. There are some things that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> be accessible even if you don’t know anything about programming.</p>
|
||
<h2 id = "link-122">9.1. Internationalization</h2>
|
||
<p id = "para-269">Crowbook aims <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">support</span> multiple languages. However, unfortunately, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">currently</span> only english, french, and (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> a more limited way) spanish <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">currently</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">supported</span>. If you want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> have better <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">support</span> for the language you write <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span>, there <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> easy things you can do:</p>
|
||
<ul>
|
||
<li>Provide a translation <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> the few strings that Crowbook insert into the rendered documents. This is really <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">easy</span>, as there are currently less than a dozen of them, and you just need to create a new variant of the <a href = "https://github.com/lise-henry/crowbook/blob/master/lang/en.yaml"><code>lang/en.yaml</code></a> file.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Open</span> an <a href = "https://github.com/lise-henry/crowbook/issues">issue</a> about the typographic rules in your language, if Crowbook doesn’t cover them.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Provide</span> a translation for the Crowbook program. It requires creating a variant of the <a href = "https://github.com/lise-henry/crowbook/blob/master/lang/fr.po"><code>.po</code> file</a>, which is a bit more work because (at <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">this</span> time) it’s around 1,500 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">lines</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> less a priority than the first item of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">this</span> list, as <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">this</span> translation only affects <span title = "Possible typo: you repeated a word" class = "grammar-error"><span title = "Maybe you need to remove one determiner so that only 'the' or 'the' is left." class = "grammar-error"></span>the the</span> command-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">line</span> interface <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> not the rendered documents).</li>
|
||
</ul>
|
||
|
||
</div><div id = "chapter-9" class = "chapter">
|
||
<h1 id = 'link-123'>ChangeLog</h1><h2 id = "link-124">0.14.0-beta (2017-10-08)</h2>
|
||
<ul>
|
||
<li>Bugfixes:<ul>
|
||
<li>EPUB: escape quotes <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> content.opf.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">LaTeX</span>/PDF: allow hyphenations <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> typewriter font.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">User</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">interface</span>:<ul>
|
||
<li>User <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">interface</span> is quite fancier, with progress bars and all</li>
|
||
<li>Debug/warning/info levels should be displayed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> a more coherent manner</li>
|
||
<li>New <code>--no-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fancy</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you don’<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">t</span> like the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fancy</span> UI (or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> it doesn’<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">t</span> work <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> your terminal)</li>
|
||
<li>New <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">force</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">emoji</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span> to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">force</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">emoji</span> usage.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Library</span> interface:<ul>
|
||
<li>Removed <code>Book::set_verbosity</code> method (uses a logger <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">library</span> instead).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Now</span> requires rustc >= 1.20.0</li>
|
||
</ul>
|
||
<h2 id = "link-125">0.13.0 (2017-07-14)</h2>
|
||
<ul>
|
||
<li>Breaking changes:<ul>
|
||
<li>The <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span>.tex</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span> was quite modified. Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">uses</span> custom command for most markdown elements, defined in the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">template</span>. This allow <span title = "Use 'a' instead of 'an' if the following word doesn't start with a vowel sound, e.g. 'a sentence', 'a university'" class = "grammar-error">an</span> user <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> redefine the way the book <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> rendered without having <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> modify Crowbook itself. Unfortunately, as tex <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span> for previous Crowbook versions won’t work anymore.</li>
|
||
<li>the <code>resources.files</code> option <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> now a YAML list of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">strings</span>, instead of a comma-seprated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">string</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Add</span> support for grammalecte grammar checker.</li>
|
||
<li><code>crowbook</code> command takes a new argument, <code>-S</code> or <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stats</span></code> which displays <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stats</span> on the book (currently, words and characters count).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Interactive</span> fiction:<ul>
|
||
<li>Added conditional blocks.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>Options</span>:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.xxx</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">options</span> can now take the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>auto<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> value, which will infer the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">name</span> based on the book <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">name</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>output</code> is a new <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">option</span> that can specify a series of format <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> render, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">name</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">grammalecte</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">grammalecte</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">port</span></code> allow respectively <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> enable grammar checking <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> Grammalecte <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">optionnally</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">port</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> connect.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.left</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.right</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.bottom</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margin</span>.top</code> are new <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> that allow <span title = "Did you mean 'specifying'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span></span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">margins</span> for LaTeX/PDF outputs.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">paper</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">size</span></code> was renamed <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">paper</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">size</span></code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li>HTML:<ul>
|
||
<li>Add JSON-LD structured data <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the book’s HTML files.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>LaTeX: fix rendering of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">part</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">part</span> previously displayed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> and its first <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">part</span>)</li>
|
||
<li>EPUB:<ul>
|
||
<li>Fix <code>.rule</code> so it is centered despite KOBO CSS injection.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Fix</span> resources/images inclusion when they are symlinks to the actual file.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-126">0.12.0 (2017-06-05)</h2>
|
||
<p id = "para-270">This release <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">includes</span> a few new features, such <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> the possiblity <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">include</span> Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> section/subsections <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> not only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> chapter, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">experimental</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">support</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> superscript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> subscript, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> yet more <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">experimental</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">support</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> writing interactive fiction.</p>
|
||
<ul>
|
||
<li>Book configuration file:<ul>
|
||
<li>It is now possible to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">include</span> subchapters using the <code>--</code> command (with one dash per sublevel: <code>--- <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">foo</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">md</span></code> will <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">include</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">foo</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">md</span></code> as a subsection).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Markdown</span>:<ul>
|
||
<li>Added support for superscript and subscript features, using respectively <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">foo</span>^up^</code> or <code>bar~down~</code> syntax.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">New</span> options:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">change</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">what</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">displayed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">place</span> of <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>chapter<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">change</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">what</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">displayed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">place</span> of <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>part<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span></code> allow <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> tune a little how the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapters</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">parts</span> are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">displayed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> HTML.</li>
|
||
<li><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">hyperref</span></code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>false</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> disable <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">hyperrefs</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> local links. Can be useful <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> some files.</li>
|
||
<li><code>crowbook.html_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">text</span></code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">false</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> not treat HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">text</span> but ignore it.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>subtitle</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">as</span> its name suggest, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">subtitle</span> of a book.</li>
|
||
<li><code>crowbook.markdown.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">superscript</span></code> can enable or disable <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">superscript</span>/subscript <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>extension<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Rendering</span>:<ul>
|
||
<li>Change the way chapters <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> displayed by default.</li>
|
||
<li>PDF output now has a better-looking (hopefully) title page.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Internal</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">links</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> a bit more flexible, e.g. if you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">link</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>Readme.html</code> it will now try <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">link</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the chapter corresponding <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>Readme.md</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>LaTeX:<ul>
|
||
<li>Fix bug in syntax highlighting.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>Fix</span> label placements (and thus navigation inside PDF document).</li>
|
||
</ul>
|
||
</li>
|
||
<li>EPUB:<ul>
|
||
<li>Add unnamed but numbered <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapters</span> to the TOC.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>Fix</span> HTML escaping <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">issue</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> titles.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span title = "Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym." class = "grammar-error"></span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>Fix</span> the way <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">parts</span> were handled in the TOC.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Book</span> configuration file:<ul>
|
||
<li>Fix <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">issue</span> when setting custom number <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">parts</span>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Crowbook</span> now requires rustc >= 1.17.0</li>
|
||
</ul>
|
||
<h2 id = "link-127">0.11.4 (2017-03-21)</h2>
|
||
<ul>
|
||
<li>An image can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> be considered standalone even if it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> inside a link.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>HTML/EPUB: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">raw</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> HTML rendered) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">metadata</span> in the places where HTML code <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> appropriate. Templates can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">metadata</span> with the <code>foo_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">raw</span></code> value.</li>
|
||
<li>HTML/EPUB: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fix</span> double-escaping/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">issues</span> in <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">titles</span>.</li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">EPUB</span>:<ul>
|
||
<li>Escape <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">title</span> and author before feeding them to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">epub</span>-builder.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Fix</span> content.opf <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">issue</span> by not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span> first chapter’s <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">title</span> (marked as beginning of document) in <code><guide></code>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>Rendering</span>:<ul>
|
||
<li>HTML/EPUB: standalone images are now displayed centered.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-128">0.11.3 (2017-03-19)</h2>
|
||
<ul>
|
||
<li>When crowbook parses the book’s contents, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> detects which <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">features</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">used</span>. This is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">useful</span> in various ways:<ul>
|
||
<li>The ODT renderer only displays a global <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">warning</span> showing the lists of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">features</span> that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> not implemented, instead of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">warning</span> each <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">time</span> such a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">feature</span> is encountered.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">The</span> LaTeX and HTML/EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderers</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">only</span> initialize <code>syntect</code> (which can take some <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">time</span>) if code blocks <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">document</span>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">The</span> LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">only</span> requires LaTeX packages that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> actually <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">document</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Command-line</span> interface:<ul>
|
||
<li>Warnings <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> now displayed by default.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">The</span> (undocumented) <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">debug</span></code> argument <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">has</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">been</span> removed.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">The</span> status of some messages have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">been</span> modified (<span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>warning<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>debug<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> or <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>error<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>warning<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Deprecated</span> option:<ul>
|
||
<li><code>crowbook.verbose</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">has</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">been</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">deprecated</span>, at it should be set by the CLI.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-129">0.11.2 (2017-03-05)</h2>
|
||
<ul>
|
||
<li>General:<ul>
|
||
<li>When there <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">an</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">error</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">setting</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">an</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span> from the book configuration file (e.g. because it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">an</span> invalid key), print <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">an</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">error</span> but do not abort, only ignore this specific <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">New</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span>:<ul>
|
||
<li><code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stdpage</span></code>: if set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>true</code>, will use the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>stdpage</code> package <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">render</span> the book according <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> standards <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> submitting manuscripts.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">theme</span></code> allows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span title = "The verb after 'to' should be in the base form: 'specify'." class = "grammar-error">specifies</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">theme</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlighting</span> (only used if <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span></code> is set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>syntect<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>).</li>
|
||
<li><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">theme</span></code>, <code>epub.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">theme</span></code> and <code>tex.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">theme</span></code> allow <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> specify a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">theme</span> for HTML/EPUB/LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">renderers</span> (only used with <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">syntect</span>).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Deprecated</span> option:<ul>
|
||
<li><code>proofread.nb_spaces</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>Rendering</span>:<ul>
|
||
<li><code>[<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">syntect</span>](https://<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crates</span>.io/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crates</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">syntect</span>)</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">default</span> for <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span></code>. Concretely, this means that by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">default</span> syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlighting</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> done when <code>crowbook</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> run instead of using <code>[<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.js](https://<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlightjs</span>.org/)</code>.</li>
|
||
<li>EPUB:<ul>
|
||
<li>Now sets the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cover</span>-image<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> property and meta so readers <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">should</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">display</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cover</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">correctly</span>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Narrow</span> non-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">breaking</span> spaces <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">should</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">display</span> more <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">correctly</span> on KOBO ereaders (hoping this won’t <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">break</span> the way they are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">displayed</span> everywhere else).</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Proofreading</span>:<ul>
|
||
<li>Repetition detection is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> a bit <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">less</span> of <span title = "Use 'a' instead of 'an' if the following word doesn't start with a vowel sound, e.g. 'a sentence', 'a university'" class = "grammar-error">an</span> hack, and should cause <span title = "Did you mean 'fewer'? The noun problems is countable." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>less</span> problems when used in conjunction with grammar checking. It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> also works on PDF output (so the way it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> highlighted could be improved).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>Fix <code>mimetype</code> of EPUB files (make sure it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> always <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>stored<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>deflated<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> by the <code>zip</code> command).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Avoid</span> initializing <code>syntect</code> (at the cost of performances) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> used.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Avoid</span> creating an empty file <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> some book renderer fails (e.g. EPUB or ODT because <code>zip</code> command <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> present).</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-130">0.11.1 (2017-01-05)</h2>
|
||
<ul>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Rendering</span>:<ul>
|
||
<li>Avoid page break before <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> after a separating rule.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Add</span> support <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> <a href = "https://crates.io/crates/syntect"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>syntect</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlighting</span>. This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> activated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> setting <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>syntect</code> (see below).</li>
|
||
<li>EPUB:<ul>
|
||
<li>Set back HTML escape of narrow non-breaking spaces <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>true</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> default (it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">caused</span> problems on some readers, but <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cause</span> much <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">more</span> serious one if <code>false</code>).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Add</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">more</span> information <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> guide/nav landmarks.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">LaTeX</span>/PDF:<ul>
|
||
<li>Improve the way <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">blocks</span> are displayed, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">using</span> the <code>mdframed</code> package.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Try</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> reduce the issues of too long lines when <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">using</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">blocks</span>, by inserting <code>\allowbreak{}</code> directive after some characters (<code>.</code>, <code>/</code>, <code>_</code>, ...).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>Block</span> quotes are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> displayed in italics.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Tables</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> <code>tabularx</code>, which allows <span title = "Did you mean 'breaking'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">break</span></span> too long lines (it still doesn’t <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">break</span> pages, though).</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">New</span> options:<ul>
|
||
<li><code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">highlight</span></code> can be set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <code>none</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">highlight</span>.js</code> (by default, enables syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">highlighting</span> via Javascript, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">but</span> only on HTML document) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code>syntect</code> (doesn’t necessitate javascript, and can work in EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> LaTeX, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">but</span> more experimental at this point).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Deprecated</span> options:<ul>
|
||
<li><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span></code> (use <code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">highlight</span></code> instead).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>HTML (standalone): fix the template that contained invalid HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-131">0.11.0 (2016-12-31)</h2>
|
||
<p id = "para-271">Substantial changes in this release, the more important one being support for parts!</p>
|
||
<ul>
|
||
<li><b><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Breaking</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">changes</span></b>: the API has undergone some <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">breaking</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">changes</span>, hoping they will <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> the last <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ones</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> a while. API should <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">now</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> more simple and consistent (?). This version contains also substantial options renaming (see below).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Crowbook</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">now</span> supports parts (above the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>chapter<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> level), using the ‘@’ character in the book configuration file.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Command-line</span> interface:<ul>
|
||
<li>Behaviour of <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span></code> should <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">now</span> be consistent for all <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">output</span> formats.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>If</span> <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">output</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>-</code>, prints <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> stdout.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Conversely</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> <code><BOOK></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>-</code>, reads from stdin.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Path</span> specified by <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">output</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">now</span> interpreted relatively <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> current directory (and not depending on where <code><BOOK></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> or its options).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Rendering</span>:<ul>
|
||
<li>Chapters with no <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">titles</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">now</span> have an empty <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">title</span> added (so it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> at least <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">display</span> e.g. <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Chapter X<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>).</li>
|
||
<li>EPUB:<ul>
|
||
<li>The <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">toc</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ncx</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">now</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">displays</span> links to <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>title<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> and (if set) <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>cover<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> be deactivated, see <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">below</span>).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">The</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">toc</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ncx</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">now</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">displays</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">toc</span> levels <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">below</span> chapter.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">The</span> table of contents <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">now</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">displayed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span> if <code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">toc</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>true</code>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">New</span> options:<ul>
|
||
<li><code>epub.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">toc</span>.extras</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>true</code> by default, will add links <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the title <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> the cover (if it is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">set</span>) in the table of contents.</li>
|
||
<li><code>epub.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">escape</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">nb</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">spaces</span></code>, similar <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">escape</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">nb</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">spaces</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> false by default since at least Kobo <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">reader</span> don’t seem <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> be able <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> understand the CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> escape those nb spaces...</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">roman</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numerals</span></code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>true</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbers</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">using</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">roman</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numerals</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">roman</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numerals</span></code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>true</code> (it is by default) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbers</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">using</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">roman</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numerals</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.template</code> specifies the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbering</span> scheme of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">parts</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">reset</span>_counter</code>, if set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>true</code> (it is by default), <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">resets</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> zero after a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">part</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>Renamed</span> options:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">import</span>_config</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>import</code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span></code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">single</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">standalone</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">template</span></code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">single</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">js</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">standalone</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">js</span></code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">single</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">one</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">standalone</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">one</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span></code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span></code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span></code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span>.index.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span>.chapter.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span></code> have been merged <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> both <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span>.template</code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">font</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">size</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">font</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">size</span></code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>EPUB:<ul>
|
||
<li>Fix duplicate HTML escaping (resulting <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> e.g. <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>&<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> instead of <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>&<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">HTML</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">directory</span>:<ul>
|
||
<li>Fix panic <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> trying <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> generate <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">directory</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span title = "Two consecutive dots" class = "grammar-error">..</span>/xxx<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> (<a href = "https://github.com/lise-henry/crowbook/issues/23">#23</a>).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Fix</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>previous chapter<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> links that were not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displayed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.header<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> was set.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">HTML</span>:<ul>
|
||
<li>Fix the way <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">initial</span> letter <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displayed</span> if <code>rendering.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">initials</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> true.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Internationalization</span>:<ul>
|
||
<li>Strings <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> generated Crowbook documents (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">such</span> as <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Table of contents<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Title<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Cover<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">such</span>) are now translated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> spanish.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-132">0.10.4 (2016-12-16)</h2>
|
||
<ul>
|
||
<li>New <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span>:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">font</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">size</span></code> specifies an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">optional</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">font</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">size</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> pt) passed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> the LaTeX class (must <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> 10, 11 or 12).</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">title</span></code> can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code>false</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> avoid rendering the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">title</span> with <code>\maketitle</code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">paper</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">size</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specifies</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">paper</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">size</span> for PDF output.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tex</span>.template.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">add</span></code>, <code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">css</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">add</span></code> and <code>epub.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">css</span>.add</code>allow <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> inline LaTex or CSS code in the book configuration file that will be added respectively <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code>tex.template.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">add</span></code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">css</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">add</span></code> and <code>epub.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">css</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">add</span></code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">icon</span></code> allows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> specify the path of an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">icon</span> for HTML documents.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Command-line</span> interface:<ul>
|
||
<li>Paths that are displayed should now be normalized, e.g. <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">bar</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">pdf</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> instead of <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>baz/<span title = "Two consecutive dots" class = "grammar-error">..</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">bar</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">pdf</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Rendering</span>:<ul>
|
||
<li>HTML:<ul>
|
||
<li>The default CSS style has been slightly modified.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-133">0.10.3 (2016-11-19)</h2>
|
||
<ul>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Building</span>:<ul>
|
||
<li>Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">now</span> requires rustc >= 1.13.0 to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">build</span>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Pre-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">built</span></span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">binaries</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">now</span> all include the proofreading feature.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Linux</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">binaries</span> are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">now</span> linked against <code>musl</code> library so they should really work on any Linux platform.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>Fixed escaping of <code>author</code> and <code>title</code> fields.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Fixed</span> text cleaning in ODT rendering that causes corrupt files <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> be generated.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">CommandLine</span> Interface:<ul>
|
||
<li>Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displays</span> clearer error messages when unable <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> launch <code>latex</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code>zip</code> commands.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Crowbook</span> uses <code>term</code> library in order <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> colours correctly on e.g. Windows.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">The</span> new argument <code>--lang</code> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <code>-L</code>) allows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> set the runtime language <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">used</span> by Crowbook, overriding <code>LANG</code> environment variable.</li>
|
||
<li><code>--list-options</code> no longer <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">uses</span> colours as it caused problems depending on the terminal or when piping to <code>less</code>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-134">0.10.2 (2016-10-21)</h2>
|
||
<p id = "para-272">Only minor changes in this version:</p>
|
||
<ul>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Options</span>:<ul>
|
||
<li><code>author</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code>title</code>’s default values are both set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the empty string, instead of <code>Anonymous</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code>Untitled</code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">input</span>.autoclean</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">has</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">been</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renamed</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">input</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">clean</span></code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">input</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">smart</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">quotes</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">has</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">been</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renamed</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">input</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">clean</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">smart</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">quotes</span></code>.</li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">new</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">input</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">clean</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ligature</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">dashes</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">true</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">replace</span> <code>--</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> en <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">dash</span> (<code>–</code>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code>---</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> em <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">dash</span> (<code>—</code>).</li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">new</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span>: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">input</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">clean</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ligature</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">guillemets</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">true</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">replace</span> <code><<</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code>>></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> french <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">guillemets</span> (<code>«</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code>»</code>).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>Rendering</span>:<ul>
|
||
<li>HTML: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span> <code>html_single.one_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span>.inline_toc</code> are both <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">true</span>, only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">render</span> the TOC <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">if</span> currently displayed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> is the first.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-135">0.10.1 (2016-10-18)</h2>
|
||
<p id = "para-273">Fixed a bug in <code>fr.po</code> translation that prevented building from fresh install.</p>
|
||
<h2 id = "link-136">0.10.0 (2016-10-18)</h2>
|
||
<p id = "para-274">This release contains <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> breaking changes (mostly for the API, which has been split <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> separate libraries). It alse features <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> internationalization support, and the program should now be tranlated if your <code>LANG</code> environment variable is set to french.</p>
|
||
<ul>
|
||
<li><b>Breaking changes</b>:<ul>
|
||
<li>Templates:<ul>
|
||
<li>Conditional inclusion depending <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>lang</code> must <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> done using <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">lang</span>_LANG</code> (e.g. <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">lang</span>_fr</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">lang</span>_en</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> so <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span>). This might impact custom <code>epub.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span></code> templates.</li>
|
||
</ul>
|
||
</li>
|
||
<li>API:<ul>
|
||
<li>The <code>escape</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">module</span> has been moved to a separate crate, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">text</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">processing</span></code>. The <code>cleaner</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">module</span> is no longer public, but the features it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">provided</span> are also available in <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">text</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">processing</span></code>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">New</span> options:<ul>
|
||
<li><code>html.css.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">colours</span></code> allows to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">provide</span> a CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> that only redefine the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">colour</span> scheme. Such a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> can be built from <code>crowbook --print-template html.css.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">colours</span></code>.</li>
|
||
<li><code>input.smart_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">quotes</span></code>: if set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code>true</code>, tries <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> replace <code><span title = "Unpaired symbol: ''' seems to be missing" class = "grammar-error"></span>'</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><span title = "Unpaired symbol: ''' seems to be missing" class = "grammar-error"></span><span title = "Use a smart opening quote here: '“'." class = "grammar-error"></span>"</code> by curly <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">quotes</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Command</span> line interface:<ul>
|
||
<li>Crowbook is now (imperfectly) localized in french, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> can be translated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> other languages.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Added</span> the <code>--quiet</code> (or <code>-q</code>) argument, that makes crowbook run without <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displaying</span> any <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">messages</span> (except some error <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">messages</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> this point).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Rendering</span>:<ul>
|
||
<li>HTML:<ul>
|
||
<li>The table of contents menu is no longer <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displayed</span> in the HTML single <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span> if it doesn’t contain <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> least two elements.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">The</span> default colour theme has been modified a little.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>Fix the escaping of non-breaking spaces <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> EPUB, as <code>&nbsp;</code> and its friends aren’t valid entities <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> XHTML, apparently.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-137">0.9.1 (2016-09-29)</h2>
|
||
<p id = "para-275">This release mainly introduces <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">generation</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">proofreading</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copies</span>, allowing, if they <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> set (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <code>crowbook</code> was compiled with the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>proofread</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">feature</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">generate</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">proofreading</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copies</span>, using tools <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> check grammar <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> detect repetitions. These <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">features</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> currently experimental.</p>
|
||
<ul>
|
||
<li>New options:<ul>
|
||
<li><code>html.escape_nb_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">spaces</span></code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> true (by default), will replace unicode non breaking <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">spaces</span> with HTML entites and CSS so it can display correctly even <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> <span title = "Consider using the plural form here: 'readers'." class = "grammar-error">reader’s</span> don’t have a browser/font supporting these unicode symbols.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>Output</span> files for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span> documents: <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span></code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>_dir</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.pdf</code>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>Proofread</span> options <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.repetitions</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">nb</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">spaces</span></code> have been added.<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">nb</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">spaces</span></code>, if set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> true, highlights non-breaking <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">spaces</span> so it is easier <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> check the correct typography of a book. Note <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> it requires <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <code>html.escape_nb_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">spaces</span></code> be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">true</span> (default) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> work.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">reppetitions</span></code>, if <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">true</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">uses</span> <a href = "https://github.com/lise-henry/caribon">Caribon</a> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> highlight <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span> in a document. It also <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">uses</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">settings</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fuzzy</span></code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.max_distance</code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">threshold</span></code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fuzzy</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">threshold</span></code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">proofread</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">repetitions</span>.ignore_proper</code>. Note that this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">feature</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">built</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">default</span>, you’ll have to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">build</span> crowbook with <code>cargo <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">build</span> --release --<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">features</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>repetitions<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span></code>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">New</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">default</span> settings <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> options:<ul>
|
||
<li><code>tex.command</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> now <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>xelatex</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">default</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Rendering</span>:<ul>
|
||
<li>LaTeX:<ul>
|
||
<li>Add support <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">xelatex</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">default</span> template.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Improved</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">french</span> cleaner (see <a href = "https://crowdagger.github.io/textes/articles/heuristique.html">an article (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">french</span>)</a> that talks about what it does).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Crowbook</span> user guide: documentation has been updated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> correctly reflect 0.9.x <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span>.</li>
|
||
<li>API:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>clap</code> dependency <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> now <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">optional</span>, people who want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> use Crowbook as a library should include it with <code>crowbook = <span title = "Don't put a space after the opening parenthesis" class = "grammar-error">{ </span>version = <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>0.9<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, default-features = false<span title = "Don't put a space before the closing parenthesis" class = "grammar-error"> }</span></code>. (<code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>clap</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> still required <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> build a working binary).</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-138">0.9.0 (2016-09-23)</h2>
|
||
<p id = "para-276">The main objective of this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">release</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> clean public interfaces, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> order <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> limit breaking changes <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the future. <em>Ideally</em>, all pre-1.0 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">releases</span> should thus be 0.9.x. Concretely, this meant three things:</p>
|
||
<ul>
|
||
<li><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">reducing</span> the surface of Crowbook’s library API;</li>
|
||
<li>cleaning options names</li>
|
||
<li>cleaning the names exported <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">templates</span> and document them, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> order not to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">break</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">user</span>-defined <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">templates</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> future (non-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">breaking</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">releases</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">More</span> detailed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">changes</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">release</span>:</li>
|
||
<li><b>Breaking <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">change</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">users</span></b>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">removed</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tex</span>.short</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span>, replaced by a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">more</span> generic <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tex</span>.class</code> (default being <code>book</code>). <code><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">html</span>.crowbook_link</code> has also been <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">removed</span>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Renamed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span>. Using the old name <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">print</span> a deprecation warning but <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> still work for a while.<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">temp</span>_dir</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">crowbook</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">temp</span>_dir</code></li>
|
||
<li><code>zip.command</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">crowbook</span>.zip.command</code></li>
|
||
<li><code>verbose</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">crowbook</span>.verbose</code></li>
|
||
<li><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">print</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span></code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span>.print</code></li>
|
||
<li><code>html.display_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span></code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span>.one_chapter</code></li>
|
||
<li><code>html.script</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span>.js</code></li>
|
||
<li><code>numbering</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.num_depth</code></li>
|
||
<li><code>numbering_template</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span>_template</code></li>
|
||
<li><code>display_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span></code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span>_toc</code></li>
|
||
<li><code>toc_name</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">inline</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span>.name</code></li>
|
||
<li><code>enable_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">yaml</span>_blocks</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">input</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">yaml</span>_blocks</code></li>
|
||
<li><code>use_initials</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.initials</code></li>
|
||
<li><code>autoclean</code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">input</span>.autoclean</code></li>
|
||
<li><code>html_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">dir</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">css</span></code> -> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">css</span></code> (not really renamed, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">dir</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">css</span></code> isactually removed as <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">there</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> no point in having different CSS for standalone <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> multifile HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> it?)</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">New</span> options:<ul>
|
||
<li>More <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span>: <code>license</code>, <code>version</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code>date</code>. <span title = "Did you mean 'this metadata' or ''?" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">These</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span></span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> not treated by the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderers</span>, but they <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> exported <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the templates: <code>{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span>}}}</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> access the content. If they <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> present, a <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">has</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> also set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> true, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">allowing</span> <span title = "Did you mean 'doing'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> do</span> something like <code>{{{title}}} {{#<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">has</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span>}}<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> {{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span>}}} {{/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">has</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span>}}</code>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Yet</span> more <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span>: it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> add custom <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> prefixing it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">with</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span>.</code>. They will then be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">accessible</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">with</span> dots ('.') <span title = "This sentence does not start with an uppercase letter" class = "grammar-error">replaced</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> underscores ('_'). E.g., <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">with</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span>: bar</code> you can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">access</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">with</span> <code>{{{<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">metadata</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">foo</span>}}}</code>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">output</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">path</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specifies</span> a directory <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">where</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">output</span> files <span title = "Unpaired symbol: ')' seems to be missing" class = "grammar-error">(</span>set by <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">output</span>.FORMAT</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">be</span> written.</li>
|
||
<li><code>resources.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">path</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specifies</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">where</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">templates</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">be</span> found.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>Rendering</span>:<ul>
|
||
<li>Metadata <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> now contain Markdown and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">be</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendered</span> by the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renderers</span>. This might not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">be</span> a good idea for common fields (e.g. <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>title<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>), though. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Use</span> with caution.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>.inline_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">name</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> <code>{{{loc_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span>}}}</code> to specify a localized <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">name</span>.</li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">HTML</span>:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">html</span>.top</code> and <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">hstml</span>.footer</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> now considered as templates, so you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> some <code>{{{metadata}}}</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> it.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Improved</span> the way <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">footnotes</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> displayed.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>In</span> standalone HTML, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">footnotes</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">are</span> rendered <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span> of the document instead of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">at</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">end</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span>, unless <code>html_single.one_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> true.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">LaTeX</span>:<ul>
|
||
<li>If <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">class</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>article</code>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapters</span> will be displayed as <code>\sections</code> since <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>article</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">class</span> doesn’t handle <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapters</span>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Except</span> if <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tex</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">class</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>book</code>, margins <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> symmetrical.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">LaTex</span> template <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> uses <code>version</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code>date</code>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">import</span>_config</code> only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">import</span> options from another <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> file <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> not equal to the default ones <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> haven’<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">t</span> already been <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> by the caller. E.g., <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">author</span>: foo</code> then <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">import</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">config</span>: bar.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span></code> won’<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">t</span> erase the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">author</span> previously <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">import</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">config</span></code> now correctly translates the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">imported</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span>’s paths.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Crowbook</span> program:<ul>
|
||
<li>Still working to improve <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">error</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">messages</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> --list-options</code> uses colours. This might hurt your eyes.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Display</span> an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">error</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">message</span> when mustache can’t compile a template, instead of panicking.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Internal</span>/API:<ul>
|
||
<li>Added static methods <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code>Logger</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> allows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displaying</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">messages</span> more easily/prettily.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Reduce</span> <span title = "Did you mean 'public'?" class = "grammar-error">pubic</span> API’s surface so <span title = "Did you mean 'fewer'? The noun changes is countable." class = "grammar-error">less</span> changes will need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> be considered breaking in the future.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-139">0.8.0 (2016-09-19)</h2>
|
||
<p id = "para-277">This release adds support <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> syntax higlighting <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> code <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span>, customized top <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> footer <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> HTML rendering, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> the special <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">import</span>_config</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span> that allows <span title = "Did you mean 'importing'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error">to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">import</span></span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> from another book file. It also provides (hopefully) better error messages.</p>
|
||
<ul>
|
||
<li>New <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">options</span>:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">import</span>_config</code>is not really an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">option</span>, but <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">import</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">another</span> configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">useful</span> if you share a same <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">options</span> between multiple books.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">initials</span></code> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> false <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">default</span>) makes Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">initials</span> (<span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>lettrines<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>) at start of each chapter. Support is still experimental.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span></code> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> true <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">default</span>) allows syntax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlighting</span> for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> blocks, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">using</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">js</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">higlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">js</span></code> can be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> provide <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">other</span> themes (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">default</span> is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">default</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">css</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span title = "Use 'a' instead of 'an' if the following word doesn't start with a vowel sound, e.g. 'a sentence', 'a university'" class = "grammar-error">an</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">highlight</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">js</span> build that support <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">other</span> languages.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">footer</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">allows</span> <span title = "Did you mean 'specifying'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span></span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">custom</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">footer</span>. If not set, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.crowbook_link</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">allows</span> <span title = "Did you mean 'disabling'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> disable</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Generated by Crowbook<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> message.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">top</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">custom</span> header that will be displayed at the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">top</span> of HTML file(s).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Deprecated</span> options:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">side</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">notes</span></code> has been renamed <code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">side</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">notes</span></code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Crowbook</span> program:<ul>
|
||
<li>All output formats are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> rendered concurrently.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Better</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">error</span> messages. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Crowbook</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> tries to give more information when displaying an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">error</span>, with the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> name where a problem was <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">found</span>, and, in <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> cases, the line. It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> tries <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> detect <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">errors</span> (such as <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">found</span>) sooner.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Some</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>warning<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">messages</span> have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> been <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>moved<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">error</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">messages</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> make sure they are displayed even when crowbook isn’t runned with <code>--verbose</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Rendering</span>:<ul>
|
||
<li>Hidden <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> now produce empty <code>\<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span>*{}</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><h1></code> in LaTeX <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> HTML. This allow <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> delimit a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> break even if nothing is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">displayed</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>Navigation menu of standalone HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">didn</span>'<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">t</span> include a call <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> javascript when <code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">display</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span></code> was set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> true, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">meaning</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">didn</span>'<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">t</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">display</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> correctly.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Implementations</span> of <code>Image</code> and <code>StandaloneImage</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">were</span> reversed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> LaTeX.</li>
|
||
<li><code><span title = "Add a space between sentences" class = "grammar-error"></span>StandaloneImage</code> urls <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">were</span> not adjusted (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">meanning</span> that running <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>crowbook</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">from</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">another</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">directory</span> failed).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Image</span> paths are now found correctly <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> HtmlDir rendering even if <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>crowbook</code> is called <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">from</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">another</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">directory</span> (same fix as 0.6’s <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> Epub and LaTeX, which <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">was</span> forgotten <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> HtmlDir).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Internal</span>/API:<ul>
|
||
<li>In order <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> have better error messages, there <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">was</span> a need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> refactor the <code>Error</code> type, and make more <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">methods</span> return <code>Result<X></code> instead of <code>X</code>. The API is, therefore, quite modified.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Added</span> a <code>Renderer</code> trait used by the various renderers.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Removed</span> some <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">methods</span> from public API.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-140">0.7.0 (2016-09-11)</h2>
|
||
<p id = "para-278">This releases <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renders</span> images differently when they are on a standalone <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">paragraph</span> or inside a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">paragraph</span>.</p>
|
||
<ul>
|
||
<li>Internal/API:<ul>
|
||
<li><code>Token</code> has a new variant, <code>StandaloneImage</code>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> used to distinguish <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">an</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">image</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> alone in a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">paragraph</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">an</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">image</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> inlined alongside text.</li>
|
||
<li><code><span title = "Add a space between sentences" class = "grammar-error">Parser</span>.parse</code> method now distingues between <code>Image</code> and <code>StandaloneImage</code>. Currently, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">an</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">image</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> considered <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>standalone<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> the sole element of a paragraph, even <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> among a link.</li>
|
||
<li><code><span title = "Add a space between sentences" class = "grammar-error"></span>Token</code> has a new <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">image</span></code> method.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Rendering</span>:<ul>
|
||
<li>Standalone <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">images</span> are now <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendered</span> differently than inline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">images</span> (80% of width VS original size) in HTML/EPUB and LaTeX.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-141">0.6.0 (2016-09-09)</h2>
|
||
<ul>
|
||
<li>Deprecated options:<ul>
|
||
<li><code>nb_char</code>: since it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">was</span> only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">used</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> french cleaner <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> typography reasons <span title = "Did you mean 'its' (possessive pronoun) instead of 'it's' (short form of 'it is')?" class = "grammar-error">it’s</span> better <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> different non breaking spaces according <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> context, this option <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">was</span> not really <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">useful</span> anymore.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Rendering</span>:<ul>
|
||
<li>Images <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> displayed at 80% width of the page.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>Image paths <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> found correctly <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> LaTeX and EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span> even if <code>crowbook</code> is called from another directory.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Fixed</span> a bug <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> <code>French</code> cleaner when a string to clean ended by a non-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">breaking</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">space</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">space</span> was doubled with a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">breaking</span> one).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">LaTeX</span>/PDF:<ul>
|
||
<li><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>Autocleaning<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> is now also activated (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> french at least) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> LaTeX rendering, since it doesn’t correctly insert non-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">breaking</span> spaces <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">e</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">g</span>. ‘«’ or ‘»’.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Fixed</span> escaping of <code>--</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>-{}-</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> avoid tex ligatures.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">HTML</span>/EPUB:<ul>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span>_chapter</code> now <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">defaults</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>false</code> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">e</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">g</span>., by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">default</span> the HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displays</span> the entirety of a book).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Fixed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span> of lists <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> <code>lang</code> is set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <code>fr</code>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Links</span> are now HTML-escaped, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fixing</span> errors in XHTML (for EPUB <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rendering</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">links</span> contained ‘&’ character.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-142">0.5.1 (2016-04-14)</h2>
|
||
<p id = "para-279">Mostly <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rendering</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">fixes</span>:</p>
|
||
<ul>
|
||
<li>Epub:<ul>
|
||
<li>Fix a validation problem <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">when</span> book <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contained</span> hidden chapters.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">French</span> cleaner:<ul>
|
||
<li>Use semi-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cadratine</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">space</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">instead</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">cadratine</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">space</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> dialogs.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Use</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">non</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">narrow</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">non</span>-breaking spapce <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">instead</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">narrow</span> one <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> ‘:’, ‘«’ and ‘»’ (following https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">HTML</span>:<ul>
|
||
<li>Add viewport meta tags.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Standalone</span> HTML:<ul>
|
||
<li>Don’t <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">display</span> the button <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">display</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> and the previous/next <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> link if <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">display</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span></code> is set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <code>false</code>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Fix</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">displaying</span> when some <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapters</span> are not numbered.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Multi-files</span> HTML:<ul>
|
||
<li>Fix previous/next <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">chapter</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">display</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> make it consistent with standalone HTML.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-143">0.5.0 (2016-04-02)</h2>
|
||
<ul>
|
||
<li>Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> requires Rustc 1.7.0.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">It</span> is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">render</span> HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> multiple <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>:<ul>
|
||
<li><code>output.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span></code> will activate <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">renderer</span>, and specify <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> which directory <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">render</span> these <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>;</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span>.css</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> override the CSS <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">rendering</span>;</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">index</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">index</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">page</span>;</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">dir</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">html</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapters</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">pages</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">New</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> options:<ul>
|
||
<li><code>tex.short</code>: if set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> true, the LaTeX renderer <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>article</code> instead of <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>book</code> as document class, and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">default</span> <code>\maketitle</code> command for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">article</span>. This option <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">default</span> set to false, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">except</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> called with <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span></code>.</li>
|
||
<li><code>enable_yaml_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span></code>: parsing YAML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> no longer activated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">default</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">except</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">using</span> <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span></code>. This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> because you might want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> have e.g. multiple short stories <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">using</span> YAML blocks <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> set their titles <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> so on, <em><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>and</em> a separate <code>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span></code> file <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> render a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> as a collection of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">short</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stories</span>. In this case, you wouldn’t want the displayed title or the output.pdf/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>/epub <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span> be redefined by the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">short</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">stories</span><span title = "Don't put a space before the full stop" class = "grammar-error"> .</span>md <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">html</span>.print_css</code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> a stylesheet <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> media print</li>
|
||
<li><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">displays</span> one <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> at a time in <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">standalone</span> HTML</li>
|
||
<li><code>html.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">script</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> a custom javascript <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">standalone</span> HTML</li>
|
||
<li><code>html_dir.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">script</span></code>: same thing <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> multipage HTML</li>
|
||
<li><code>resources.base_path</code>: by default, Crowbook <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">resolves</span> local links in <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">markdown</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">files</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">relatively</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">markdown</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">file</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span> allows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">resolve</span> them <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">relatively</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span> comes with <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">two</span> variants, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">images</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">links</span></code>, which only activate it for respectively <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">images</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tags</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">links</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tags</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">These</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">two</span> options are ignored when <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">There</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> also <code>resources.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">base</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">path</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span></code> which specify <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">where</span> additional <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> (see below) should be read, but this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> one <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">set</span> to<span title = "Don't put a space before the full stop" class = "grammar-error"> <code>.</code></span> (i.e.,<span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span>the directory <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">where</span> the <code>.book</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span>) by default.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span></code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">indicate</span> a (whitespace-separated) list of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">should</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> embedded. Currently only used with the EPUB renderer.</li>
|
||
<li><code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">resources</span>.out_path</code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">indicate</span> where <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">resources</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">should</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> copied <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> the final document. Default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>data</code>, meaning that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">files</span> will <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">be</span> placed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> a <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>data</code> directory <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> the EPUB.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Rendering</span>:<ul>
|
||
<li>Templates can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">localized</span> strings according <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the <code>lang</code> option</li>
|
||
<li>Standalone HTML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> includes <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">locale</span> files <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">using</span> base64.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Standalone</span> HTML displays one chapter at a time, thouht it can be changed via a button in the menu.</li>
|
||
<li>HTML/EPUB: default CSS now <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">uses</span> the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>lang</code> value do determine how <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> display lists (currently the only difference <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">uses</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>–<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>lang</code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> set <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>fr<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> and standard bullets for other languages).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>Fixed a bug of filename <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>resolution<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> Crowbook was called with <code>--single</code> (e.g., <code>crowbook -s <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tests</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">test</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">md</span></code> would previously try <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> load `<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tests</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">tests</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">test</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">md</span>).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Epub</span> renderer now uses the <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">mime</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">guess</span></code> library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">guess</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">mime</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">type</span> based on <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">extension</span>, which should fix the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">mime</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">type</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">guessed</span> for a wide range of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">extensions</span> (e.g., svg).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Internal</span>/API:<ul>
|
||
<li>The <code>Book::<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">new</span></code>, <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">new</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">from</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span></code>, and <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">new</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">from</span>_markdown_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span></code> take an additional <code><span title = "Possible typo: apostrophe is missing. Did you mean 'options'' or 'option's'?" class = "grammar-error"></span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>options</code> parameter. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">To</span> create a book with default <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span>, set it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <code>&[]</code>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-144">0.4.0 (2016-03-01)</h2>
|
||
<ul>
|
||
<li>Crowbook now internally uses a true YAML parser, <code>yaml_rust</code>, for its <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">options</span>. Since the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>old<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> Crowbooks’s config format was similar, but had <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> subtle differences, this is somewhat of a breaking change:<ul>
|
||
<li>strings should now be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">escaped</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>" in <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">some</span> cases (e.g. if it contains special characters). On the other hand, it <em>allows</em> to optionally <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">escape</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">string</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> these quotes, which wasn’t possible until then and might be useful in some cases.</li>
|
||
<li>multiline <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">strings</span> now follow the YAML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">format</span>, instead of the previous <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>YAML-ish<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">format</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> can impact the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">way</span> newlines are added at the end of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">multiline</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">string</span>. See e.g. <a href = "http://stackoverflow.com/questions/3790454/in-yaml-how-do-i-break-a-string-over-multiple-lines"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> link</a> for the various <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ways</span> to include <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">mulitiline</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">strings</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> Yaml.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Crowbook</span> now parses YAML blocks (delimited by two lines <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>---<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> Markdown files, ignoring keys <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> it doesn’t recognize. This <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">allows</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">crowbook</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> be compatible(-ish) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contains</span> YAML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">blocks</span> for Jekyll or Pandoc.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">New</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">option</span> <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">allows</span> <span title = "Did you mean 'giving'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> give</span> Crowbook a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">single</span> Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> (which can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contain</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">options</span> within an inline YAML <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">block</span>) instead of a book configuration <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>. This is useful for e.g. short stories.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Enhanced</span> the way <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">debugging</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">warning</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">info</span> messages are handled and displayed:<ul>
|
||
<li>Added a <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">debug</span></code> option to the binary.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Internal</span>: added a <code>Logger</code> struct.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Different</span> levels of information (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">debug</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">warning</span>/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">info</span>/error) get <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">different</span> colours.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>Crowbook no longer crashes when called with the <code>--to</code> argument if it can’t create a file.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-145">0.3.0 (2016-02-27)</h2>
|
||
<ul>
|
||
<li>Crowbook now tries <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> convert local <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">links</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">That</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">link</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> a Markdown <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> used in the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span>. (e.g. <a href = "#chapter-0">README.md</a>), it <em>should</em> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">link</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> an appropriate inner reference inside the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Latex</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> supports (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">local</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">images</span>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Epub</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> embed (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">local</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">images</span> in the EPUB file.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Some</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">changes</span> to the HTML/Epub stylesheets.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Internal</span> (or usage as a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">library</span>):<ul>
|
||
<li>Crowbook no longer <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">changes</span> current directory, which worked <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> the binary but could cause problem if <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">library</span> was used <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> multithreaded environment (e.g. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> <code>cargo <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">test</span></code>).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>More</span> modules and methods are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> private.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Improved</span> documentation.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Added</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">more</span> unit <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">tests</span>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Bugfixes</span>:<ul>
|
||
<li>Epub <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renderer</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">now</span> correctly <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">renders</span> unnumbered chapter without a number in its toc.ncx file</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-146">0.2.2 (2016-02-25)</h2>
|
||
<ul>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Bugfixes</span>:<ul>
|
||
<li>French cleaner <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">now</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">correctly</span> replaces <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">space</span> after — (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> e.g. dialogs) with <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>em <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">space</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-147">0.2.1 (2016-02-25)</h2>
|
||
<ul>
|
||
<li><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Bugfixes</span>:<ul>
|
||
<li>HTML/Epub rendering no longer incorrectly increment <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapter</span> count for unnumbered <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapters</span>.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Latex</span>: makes what is possible to avoid orverflowing the page.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Minor</span> changes:<ul>
|
||
<li>Latex: improvement of the default way URLs are displayed.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-148">0.2.0 (2016-02-25)</h2>
|
||
<ul>
|
||
<li>Command line <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">arguments</span>:<ul>
|
||
<li>New <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">argument</span> <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">print</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span></code> now allows <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">print</span> a built-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">template</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> stdout.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>New</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">argument</span> <code>--list-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">options</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">prints</span> out all valid <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">options</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> a config file (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange"></span>set</code>), their type and default value.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>New</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">argument</span> <code>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span></code> allows <span title = "Did you mean 'defining'? Or maybe you should add a pronoun? In active voice, 'allow' + 'to' takes an object, usually a pronoun." class = "grammar-error">to define</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> override whatever <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">option</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">set</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">in</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">configuration</span>.</li>
|
||
<li><code>--create</code> can now be used without specifying a <code>BOOK</code>, printing its result on <code>stdout</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>Configuration</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span>:<ul>
|
||
<li>Added support for multiline strings <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> <code>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">book</span></code> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">files</span>, with either ‘|’ (preserving <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">line</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">returns</span>) or ‘>’ (transforming <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">line</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">returns</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> spaces)</li>
|
||
<li>New option <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span></code> allows to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">display</span> the table of contents (whose <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">name</span>, at least for HTML, is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specified</span> by <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">toc</span>_<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">name</span></code>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> HTML and PDF documents.</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Option</span> <code><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red"></span>numbering</code> now takes an int instead of a boolean, allowing <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">specify</span> the maximum <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">level</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">number</span> (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">e</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">g</span>. <code>1</code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapters</span> only, <code>2</code>: <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">chapters</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> sectino, ..., <code>6</code>: everything).</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Rendering</span>:<ul>
|
||
<li>Added support <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbering</span> all headers, not just <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">level</span>-1 (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">e</span>.<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">g</span>., having a subsection <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">numbered</span> <code>2.3.1</code>).</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Tables</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> Footnotes are now implemented <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> HTML/Epub <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> LaTeX output.</li>
|
||
</ul>
|
||
</li>
|
||
<li><span title = "Add a space between sentences" class = "grammar-error">Internal</span>:<ul>
|
||
<li>Refactored <code>Book</code> to use an HashMap of <code>BookOption</code>s instead of having like 42 fields.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id = "link-149">0.1.0 (2016-02-21)</h2>
|
||
<ul>
|
||
<li><span title = "This sentence does not start with an uppercase letter" class = "grammar-error">initial</span> release</li>
|
||
</ul>
|
||
|
||
</div><div id = "chapter-10" class = "chapter">
|
||
<h1 id = 'link-150'>GNU LESSER GENERAL PUBLIC LICENSE</h1><pre><span style="color:#839496;"> Version 2.1, February 1999
|
||
</span></pre><p id = "para-280">Copyright <span title = "This notation is nonstandard, use this symbol instead: '©'" class = "grammar-error">(C)</span> 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA<span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span>02110-1301<span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span>USA Everyone <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> permitted to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copy</span> and distribute verbatim <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copies</span> of this license document, but changing it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> not allowed.</p>
|
||
<p id = "para-281">[<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> the first released <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">version</span> of the Lesser GPL. It also counts as the successor of the GNU Library Public License, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">version</span> 2, hence the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">version</span> number 2.1.]</p>
|
||
<pre><span style="color:#839496;"> Preamble
|
||
</span></pre><p id = "para-282">The licenses for most software <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> designed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> take away <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">freedom</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">share</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">change</span> it. By contrast, the GNU <span title = "Consider using 'Public'." class = "grammar-error">General Public</span> Licenses <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> intended <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> guarantee <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">freedom</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">share</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">change</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">free</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">software</span>--<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> make sure the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">software</span> is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">free</span> for all its users.</p>
|
||
<p id = "para-283">This license, the Lesser General Public License, applies <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> some specially designated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">software</span> packages--typically libraries--of the Free Software Foundation and other authors who decide <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> it. You can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.</p>
|
||
<p id = "para-284">When we speak of free software, we <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> referring <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">freedom</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span>, not price. Our <span title = "Consider using 'Public'." class = "grammar-error">General Public</span> Licenses <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> designed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> make sure <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> you have the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">freedom</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> distribute copies of free software (and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">charge</span> for this service <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you wish); <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> you receive source code or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span> get it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you want it; <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">change</span> the software <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> use pieces of it in new free programs; <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> you are informed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">can</span> do these things.</p>
|
||
<p id = "para-285"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">To</span> protect your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rights</span>, we need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> make <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">restrictions</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> forbid <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distributors</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> deny you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">these</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rights</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> ask you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> surrender <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">these</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rights</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">These</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">restrictions</span> translate <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> certain responsibilities for you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribute</span> copies of the library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you modify it.</p>
|
||
<p id = "para-286"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">For</span> example, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">if</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">distribute</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copies</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">library</span>, whether gratis <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> a fee, you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">must</span> give the recipients all the rights <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> we gave you. You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">must</span> make sure <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> they, too, receive <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> can get the source <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span>. If you link other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">library</span>, you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">must</span> provide complete object files <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the recipients, so that they can relink them <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">library</span> after making changes <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">library</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> recompiling it. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">And</span> you must show them these terms so they know their rights.</p>
|
||
<p id = "para-287">We protect your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rights</span> with a two-step method: (1) we copyright the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">library</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> (2) we offer you this license, which gives you legal permission to copy, distribute <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span>/or modify the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">library</span>.</p>
|
||
<p id = "para-288"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">To</span> protect each <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distributor</span>, we want <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> make it very clear that there <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> no warranty for the free <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span>. Also, if the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> modified by someone else and passed on, the recipients should know <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> what they have <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">original</span> version, so <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">original</span> author’s reputation will <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> affected <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> problems <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> might <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> introduced <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> others.</p>
|
||
<p id = "para-289"> Finally, software patents pose a constant threat <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the existence of any <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">free</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">program</span>. We wish <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> make sure <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> a company cannot effectively <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">restrict</span> the users of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">free</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">program</span> by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">obtaining</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">restrictive</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">license</span> from a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">patent</span> holder. Therefore, we insist <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> any <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">patent</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">license</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">obtained</span> for a version of the library must be consistent with the full freedom of use specified in this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">license</span>.</p>
|
||
<p id = "para-290">Most GNU software, including some <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">libraries</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> covered by the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ordinary</span> GNU General Public License. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">license</span>, the GNU Lesser General Public License, applies <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">certain</span> designated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">libraries</span>, and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> quite different from the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ordinary</span> General Public License. We use this license for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">certain</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">libraries</span> in order <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> permit linking those <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">libraries</span> into non-free programs.</p>
|
||
<p id = "para-291">When a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">program</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">linked</span> with a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span>, whether statically or using a shared <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span>, the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">combination</span> of the two <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> legally speaking a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">combined</span> work, a derivative of the original <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span>. The ordinary General Public License therefore <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">permits</span> such <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">linking</span> only if the entire <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">combination</span> fits its <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">criteria</span> of freedom. The Lesser General Public License <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">permits</span> more lax <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">criteria</span> for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">linking</span> other code with the library.</p>
|
||
<p id = "para-292">We call this license the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Lesser<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> General Public License because it does Less to protect the user’s freedom than the ordinary General Public License. It also provides other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">free</span> software developers Less of an advantage over competing non-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">free</span> programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.</p>
|
||
<p id = "para-293"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">For</span> example, on rare occasions, there may be a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">special</span> need <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> encourage the widest possible <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span> of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">certain</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span>, so that it becomes a de-facto standard. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">To</span> achieve this, non-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">free</span> programs must be allowed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span>. A more frequent <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">case</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> that a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">free</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span> does the same job as widely <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">used</span> non-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">free</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">libraries</span>. In this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">case</span>, there <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> little <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> gain by limiting the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">free</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">free</span> software only, so we <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span> the Lesser General Public License.</p>
|
||
<p id = "para-294"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">In</span> other cases, permission <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span> a particular <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> non-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">free</span> programs enables a greater number of people <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span> a large body of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">free</span> software. For example, permission <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span> the GNU C Library in non-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">free</span> programs enables many more people <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">use</span> the whole GNU <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">operating</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">system</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> well <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> its variant, the GNU/Linux <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">operating</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">system</span>.</p>
|
||
<p id = "para-295">Although the Lesser General Public License <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> Less protective of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">users</span>' <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">freedom</span>, it does ensure <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">user</span> of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">program</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> linked with the Library has the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">freedom</span> and the wherewithal to run <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">program</span> using a modified version of the Library.</p>
|
||
<p id = "para-296">The precise terms <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> conditions for copying, distribution <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">modification</span> follow. Pay close attention to the difference between a <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">work</span> based on the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> a <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">work</span> that uses the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>. The former contains code derived from the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span>, whereas the latter must be combined with the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span> in order to run.</p>
|
||
<p id = "para-297"> GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</p>
|
||
<ol start = "0">
|
||
<li>This License Agreement applies <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> any software library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">other</span> program which contains a notice placed by the copyright holder <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">other</span> authorized party saying it may be distributed under the terms of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> Lesser General Public License (also called <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>). Each licensee is addressed as <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>you<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.</li>
|
||
</ol>
|
||
<p id = "para-298">A <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>library<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> means a collection of software <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">functions</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span>/or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">data</span> prepared <span title = "Consider using 'to'" class = "grammar-error">so <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span></span> be conveniently linked with application programs (which use some of those <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">functions</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">data</span>) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> form executables.</p>
|
||
<p id = "para-299">The <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>Library<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, below, refers <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">any</span> such software library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">which</span> has been distributed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">under</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">these</span> terms. A <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> based on the Library<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> means <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">either</span> the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">any</span> derivative <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">under</span> copyright law: that is to say, a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> containing the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> a portion of it, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">either</span> verbatim <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> with <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">modifications</span> and/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">translated</span> straightforwardly into another language. (Hereinafter, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">translation</span> is included without limitation in the term <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green"></span>modification<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>.)</p>
|
||
<p id = "para-300"><span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">Source</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">means</span> the preferred form of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> making <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">modifications</span> to it. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">For</span> a library, complete <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">source</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">means</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">all</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">source</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">for</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">all</span> modules it contains, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">plus</span> any associated interface definition files, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">plus</span> the scripts used to control compilation and installation of the library.</p>
|
||
<p id = "para-301">Activities other than copying, distribution <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> modification <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> covered by this License; they <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">are</span> outside its scope. The act of running a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">program</span> using the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> restricted, and output from such a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">program</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> covered only if its contents constitute a work based <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> the Library (independent of the use of the Library in a tool for writing it). Whether <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> is true depends <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">what</span> the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">does</span> and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">what</span> the program <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> uses the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">does</span>.</p>
|
||
<ol>
|
||
<li>You may <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">copy</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> distribute verbatim <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">copies</span> of the Library’s complete source code as you receive it, in any medium, provided <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> you conspicuously <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">appropriately</span> publish on each <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">copy</span> an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">appropriate</span> copyright <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">notice</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> disclaimer of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">warranty</span>; keep intact all the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">notices</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> refer <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the absence of any <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">warranty</span>; <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> distribute a copy of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License along with the Library.</li>
|
||
</ol>
|
||
<p id = "para-302">You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">may</span> charge a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fee</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> the physical act of transferring a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copy</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">and</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">may</span> at your option offer warranty protection in exchange <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">fee</span>.</p>
|
||
<p id = "para-303"></p>
|
||
<ol start = "2">
|
||
<li>You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">may</span> modify <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">copy</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">copies</span> of the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> any portion of it, thus forming a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">work</span> based on the Library, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">copy</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> distribute such modifications <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">work</span> under the terms of Section 1 above, provided that you also meet all of these conditions:</li>
|
||
</ol>
|
||
<pre><span style="color:#839496;">a) The modified work must itself be a software library.
|
||
|
||
b) You must cause the files modified to carry prominent notices
|
||
stating that you changed the files and the date of any change.
|
||
|
||
c) You must cause the whole of the work to be licensed at no
|
||
charge to all third parties under the terms of this License.
|
||
|
||
d) If a facility in the modified Library refers to a function or a
|
||
table of data to be supplied by an application program that uses
|
||
the facility, other than as an argument passed when the facility
|
||
is invoked, then you must make a good faith effort to ensure that,
|
||
in the event an application does not supply such function or
|
||
table, the facility still operates, and performs whatever part of
|
||
its purpose remains meaningful.
|
||
|
||
(For example, a function in a library to compute square roots has
|
||
a purpose that is entirely well-defined independent of the
|
||
application. Therefore, Subsection 2d requires that any
|
||
application-supplied function or table used by this function must
|
||
be optional: if the application does not supply it, the square
|
||
root function must still compute square roots.)
|
||
</span></pre><p id = "para-304"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">These</span> requirements apply to the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">modified</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> as a whole. If identifiable sections of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> derived from the Library, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> can be reasonably considered independent <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">separate</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">works</span> in themselves, then this License, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> its terms, do <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> apply to those <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">sections</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">distribute</span> them <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">separate</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">works</span>. But <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">when</span> you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">distribute</span> the same <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">sections</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> part of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">whole</span> which is a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> based <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> the Library, the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">distribution</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">whole</span> must be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> the terms of this License, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">whose</span> permissions for other licensees extend <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the entire <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">whole</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> thus <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> each <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> every part regardless of who wrote it.</p>
|
||
<p id = "para-305"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Thus</span>, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> not the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">intent</span> of this section <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> claim <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rights</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> contest your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">rights</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">work</span> written entirely by you; rather, the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">intent</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> exercise the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">right</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> control the distribution of derivative <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> collective <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">works</span> based on the Library.</p>
|
||
<p id = "para-306">In addition, mere aggregation of another <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">based</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">on</span> the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> the Library (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">based</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">on</span> the Library) <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">on</span> a volume of a storage <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> distribution medium does not bring the other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> under the scope of this License.</p>
|
||
<ol start = "3">
|
||
<li>You may opt <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> apply the terms of the ordinary GNU General Public License instead of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> License <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> a given copy of the Library. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">To</span> do <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span>, you must alter all the notices <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">refer</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> License, so <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> they <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">refer</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ordinary</span> GNU General Public License, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> 2, instead of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> License. (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">If</span> a newer <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> than <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> 2 of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ordinary</span> GNU General Public License has appeared, then you can specify that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> instead <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> you wish.) Do not make any other change in these notices.</li>
|
||
</ol>
|
||
<p id = "para-307"> Once this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">change</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> made <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> a given <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">copy</span>, it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> irreversible for <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">copy</span>, so the ordinary GNU General Public License applies to all subsequent <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">copies</span> and derivative works made from <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">copy</span>.</p>
|
||
<p id = "para-308">This option <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> useful when you wish <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">copy</span> part of the code of the Library into a program <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> not a library.</p>
|
||
<ol start = "4">
|
||
<li>You may <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">copy</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> distribute the Library (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> a portion <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> derivative of it, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">under</span> Section 2) in object <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> executable form <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">under</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">terms</span> of Sections 1 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> 2 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">above</span> provided that you accompany it with the complete corresponding machine-readable source <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span>, which must be distributed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">under</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">terms</span> of Sections 1 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> 2 <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">above</span> on a medium customarily used for software interchange.</li>
|
||
</ol>
|
||
<p id = "para-309">If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribution</span> of object <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span> is made by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">offering</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">access</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">copy</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">from</span> a designated <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">place</span>, then <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">offering</span> equivalent <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">access</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">copy</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">source</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">from</span> the same <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">place</span> satisfies the requirement <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> distribute the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">source</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span>, even though third parties are not compelled <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">copy</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">source</span> along with the object <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">code</span>.</p>
|
||
<ol start = "5">
|
||
<li>A program that contains no derivative of any portion of the Library, but <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> designed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">with</span> the Library by being compiled or linked <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">with</span> it, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> called a <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> that uses the Library<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>. Such a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span>, in isolation, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> not a derivative <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> of the Library, and therefore falls outside the scope of this License.</li>
|
||
</ol>
|
||
<p id = "para-310">However, linking a <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> uses the Library<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> with the Library creates an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">executable</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> a derivative of the Library (because it contains portions of the Library), rather than a <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>work <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> uses the library<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>. The <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">executable</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> therefore covered by this License. Section 6 states terms for distribution of such <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">executables</span>.</p>
|
||
<p id = "para-311">When a <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">uses</span> the Library<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">uses</span> material from a header file <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> part of the Library, the object <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> for the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> may be a derivative <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> of the Library even though the source <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">code</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> not. Whether this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> true <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> especially significant <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> can <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> linked without the Library, or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">if</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> itself a library. The threshold for this to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">be</span> true <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> not precisely defined by law.</p>
|
||
<p id = "para-312"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">If</span> such an object file <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">uses</span> only numerical parameters, data structure layouts <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> accessors, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">small</span> macros <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">small</span> inline functions (ten lines or <span title = "Did you mean 'fewer'? The noun lines is countable." class = "grammar-error">less</span> in length), then the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">use</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">object</span> file <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> unrestricted, regardless of whether it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> legally a derivative work. (Executables containing this <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">object</span> code plus portions of the Library will still fall under Section 6.)</p>
|
||
<p id = "para-313">Otherwise, if the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">derivative</span> of the Library, you may distribute the object code for the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">under</span> the terms of Section 6. Any executables containing that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> also fall <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">under</span> Section 6, <span title = "Consider shortening this phrase to just 'whether'. It is correct though if you mean 'regardless of whether'." class = "grammar-error">whether or not</span> they are linked directly with the Library itself.</p>
|
||
<p id = "para-314"></p>
|
||
<ol start = "6">
|
||
<li>As an exception <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> the Sections above, you may <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> combine <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">link</span> a <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> uses the Library<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span> the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> produce a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> containing portions of the Library, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> distribute <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> under <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">terms</span> of your choice, provided <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">that</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">terms</span> permit <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">modification</span> of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> the customer’s own use <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> reverse engineering <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> debugging such <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">modifications</span>.</li>
|
||
</ol>
|
||
<p id = "para-315">You must give prominent notice with each copy of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> the Library is <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">used</span> in it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> its <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">use</span> are covered by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License. You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">must</span> supply a copy of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License. If the work during execution displays <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copyright</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">notices</span>, you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">must</span> include the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copyright</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">notice</span> for the Library among them, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> well <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> a reference directing the user to the copy of this License. Also, you must do one of these things:</p>
|
||
<pre><span style="color:#839496;">a) Accompany the work with the complete corresponding
|
||
machine-readable source code for the Library including whatever
|
||
changes were used in the work (which must be distributed under
|
||
Sections 1 and 2 above); and, if the work is an executable linked
|
||
with the Library, with the complete machine-readable "work that
|
||
uses the Library", as object code and/or source code, so that the
|
||
user can modify the Library and then relink to produce a modified
|
||
executable containing the modified Library. (It is understood
|
||
that the user who changes the contents of definitions files in the
|
||
Library will not necessarily be able to recompile the application
|
||
to use the modified definitions.)
|
||
|
||
b) Use a suitable shared library mechanism for linking with the
|
||
Library. A suitable mechanism is one that (1) uses at run time a
|
||
copy of the library already present on the user's computer system,
|
||
rather than copying library functions into the executable, and (2)
|
||
will operate properly with a modified version of the library, if
|
||
the user installs one, as long as the modified version is
|
||
interface-compatible with the version that the work was made with.
|
||
|
||
c) Accompany the work with a written offer, valid for at
|
||
least three years, to give the same user the materials
|
||
specified in Subsection 6a, above, for a charge no more
|
||
than the cost of performing this distribution.
|
||
|
||
d) If distribution of the work is made by offering access to copy
|
||
from a designated place, offer equivalent access to copy the above
|
||
specified materials from the same place.
|
||
|
||
e) Verify that the user has already received a copy of these
|
||
materials or that you have already sent this user a copy.
|
||
</span></pre><p id = "para-316"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">For</span> an <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">executable</span>, the required form of the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>work that uses the Library<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">must</span> include any data and utility programs <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">needed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> reproducing the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">executable</span> from it. However, as a special exception, the materials to be <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distributed</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">need</span> not include anything that is normally <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distributed</span> (in either source or binary form) with the major <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">components</span> (compiler, kernel, and so <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span>) of the operating system <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> which the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">executable</span> runs, unless that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">component</span> itself accompanies the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">executable</span>.</p>
|
||
<p id = "para-317">It may happen <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> this requirement <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contradicts</span> the license restrictions of other proprietary libraries <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> do not normally <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">accompany</span> the operating system. Such a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">contradiction</span> means you cannot use both them and the Library together in an executable <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> you distribute.</p>
|
||
<p id = "para-318"></p>
|
||
<ol start = "7">
|
||
<li>You may place <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">facilities</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">that</span> are a work based on the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">side</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span>-<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">side</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> a single <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span> together with other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">facilities</span> not covered <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> this License, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribute</span> such a combined <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">provided</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> the separate <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribution</span> of the work based on the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> of the other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">library</span> facilities is otherwise permitted, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">provided</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> you do these two things:</li>
|
||
</ol>
|
||
<pre><span style="color:#839496;">a) Accompany the combined library with a copy of the same work
|
||
based on the Library, uncombined with any other library
|
||
facilities. This must be distributed under the terms of the
|
||
Sections above.
|
||
|
||
b) Give prominent notice with the combined library of the fact
|
||
that part of it is a work based on the Library, and explaining
|
||
where to find the accompanying uncombined form of the same work.
|
||
</span></pre><ol start = "8">
|
||
<li><p id = "para-319">You may not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copy</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">modify</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">sublicense</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">link</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribute</span> the Library except as expressly <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">provided</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">under</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> License. Any attempt otherwise to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copy</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">modify</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">sublicense</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">link</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">with</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribute</span> the Library is void, and <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> automatically <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">terminate</span> your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rights</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">under</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> License. However, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">parties</span> who <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">have</span> received copies, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">rights</span>, from you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">under</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> License <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">will</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">have</span> their licenses <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">terminated</span> so long as such <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">parties</span> remain in full compliance.</p>
|
||
</li>
|
||
<li><p id = "para-320"><span title = "Add a space between sentences" class = "grammar-error">You</span> are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> required <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> accept <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">this</span> License, since you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">have</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">not</span> signed it. However, nothing else grants you permission <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">modify</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribute</span> the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> its derivative <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">works</span>. These actions are prohibited <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> law if you do not <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">accept</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License. Therefore, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">modifying</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distributing</span> the Library (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> any <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">work</span> based on the Library), you indicate your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">acceptance</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License to do so, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> all its terms <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> conditions for copying, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">distributing</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> modifying the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">works</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">based</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> it.</p>
|
||
</li>
|
||
<li><p id = "para-321"><span title = "Add a space between sentences" class = "grammar-error">Each</span> time you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">redistribute</span> the Library (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> any <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">work</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">based</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">on</span> the Library), the recipient automatically receives a license from the original licensor <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> copy, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">distribute</span>, link with <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">or</span> modify the Library subject <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> these terms and conditions. You may <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> impose any further restrictions on the recipients’ exercise of the rights granted herein. You are <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> responsible for enforcing compliance by third parties with this License.</p>
|
||
</li>
|
||
</ol>
|
||
<p id = "para-322"></p>
|
||
<ol start = "11">
|
||
<li>If, as a consequence of a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">court</span> judgment <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> allegation of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">patent</span> infringement <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">for</span> any other reason (not limited to <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">patent</span> issues), <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">conditions</span> are imposed on you (whether by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">court</span> order, agreement <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">or</span> otherwise) that contradict the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">conditions</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">this</span> License, they do not excuse you from the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">conditions</span> of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">this</span> License. If you cannot <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">distribute</span> <span title = "Consider using 'to'" class = "grammar-error">so <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> to</span> satisfy simultaneously your <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">obligations</span> under <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">this</span> License and any other pertinent <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">obligations</span>, then <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">as</span> a consequence you may <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">distribute</span> the Library at <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">all</span>. For example, if a patent license would <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">not</span> permit royalty-free <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">redistribution</span> of the Library by <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">all</span> those who receive copies directly or indirectly through you, then the only way you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">could</span> satisfy both it and this License <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">would</span> be to refrain entirely from distribution of the Library.</li>
|
||
</ol>
|
||
<p id = "para-323">If <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">any</span> portion of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">section</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> held invalid or unenforceable under <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">any</span> particular <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">circumstance</span>, the balance of the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">section</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">intended</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">apply</span>, and the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">section</span> as a whole <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">is</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">intended</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">apply</span> in other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">circumstances</span>.</p>
|
||
<p id = "para-324">It <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> not the purpose of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">section</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> induce you <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> infringe <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">any</span> patents <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">other</span> property right <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">claims</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> contest validity of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">any</span> such <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">claims</span>; <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">section</span> has the sole purpose of protecting the integrity of the free <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">software</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribution</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">system</span> which is implemented by public license practices. Many people have made generous contributions <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the wide range of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">software</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distributed</span> through <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">system</span> in reliance on consistent application of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">that</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">system</span>; it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> up <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the author/donor <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> decide if he or she <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">is</span> willing <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> distribute software through any other <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">system</span> and a licensee cannot impose that choice.</p>
|
||
<p id = "para-325"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">This</span> section <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> intended <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> make thoroughly clear what <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> believed <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> be a consequence of the rest of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License.</p>
|
||
<ol start = "12">
|
||
<li><p id = "para-326">If the distribution and/<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> use of the Library <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">is</span> restricted in certain countries either <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> patents <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">or</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copyrighted</span> interfaces, the original <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copyright</span> holder who places the Library under this License may add an explicit geographical <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribution</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">limitation</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">excluding</span> those <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">countries</span>, so that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">distribution</span> is permitted only <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> or among <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">countries</span> not thus <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">excluded</span>. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">In</span> such case, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License incorporates the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">limitation</span> as if written <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">in</span> the body of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">this</span> License.</p>
|
||
</li>
|
||
<li><p id = "para-327"><span title = "Add a space between sentences" class = "grammar-error">The</span> Free Software Foundation may publish revised and/or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">new</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">versions</span> of the Lesser General Public License from <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">time</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">time</span>. Such <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">new</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">versions</span> will be similar <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> spirit <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> the present <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">version</span>, but may differ <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">in</span> detail <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">to</span> address <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">new</span> problems or concerns.</p>
|
||
</li>
|
||
</ol>
|
||
<p id = "para-328">Each <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> is given a distinguishing <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">number</span>. If the Library specifies a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">number</span> of this License which applies to it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">any</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">later</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span><span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span>, you have the option of following the terms <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> conditions either of that <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> or of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">any</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">later</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">published</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> the Free Software Foundation. If the Library does not specify a license <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> number, you may choose <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">any</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">version</span> ever <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">published</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> the Free Software Foundation.</p>
|
||
<p id = "para-329"></p>
|
||
<ol start = "14">
|
||
<li><p id = "para-330"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">If</span> you wish <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">write</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the author <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> ask <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> permission. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">For</span> software which is copyrighted <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> the Free Software Foundation, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">write</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the Free Software Foundation; we sometimes make exceptions <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">for</span> this. <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">Our</span> decision will be guided <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">by</span> the two goals of preserving the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">free</span> status of all derivatives of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">our</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">free</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">software</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> of promoting the sharing <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> reuse of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">software</span> generally.</p>
|
||
<pre><span style="color:#839496;"> <span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span>NO WARRANTY
|
||
</span></pre></li>
|
||
<li><p id = "para-331">BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>AS IS<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p>
|
||
</li>
|
||
<li><p id = "para-332">IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
|
||
<pre><span style="color:#839496;"> <span title = "Possible typo: you repeated a whitespace" class = "grammar-error"> </span>END OF TERMS AND CONDITIONS
|
||
</span></pre></li>
|
||
</ol>
|
||
<p id = "para-333"> How <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> Apply These Terms <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">to</span> Your New Libraries</p>
|
||
<p id = "para-334">If you develop a new library, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> you want it <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> be of the greatest possible use <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the public, we recommend making it free software that everyone <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">redistribute</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> change. You <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">can</span> do so by permitting <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">redistribution</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">under</span> these <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">terms</span> (or, alternatively, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">under</span> the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">terms</span> of the ordinary General Public License).</p>
|
||
<p id = "para-335"><span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">To</span> apply <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">these</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">terms</span>, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">attach</span> the following notices <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the library. It is safest <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">attach</span> them <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> the start of <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">each</span> source <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> most effectively convey the exclusion of warranty; <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">each</span> <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">file</span> should have at least the <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>copyright<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> line <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">and</span> a pointer <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> where the full notice is found.</p>
|
||
<pre><span style="color:#839496;"><one line to give the library's name and a brief idea of what it does.>
|
||
Copyright (C) <year> <name of author>
|
||
|
||
This library is free software; you can redistribute it and/or
|
||
modify it under the terms of the GNU Lesser General Public
|
||
License as published by the Free Software Foundation; either
|
||
version 2.1 of the License, or (at your option) any later version.
|
||
|
||
This library is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
Lesser General Public License for more details.
|
||
|
||
You should have received a copy of the GNU Lesser General Public
|
||
License along with this library; if not, write to the Free Software
|
||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||
</span></pre><p id = "para-336">Also add information on how <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">to</span> contact you by electronic <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">and</span> paper mail.</p>
|
||
<p id = "para-337">You should <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">also</span> get <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> employer (<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">if</span> you work as a programmer) or <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">your</span> school, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">if</span> any, to sign a <span title = "Use a smart opening quote here: '“'." class = "grammar-error">"</span>copyright disclaimer<span title = "Use a smart closing quote here: '”'." class = "grammar-error">"</span> for the library, <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">if</span> necessary. Here is a sample; alter the names:</p>
|
||
<p id = "para-338">Yoyodyne, Inc., hereby <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">disclaims</span> all <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">copyright</span> interest in the <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">library</span> `Frob<span title = "Unpaired symbol: ''' seems to be missing" class = "grammar-error">'</span> (a <span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: orange">library</span> for tweaking knobs) written by James Random Hacker.</p>
|
||
<p id = "para-339"><signature of Ty Coon>, 1 April 1990 Ty Coon, President of Vice</p>
|
||
<p id = "para-340">That’s all there is to it!</p>
|
||
|
||
</div><div class = "notes">
|
||
<h2 class = "notes">Notes</h2>
|
||
<table class = "notes">
|
||
<tr class = "notes">
|
||
<td class = "note-number">
|
||
<p class = "note-number">
|
||
<a href = "#note-source-1">[1]</a>
|
||
</p>
|
||
|
||
</td>
|
||
<td class = "note">
|
||
<aside id = "note-dest-1"><p id = "para-168">But you shouldn’t use them too much.</p>
|
||
</aside>
|
||
</td>
|
||
</tr>
|
||
<tr class = "notes">
|
||
<td class = "note-number">
|
||
<p class = "note-number">
|
||
<a href = "#note-source-2">[2]</a>
|
||
</p>
|
||
|
||
</td>
|
||
<td class = "note">
|
||
<aside id = "note-dest-2"><p id = "para-172">Or is it?</p>
|
||
</aside>
|
||
</td>
|
||
</tr>
|
||
<tr class = "notes">
|
||
<td class = "note-number">
|
||
<p class = "note-number">
|
||
<a href = "#note-source-3">[3]</a>
|
||
</p>
|
||
|
||
</td>
|
||
<td class = "note">
|
||
<aside id = "note-dest-3"><p id = "para-173">Or is it?</p>
|
||
</aside>
|
||
</td>
|
||
</tr>
|
||
<tr class = "notes">
|
||
<td class = "note-number">
|
||
<p class = "note-number">
|
||
<a href = "#note-source-4">[4]</a>
|
||
</p>
|
||
|
||
</td>
|
||
<td class = "note">
|
||
<aside id = "note-dest-4"><p id = "para-181">Some of them, though, are not “real” templates, they are just files that are inserted, but can’t contain mustache tags. This will probably evolve in future versions.</p>
|
||
</aside>
|
||
</td>
|
||
</tr>
|
||
<tr class = "notes">
|
||
<td class = "note-number">
|
||
<p class = "note-number">
|
||
<a href = "#note-source-5">[5]</a>
|
||
</p>
|
||
|
||
</td>
|
||
<td class = "note">
|
||
<aside id = "note-dest-5"><p id = "para-190">M<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: red">us</span>tache also provides the <code>{{foo}}</code> va<span class = "repetition" style = "text-decoration-line: underline; text-decoration-style: wavy; text-decoration-color: green">ri</span>ant, which HTML-escapes the content of the variable. You should not use this, as Crowbook already renders and correctly escapes the variables it sets for use in templates.</p>
|
||
</aside>
|
||
</td>
|
||
</tr>
|
||
<tr class = "notes">
|
||
<td class = "note-number">
|
||
<p class = "note-number">
|
||
<a href = "#note-source-6">[6]</a>
|
||
</p>
|
||
|
||
</td>
|
||
<td class = "note">
|
||
<aside id = "note-dest-6"><p id = "para-196"><code><<foo>></code> might also work, but the ampersand is required to prevent mustache HTML-escaping the value. This is not good because:</p>
|
||
<ol>
|
||
<li>escaping is already done by Crowbook before setting variable content;</li>
|
||
<li>escaping HTML in a LaTeX document won’t probably look good.</li>
|
||
</ol>
|
||
<h2 id = "link-86">5.2. List of templates</h2>
|
||
</aside>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
<footer id = "footer"><p id = "para-341">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0-beta</p>
|
||
</footer>
|
||
</div>
|
||
</body>
|
||
</html>
|