OGS-Main
/
ogs-site
2
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
118 Commits
2 Branches
254MB
Tree: a7fae6d784
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'a7fae6d784'
${ noResults }
ogs-site/pskov/en/education.05.blog.html

697 lines
23KB
Raw Blame History 

  1. <!DOCTYPE html>

  2. <html>

  3.     <meta charset="utf-8">

  4.     <head>

  5.         <style>

  6.             #header

  7.             {

  8.                 background: #856d51;

  9.                 padding: 0.7em;

  10.                 text-align: left;

  11.             }

  12.             

  13.             #header a

  14.             {

  15.                 color: white;

  16.                 text-decoration: none;

  17.                 padding: 0.5em 1em 0.5em 1em;

  18.             }

  19.             #title

  20.             {

  21.                 color: #433729;

  22.             }

  23.             html

  24.             {

  25.                 font-family: sans-serif;

  26.             }

  27.             body

  28.             {

  29.                 line-height: 1.5em;

  30.             }

  31.             body

  32.             {

  33.                 background: #FAFAFA;

  34.             }

  35.             table

  36.             {

  37.                 border-collapse: collapse;

  38.                 width: 100%;

  39.             }

  40.             

  41.             table, th, td

  42.             {

  43.                 border: 1px solid #aaa;

  44.                 padding: 0.5em;

  45.                 margin-top: 0.5em;

  46.                 margin-bottom: 0.5em;

  47.             }

  48.             code, pre

  49.             {

  50.                 font-family: monospace, serif;

  51.                 font-size: 1em;

  52.                 color: #7f0a0c;

  53.                 background: #f5f5f5;

  54.                 white-space: pre-wrap;

  55.             }

  56.             .contents

  57.             {

  58.                 background: #FFFFFF;

  59.                 width: 720px;

  60.                 padding: 1em;

  61.                 margin-top: 2em;

  62.                 margin-bottom: 2em;

  63.                 border: 1px solid #E0E0E0;

  64.                 text-align: left;

  65.                 color: #444;

  66.             }

  67.         </style>

  68.         <title>

  69.             pskov_1.0.0

  70.         </title>

  71.     </head>

  72.     <body>

  73.         <div id="header">

  74.             <strong id="title">PSKOV</strong>

  75.             <a href="pskov_1.0.0.html">Tool</a>

  76.             <a href="education.html">Education</a>

  77.         </div>

  78.         <center><h1>

  79. Education: 05. Blog

  80.         </h1></center>

  81.         <center><div class="contents">

  82. <table>

  83. <thead>

  84. <tr>

  85. <th>&lt; Back</th>

  86. <th>Index</th>

  87. <th>Next &gt;</th>

  88. </tr>

  89. </thead>

  90. <tbody>

  91. <tr>

  92. <td><a href="education.04.lang.html">04. Language</a></td>

  93. <td><a href="education.html">Education</a></td>

  94. <td>Not available</td>

  95. </tr>

  96. </tbody>

  97. </table>

  98. <p></div><div class="contents"></p>

  99. <p>In this document we create "dynamic" pages like blog posts.</p>

  100. <p>Estimated completion time: 20 minutes.</p>

  101. <p><strong>Table of contents</strong></p>

  102. <ul>

  103. <li><a href="#blog">01. Blog</a></li>

  104. <li><a href="#cfg">02. Investigate <code>cfg</code> file</a></li>

  105. <li><a href="#item">03. Investigate item templates of the blog</a></li>

  106. <li><a href="#preview">04. Investigate preview templates</a></li>

  107. <li><a href="#index">05. Investigate index (summary) templates</a></li>

  108. <li><a href="#pagination">06. Investigate pagination templates</a></li>

  109. <li><a href="#md">07. Investigate Markdown files</a></li>

  110. <li><a href="#gen">08. Launch LFSA and generate the site</a></li>

  111. <li><a href="#summary">09. Summary</a></li>

  112. </ul>

  113. <p><a name="blog"/></p>

  114. <h2 id="01blog">01. Blog</h2>

  115. <p>So, you have your web site in both English and Russian. You start to feel the need to constantly share your thoughts with the world as blog posts.</p>

  116. <p>You set on to create the following <a href="https://github.com/OGStudio/site-pskov-sample/tree/master/03.Blog">directory structure</a>:</p>

  117. <ul>

  118. <li><code>cfg</code></li>

  119. <li><code>en/blog/</code><ul>

  120. <li><code>item.template</code></li>

  121. <li><code>index.template</code></li>

  122. <li><code>preview.template</code></li>

  123. <li><code>pagination.template</code></li>

  124. <li><code>pagination.prev.template</code></li>

  125. <li><code>pagination.next.template</code></li>

  126. <li><code>1885.md</code></li>

  127. <li><code>1886.01.md</code></li>

  128. <li><code>1886.02.md</code></li>

  129. <li><code>1887.01.md</code></li>

  130. <li><code>1887.02.md</code></li>

  131. <li><code>1888.md</code></li>

  132. <li><code>1896.md</code></li>

  133. <li><code>1899.md</code></li></ul></li>

  134. <li><code>en/page/</code><ul>

  135. <li><code>item.template</code></li>

  136. <li><code>about.md</code></li>

  137. <li><code>cv.md</code></li></ul></li>

  138. <li><code>ru/blog/</code><ul>

  139. <li><code>item.template</code></li>

  140. <li><code>index.template</code></li>

  141. <li><code>preview.template</code></li>

  142. <li><code>pagination.template</code></li>

  143. <li><code>pagination.prev.template</code></li>

  144. <li><code>pagination.next.template</code></li>

  145. <li><code>1885.md</code></li>

  146. <li><code>1886.01.md</code></li>

  147. <li><code>1886.02.md</code></li>

  148. <li><code>1887.01.md</code></li>

  149. <li><code>1887.02.md</code></li>

  150. <li><code>1888.md</code></li>

  151. <li><code>1896.md</code></li>

  152. <li><code>1899.md</code></li></ul></li>

  153. <li><code>ru/page/</code><ul>

  154. <li><code>item.template</code></li>

  155. <li><code>about.md</code></li>

  156. <li><code>cv.md</code></li></ul></li>

  157. </ul>

  158. <p>Let's look at the contents of these files closer.</p>

  159. <p><a name="cfg"/></p>

  160. <h2 id="02investigatecfgfile">02. Investigate <code>cfg</code> file</h2>

  161. <p><code>cfg</code> file has the following contents:</p>

  162. <pre><code>input = en/page;ru/page;en/blog;ru/blog

  163. item = item.template

  164. preview = preview.template

  165. index = index.template

  166. paginationPrev = pagination.prev.template

  167. paginationNext = pagination.next.template

  168. paginationPrevNext = pagination.template

  169. previewSize = 200

  170. previewEnding = . . .

  171. previewsPerPage = 3

  172. previewPageBaseName = index

  173. </code></pre>

  174. <p>Apart from already used <code>input</code> and <code>item</code> keys, we have quite a lot of new ones. Let's break them down:</p>

  175. <table>

  176. <thead>

  177. <tr>

  178. <th>Key</th>

  179. <th>Description</th>

  180. </tr>

  181. </thead>

  182. <tbody>

  183. <tr>

  184. <td><code>preview</code></td>

  185. <td>Points to an HTML template file that is used to generate HTML previews out of the first <code>previewSize</code> (approximately) characters of Markdown files</td>

  186. </tr>

  187. <tr>

  188. <td><code>index</code></td>

  189. <td>Points to an HTML template file that is used to generate HTML index (summary) files to host previews</td>

  190. </tr>

  191. <tr>

  192. <td><code>paginationPrev</code></td>

  193. <td>Points to an HTML template file that is used to generate pagination section used by the <em>last</em> index (summary) file</td>

  194. </tr>

  195. <tr>

  196. <td><code>paginationNext</code></td>

  197. <td>Points to an HTML template file that is used to generate pagination section used by the <em>first</em> index (summary) file</td>

  198. </tr>

  199. <tr>

  200. <td><code>paginationPrevNext</code></td>

  201. <td>Points to an HTML template file that is used to generate pagination section used by index (summary) files <em>except the ones at the beginning and at the end</em></td>

  202. </tr>

  203. <tr>

  204. <td><code>previewSize</code></td>

  205. <td>How many characters (approximately) to take out of a Markdown file to generate an HTML preview</td>

  206. </tr>

  207. <tr>

  208. <td><code>previewEnding</code></td>

  209. <td>String to use at the end of HTML previews</td>

  210. </tr>

  211. <tr>

  212. <td><code>previewsPerPage</code></td>

  213. <td>Number of HTML previews hosted by single index (summary) file</td>

  214. </tr>

  215. <tr>

  216. <td><code>previewsPageBaseName</code></td>

  217. <td>Index (summary) file base name</td>

  218. </tr>

  219. </tbody>

  220. </table>

  221. <p>In our case:</p>

  222. <ul>

  223. <li>we restrict previews to <code>200</code> characters in size (approximately)</li>

  224. <li>we use <code>. . .</code> string at the end of each preview</li>

  225. <li>index (summary) files host <code>3</code> previews maximum</li>

  226. <li>index (summary) files are saved as <code>index.html</code>, <code>index2.html</code>, <code>index3.html</code>, etc.</li>

  227. </ul>

  228. <p><a name="item"/></p>

  229. <h2 id="03investigateitemtemplatesoftheblog">03. Investigate item templates of the blog</h2>

  230. <ul>

  231. <li><p><code>en/blog/item.template</code> contents:</p>

  232. <pre><code>- - - - Collapsed for brevity - - - -

  233. &lt;body&gt;

  234.     &lt;div id="header"&gt;

  235.         &lt;strong&gt;Serov&lt;/strong&gt;

  236.         &lt;a href="../../en/blog/index.html"&gt;Blog&lt;/a&gt;

  237.         &lt;a href="../../en/page/about.html"&gt;About me&lt;/a&gt;

  238.         &lt;a href="../../en/page/cv.html"&gt;CV&lt;/a&gt;

  239.         &lt;div id="lang"&gt;

  240.             &lt;a href="../../en/blog/PSKOV_ITEM_URL"&gt;EN&lt;/a&gt;

  241.             &lt;a href="../../ru/blog/PSKOV_ITEM_URL"&gt;RU&lt;/a&gt;

  242.         &lt;/div&gt;

  243.     &lt;/div&gt;

  244.     &lt;center&gt;

  245.         &lt;h1&gt;In the blog...&lt;/h1&gt;

  246.         &lt;div class="contents"&gt;

  247.             &lt;h2 class="itemTitle"&gt;

  248.                 &lt;a href="PSKOV_ITEM_URL"&gt;PSKOV_ITEM_TITLE&lt;/a&gt;

  249.             &lt;/h2&gt;

  250.             &lt;p class="itemDate"&gt;PSKOV_ITEM_DATE&lt;/p&gt;

  251. PSKOV_ITEM_CONTENTS

  252.         &lt;/div&gt;

  253.         &lt;div id="footer"&gt;

  254.             This sample web site has been generated by &lt;a href="http://opengamestudio.org/pskov"&gt;PSKOV&lt;/a&gt;.

  255.         &lt;/div&gt;

  256.     &lt;/center&gt;

  257. &lt;/body&gt;

  258. - - - - Collapsed for brevity - - - -

  259. </code></pre></li>

  260. <li><p><code>ru/blog/item.template</code> contents:</p>

  261. <pre><code>- - - - Collapsed for brevity - - - -

  262. &lt;body&gt;

  263.     &lt;div id="header"&gt;

  264.         &lt;strong&gt;Серов&lt;/strong&gt;

  265.         &lt;a href="../../ru/blog/index.html"&gt;Блог&lt;/a&gt;

  266.         &lt;a href="../../ru/page/about.html"&gt;Обо мне&lt;/a&gt;

  267.         &lt;a href="../../ru/page/cv.html"&gt;Резюме&lt;/a&gt;

  268.         &lt;div id="lang"&gt;

  269.             &lt;a href="../../en/blog/PSKOV_ITEM_URL"&gt;EN&lt;/a&gt;

  270.             &lt;a href="../../ru/blog/PSKOV_ITEM_URL"&gt;RU&lt;/a&gt;

  271.         &lt;/div&gt;

  272.     &lt;/div&gt;

  273.     &lt;center&gt;

  274.         &lt;h1&gt;В блоге...&lt;/h1&gt;

  275.         &lt;div class="contents"&gt;

  276.             &lt;h2 class="itemTitle"&gt;

  277.                 &lt;a href="PSKOV_ITEM_URL"&gt;PSKOV_ITEM_TITLE&lt;/a&gt;

  278.             &lt;/h2&gt;

  279.             &lt;p class="itemDate"&gt;PSKOV_ITEM_DATE&lt;/p&gt;

  280. PSKOV_ITEM_CONTENTS

  281.         &lt;/div&gt;

  282.         &lt;div id="footer"&gt;

  283.             Этот пример сайта сгенерирован &lt;a href="http://opengamestudio.org/pskov"&gt;ПСКОВОМ&lt;/a&gt;.

  284.         &lt;/div&gt;

  285.     &lt;/center&gt;

  286. &lt;/body&gt;

  287. - - - - Collapsed for brevity - - - -

  288. </code></pre></li>

  289. </ul>

  290. <p><strong>Note</strong>: beginning and ending were collapsed for brevity.</p>

  291. <p>As you can see, both files look similar to <code>item.template</code> files we saw <a href="education.04.lang.html">before</a>.</p>

  292. <p>The changes include:</p>

  293. <ul>

  294. <li>new URLs to reference pages in <code>page</code> directory and first index (summary) file in <code>blog</code> directory</li>

  295. <li>title is now referenced inside <code>contents</code> section as a link to complete page</li>

  296. <li>date is referenced to highlight relationship among different blog posts in time</li>

  297. </ul>

  298. <p>Date reference uses new <code>PSKOV_ITEM_DATE</code> constant:</p>

  299. <table>

  300. <thead>

  301. <tr>

  302. <th>PSKOV constant</th>

  303. <th>Description</th>

  304. </tr>

  305. </thead>

  306. <tbody>

  307. <tr>

  308. <td><code>PSKOV_ITEM_DATE</code></td>

  309. <td>Provides date from <code>Date:</code> part of page's header section</td>

  310. </tr>

  311. </tbody>

  312. </table>

  313. <p><a name="preview"/></p>

  314. <h2 id="04investigatepreviewtemplates">04. Investigate preview templates</h2>

  315. <ul>

  316. <li><p><code>en/blog/preview.template</code> contents:</p>

  317. <pre><code>&lt;div class="contents"&gt;

  318.     &lt;h2 class="itemTitle"&gt;

  319.         &lt;a href="PSKOV_ITEM_URL"&gt;PSKOV_ITEM_TITLE&lt;/a&gt;

  320.     &lt;/h2&gt;

  321.     &lt;p class="itemDate"&gt;PSKOV_ITEM_DATE&lt;/p&gt;

  322. PSKOV_PREVIEW

  323.     &lt;div class="itemMore"&gt;

  324.         &lt;a href="PSKOV_ITEM_URL"&gt;Continue reading&lt;/a&gt;

  325.     &lt;/div&gt;

  326. &lt;/div&gt;

  327. </code></pre></li>

  328. <li><p><code>ru/blog/preview.template</code> contents:</p>

  329. <pre><code>&lt;div class="contents"&gt;

  330.     &lt;h2 class="itemTitle"&gt;

  331.         &lt;a href="PSKOV_ITEM_URL"&gt;PSKOV_ITEM_TITLE&lt;/a&gt;

  332.     &lt;/h2&gt;

  333.     &lt;p class="itemDate"&gt;PSKOV_ITEM_DATE&lt;/p&gt;

  334. PSKOV_PREVIEW

  335.     &lt;div class="itemMore"&gt;

  336.         &lt;a href="PSKOV_ITEM_URL"&gt;Читать дальше&lt;/a&gt;

  337.     &lt;/div&gt;

  338. &lt;/div&gt;

  339. </code></pre></li>

  340. </ul>

  341. <p>Previews have no <code>&lt;head&gt;</code>, <code>&lt;body&gt;</code>, and similar full page HTML tags. Previews represent sections inserted into index (summary) files.</p>

  342. <p>Preview itself is referenced by <code>PSKOV_PREVIEW</code> constant:</p>

  343. <table>

  344. <thead>

  345. <tr>

  346. <th>PSKOV constant</th>

  347. <th>Description</th>

  348. </tr>

  349. </thead>

  350. <tbody>

  351. <tr>

  352. <td><code>PSKOV_PREVIEW</code></td>

  353. <td>Provides contents from a Markdown file limited by <code>previewSize</code> characters (approximately)</td>

  354. </tr>

  355. </tbody>

  356. </table>

  357. <p><a name="index"/></p>

  358. <h2 id="05investigateindexsummarytemplates">05. Investigate index (summary) templates</h2>

  359. <ul>

  360. <li><p><code>en/blog/index.template</code> contents:</p>

  361. <pre><code>- - - - Collapsed for brevity - - - -

  362. &lt;body&gt;

  363.     &lt;div id="header"&gt;

  364.         &lt;strong&gt;Serov&lt;/strong&gt;

  365.         &lt;a href="../../en/blog/index.html"&gt;Blog&lt;/a&gt;

  366.         &lt;a href="../../en/page/about.html"&gt;About me&lt;/a&gt;

  367.         &lt;a href="../../en/page/cv.html"&gt;CV&lt;/a&gt;

  368.         &lt;div id="lang"&gt;

  369.             &lt;a href="../../en/blog/PSKOV_INDEX_URL"&gt;EN&lt;/a&gt;

  370.             &lt;a href="../../ru/blog/PSKOV_INDEX_URL"&gt;RU&lt;/a&gt;

  371.         &lt;/div&gt;

  372.     &lt;/div&gt;

  373.     &lt;center&gt;

  374.         &lt;h1&gt;Blog&lt;/h1&gt;

  375. PSKOV_PREVIEWS

  376. PSKOV_PAGINATION

  377.         &lt;div id="footer"&gt;

  378.             This sample web site has been generated by &lt;a href="http://opengamestudio.org/pskov"&gt;PSKOV&lt;/a&gt;.

  379.         &lt;/div&gt;

  380.     &lt;/center&gt;

  381. &lt;/body&gt;

  382. - - - - Collapsed for brevity - - - -

  383. </code></pre></li>

  384. <li><p><code>ru/blog/index.template</code> contents:</p>

  385. <pre><code>- - - - Collapsed for brevity - - - -

  386. &lt;body&gt;

  387.     &lt;div id="header"&gt;

  388.         &lt;strong&gt;Серов&lt;/strong&gt;

  389.         &lt;a href="../../ru/blog/index.html"&gt;Блог&lt;/a&gt;

  390.         &lt;a href="../../ru/page/about.html"&gt;Обо мне&lt;/a&gt;

  391.         &lt;a href="../../ru/page/cv.html"&gt;Резюме&lt;/a&gt;

  392.         &lt;div id="lang"&gt;

  393.             &lt;a href="../../en/blog/PSKOV_INDEX_URL"&gt;EN&lt;/a&gt;

  394.             &lt;a href="../../ru/blog/PSKOV_INDEX_URL"&gt;RU&lt;/a&gt;

  395.         &lt;/div&gt;

  396.     &lt;/div&gt;

  397.     &lt;center&gt;

  398.         &lt;h1&gt;Блог&lt;/h1&gt;

  399. PSKOV_PREVIEWS

  400. PSKOV_PAGINATION

  401.         &lt;div id="footer"&gt;

  402.             Этот пример сайта сгенерирован &lt;a href="http://opengamestudio.org/pskov"&gt;ПСКОВОМ&lt;/a&gt;.

  403.         &lt;/div&gt;

  404.     &lt;/center&gt;

  405. &lt;/body&gt;

  406. - - - - Collapsed for brevity - - - -

  407. </code></pre></li>

  408. </ul>

  409. <p><strong>Notes</strong>:</p>

  410. <ul>

  411. <li>beginning and ending were collapsed for brevity</li>

  412. <li><code>PSKOV_INDEX_URL</code> constant is used to provide language selection</li>

  413. </ul>

  414. <p>Index (summary) files are used to host previews.</p>

  415. <p>Here are new <strong>PSKOV</strong> constants explained:</p>

  416. <table>

  417. <thead>

  418. <tr>

  419. <th>PSKOV constant</th>

  420. <th>Description</th>

  421. </tr>

  422. </thead>

  423. <tbody>

  424. <tr>

  425. <td><code>PSKOV_INDEX_URL</code></td>

  426. <td>Provides generated page's file name: <code>&lt;previewsPageBaseName&gt;&lt;id&gt;.html</code></td>

  427. </tr>

  428. <tr>

  429. <td><code>PSKOV_PREVIEWS</code></td>

  430. <td>Provides a combination of <code>PSKOV_PREVIEW</code> sections</td>

  431. </tr>

  432. <tr>

  433. <td><code>PSKOV_PAGINATION</code></td>

  434. <td>Provides pagination section to navigate index (summary) pages</td>

  435. </tr>

  436. </tbody>

  437. </table>

  438. <p><a name="pagination"/></p>

  439. <h2 id="06investigatepaginationtemplates">06. Investigate pagination templates</h2>

  440. <p>Pagination templates represent sections used to navigate index (summary) pages.</p>

  441. <p>There are free pagination templates:</p>

  442. <table>

  443. <thead>

  444. <tr>

  445. <th>Pagination template</th>

  446. <th>Description</th>

  447. </tr>

  448. </thead>

  449. <tbody>

  450. <tr>

  451. <td>prev</td>

  452. <td>Is used for the last index (summary) page because we can only go backwards</td>

  453. </tr>

  454. <tr>

  455. <td>next</td>

  456. <td>Is used for the first index (summary) page because we can only go forward</td>

  457. </tr>

  458. <tr>

  459. <td>both</td>

  460. <td>Is used for intermediate index (summary) pages because we can either go backwards, or forward</td>

  461. </tr>

  462. </tbody>

  463. </table>

  464. <p>Let's look at English pagination templates:</p>

  465. <ul>

  466. <li><p><code>en/blog/pagination.prev.template</code> contents:</p>

  467. <pre><code>&lt;p&gt;Page PSKOV_PAGE_ID of PSKOV_PAGES_COUNT&lt;/p&gt;

  468. &lt;p&gt;

  469.     &lt;a href="PSKOV_PREV_PAGE_URL"&gt;« Newer&lt;/a&gt;

  470. &lt;/p&gt;

  471. </code></pre></li>

  472. <li><p><code>en/blog/pagination.next.template</code> contents:</p>

  473. <pre><code>&lt;p&gt;Page PSKOV_PAGE_ID of PSKOV_PAGES_COUNT&lt;/p&gt;

  474. &lt;p&gt;

  475.     &lt;a href="PSKOV_NEXT_PAGE_URL"&gt;Older »&lt;/a&gt;

  476. &lt;/p&gt;

  477. </code></pre></li>

  478. <li><p><code>en/blog/pagination.template</code> contents:</p>

  479. <pre><code>&lt;p&gt;Page PSKOV_PAGE_ID of PSKOV_PAGES_COUNT&lt;/p&gt;

  480. &lt;p&gt;

  481.     &lt;a href="PSKOV_PREV_PAGE_URL"&gt;« Newer&lt;/a&gt;

  482.     &lt;a href="PSKOV_NEXT_PAGE_URL"&gt;Older »&lt;/a&gt;

  483. &lt;/p&gt;

  484. </code></pre></li>

  485. </ul>

  486. <p>Russian counterparts look similar. Here's <code>ru/blog/pagination.template</code> contents:</p>

  487. <pre><code>&lt;p&gt;Страница PSKOV_PAGE_ID из PSKOV_PAGES_COUNT&lt;/p&gt;

  488. &lt;p&gt;

  489.     &lt;a href="PSKOV_PREV_PAGE_URL"&gt;« Новее&lt;/a&gt;

  490.     &lt;a href="PSKOV_NEXT_PAGE_URL"&gt;Старее »&lt;/a&gt;

  491. &lt;/p&gt;

  492. </code></pre>

  493. <p>Here are new <strong>PSKOV</strong> constants we used:</p>

  494. <table>

  495. <thead>

  496. <tr>

  497. <th>PSKOV constant</th>

  498. <th>Description</th>

  499. </tr>

  500. </thead>

  501. <tbody>

  502. <tr>

  503. <td><code>PSKOV_PAGE_ID</code></td>

  504. <td>Provides index (summary) page id starting from <code>1</code></td>

  505. </tr>

  506. <tr>

  507. <td><code>PSKOV_PAGES_COUNT</code></td>

  508. <td>Provides total number of index (summary) pages generated</td>

  509. </tr>

  510. <tr>

  511. <td><code>PSKOV_PREV_PAGE_URL</code></td>

  512. <td>Provides previous index (summary) page file name</td>

  513. </tr>

  514. <tr>

  515. <td><code>PSKOV_NEXT_PAGE_URL</code></td>

  516. <td>Provides next index (summary) page file name</td>

  517. </tr>

  518. </tbody>

  519. </table>

  520. <p><a name="md"/></p>

  521. <h2 id="07investigatemarkdownfiles">07. Investigate Markdown files</h2>

  522. <p>Markdown files represent blog posts and they look almost like Markdown files for pages. Here's <code>en/blog/1885.md</code> contents:</p>

  523. <pre><code> Title: Bullocks

  524.  Date: 1885

  525.  Slug: 1885.01.bullocks

  526. 

  527.  ![Bullocks][bullocks]

  528. 

  529.  I've been painting "Bullocks" sketch while I was staying in Odessa at Kuznetsov's in 1885.

  530. 

  531.  [bullocks]: https://upload.wikimedia.org/wikipedia/commons/c/cb/Walentin_Aleksandrovich_Serov_Bullocks.jpg

  532. </code></pre>

  533. <p>Date is used to sort blog posts by date in ascending order:</p>

  534. <table>

  535. <thead>

  536. <tr>

  537. <th>Header constant</th>

  538. <th>Description</th>

  539. </tr>

  540. </thead>

  541. <tbody>

  542. <tr>

  543. <td><code>Date:</code></td>

  544. <td>Provides value for <code>PSKOV_ITEM_DATE</code> constant when generating HTML out of Markdown</td>

  545. </tr>

  546. </tbody>

  547. </table>

  548. <p><a name="gen"/></p>

  549. <h2 id="08launchlfsaandgeneratethesite">08. Launch LFSA and generate the site</h2>

  550. <p>Launch <a href="http://opengamestudio.org/lfsa">LFSA</a> so that it points to directory with the files we just observed:</p>

  551. <pre><code>$ /path/to/lfsa-201905.py /path/to/dir/03.Blog

  552. </code></pre>

  553. <p>Generate the site:</p>

  554. <ul>

  555. <li>Go to <a href="http://opengamestudio.org/pskov">Tool</a> page</li>

  556. <li>Press <code>Generate</code> button</li>

  557. <li>Open generated <code>en/blog/index.html</code> or <code>ru/blog/index.html</code> from the site's directory locally</li>

  558. <li>Navigate index (summary) pages to make sure everything works fine</li>

  559. </ul>

  560. <p><a name="summary"/></p>

  561. <h2 id="09summary">09. Summary</h2>

  562. <p>You have successfully generated a web site with "constant" and "dynamic" pages. <a href="http://opengamestudio.org/pskov/sample/03.Blog/en/blog/index.html">Check out the result</a>.</p>

  563. <p>Introduced PSKOV constants include:</p>

  564. <table>

  565. <thead>

  566. <tr>

  567. <th>PSKOV constant</th>

  568. <th>Description</th>

  569. </tr>

  570. </thead>

  571. <tbody>

  572. <tr>

  573. <td><code>PSKOV_ITEM_DATE</code></td>

  574. <td>Provides date from <code>Date:</code> part of page's header section</td>

  575. </tr>

  576. <tr>

  577. <td><code>PSKOV_PREVIEW</code></td>

  578. <td>Provides contents from a Markdown file limited by <code>previewSize</code> characters (approximately)</td>

  579. </tr>

  580. <tr>

  581. <td><code>PSKOV_INDEX_URL</code></td>

  582. <td>Provides generated page's file name: <code>&lt;previewsPageBaseName&gt;&lt;id&gt;.html</code></td>

  583. </tr>

  584. <tr>

  585. <td><code>PSKOV_PREVIEWS</code></td>

  586. <td>Provides a combination of <code>PSKOV_PREVIEW</code> sections</td>

  587. </tr>

  588. <tr>

  589. <td><code>PSKOV_PAGINATION</code></td>

  590. <td>Provides pagination section to navigate index (summary) pages</td>

  591. </tr>

  592. <tr>

  593. <td><code>PSKOV_PAGE_ID</code></td>

  594. <td>Provides index (summary) page id starting from <code>1</code></td>

  595. </tr>

  596. <tr>

  597. <td><code>PSKOV_PAGES_COUNT</code></td>

  598. <td>Provides total number of index (summary) pages generated</td>

  599. </tr>

  600. <tr>

  601. <td><code>PSKOV_PREV_PAGE_URL</code></td>

  602. <td>Provides previous index (summary) page file name</td>

  603. </tr>

  604. <tr>

  605. <td><code>PSKOV_NEXT_PAGE_URL</code></td>

  606. <td>Provides next index (summary) page file name</td>

  607. </tr>

  608. </tbody>

  609. </table>

  610. <p>Introduced configuration keys include:</p>

  611. <table>

  612. <thead>

  613. <tr>

  614. <th>Key</th>

  615. <th>Description</th>

  616. </tr>

  617. </thead>

  618. <tbody>

  619. <tr>

  620. <td><code>preview</code></td>

  621. <td>Points to an HTML template file that is used to generate HTML previews out of the first <code>previewSize</code> (approximately) characters of Markdown files</td>

  622. </tr>

  623. <tr>

  624. <td><code>index</code></td>

  625. <td>Points to an HTML template file that is used to generate HTML index (summary) files to host previews</td>

  626. </tr>

  627. <tr>

  628. <td><code>paginationPrev</code></td>

  629. <td>Points to an HTML template file that is used to generate pagination section used by the <em>last</em> index (summary) file</td>

  630. </tr>

  631. <tr>

  632. <td><code>paginationNext</code></td>

  633. <td>Points to an HTML template file that is used to generate pagination section used by the <em>first</em> index (summary) file</td>

  634. </tr>

  635. <tr>

  636. <td><code>paginationPrevNext</code></td>

  637. <td>Points to an HTML template file that is used to generate pagination section used by index (summary) files <em>except the ones at the beginning and at the end</em></td>

  638. </tr>

  639. <tr>

  640. <td><code>previewSize</code></td>

  641. <td>How many characters (approximately) to take out of a Markdown file to generate an HTML preview</td>

  642. </tr>

  643. <tr>

  644. <td><code>previewEnding</code></td>

  645. <td>String to use at the end of HTML previews</td>

  646. </tr>

  647. <tr>

  648. <td><code>previewsPerPage</code></td>

  649. <td>Number of HTML previews hosted by single index (summary) file</td>

  650. </tr>

  651. <tr>

  652. <td><code>previewsPageBaseName</code></td>

  653. <td>Index (summary) file base name</td>

  654. </tr>

  655. </tbody>

  656. </table>

  657. <p>Introduced header constants include:</p>

  658. <table>

  659. <thead>

  660. <tr>

  661. <th>Header constant</th>

  662. <th>Description</th>

  663. </tr>

  664. </thead>

  665. <tbody>

  666. <tr>

  667. <td><code>Date:</code></td>

  668. <td>Provides value for <code>PSKOV_ITEM_DATE</code> constant when generating HTML out of Markdown</td>

  669. </tr>

  670. </tbody>

  671. </table>

  672. <p>This was the final document to make you proficient in generating static sites with <strong>PSKOV</strong>. If you like what we do, support us by joining our group at <a href="https://twitter.com/OpenGameStudio">Twitter</a>, <a href="https://www.facebook.com/groups/162611230470183">Facebook</a>, or <a href="https://vk.com/opengamestudo">VK</a>.</p>

  673. <p>Now use <strong>PSKOV</strong> to generate your very own web site!</p>

  674. <p></div><div class="contents"></p>

  675. <table>

  676. <thead>

  677. <tr>

  678. <th>&lt; Back</th>

  679. <th>Index</th>

  680. <th>Next &gt;</th>

  681. </tr>

  682. </thead>

  683. <tbody>

  684. <tr>

  685. <td><a href="education.04.lang.html">04. Language</a></td>

  686. <td><a href="education.html">Education</a></td>

  687. <td>Not available</td>

  688. </tr>

  689. </tbody>

  690. </table>

  691.         </div></center>

  692.         <script type="text/javascript">

  693.         </script>

  694.     </body>

  695. </html>