OGS-Main
/
ogs-site
2
0
Форк 0
Код Проблеми 0 Запити на злиття 0 Релізи 0 Вікі Активність
Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.
119 Коміти
2 Гілки
4.2GB
Дерево: 97a2959fe4
Гілки Теги
${ item.name }
Створити гілку ${ searchTerm }
з '97a2959fe4'
${ noResults }
ogs-site/pskov/en/education.05.blog.html

713 рядки
23KB
Неформатований Звинувачення Історія 

  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.             #footer

  68.             {

  69.                 text-align: center;

  70.             }

  71.             #lang

  72.             {

  73.                 float: right;

  74.             }

  75.         </style>

  76.         <title>

  77.             PSKOV

  78.         </title>

  79.     </head>

  80.     <body>

  81.         <div id="header">

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

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

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

  85.             <div id="lang">

  86.                 <a href="../en/education.05.blog.html">EN</a>

  87.                 <a href="../ru/education.05.blog.html">RU</a>

  88.             </div>

  89.         </div>

  90.         <center><h1>

  91. Education: 05. Blog

  92.         </h1></center>

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

  94. <table>

  95. <thead>

  96. <tr>

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

  98. <th>Index</th>

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

  100. </tr>

  101. </thead>

  102. <tbody>

  103. <tr>

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

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

  106. <td>Not available</td>

  107. </tr>

  108. </tbody>

  109. </table>

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

  111. <p>In this document we create "dynamic" pages for a blog.</p>

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

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

  114. <ul>

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

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

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

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

  119. <li><a href="#index">05. Investigate templates of preview pages</a></li>

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

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

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

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

  124. </ul>

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

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

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

  128. <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>

  129. <ul>

  130. <li><code>pskov.cfg</code></li>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  169. </ul>

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

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

  172. <h2 id="02investigatepskovcfgfile">02. Investigate <code>pskov.cfg</code> file</h2>

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

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

  175. item = item.template

  176. preview = preview.template

  177. index = index.template

  178. paginationPrev = pagination.prev.template

  179. paginationNext = pagination.next.template

  180. paginationPrevNext = pagination.template

  181. previewSize = 200

  182. previewEnding = . . .

  183. previewsPerPage = 3

  184. previewPageBaseName = index

  185. </code></pre>

  186. <p>You already met <code>input</code> and <code>item</code> keys. Let's see into new ones:</p>

  187. <table>

  188. <thead>

  189. <tr>

  190. <th>Key</th>

  191. <th>Description</th>

  192. </tr>

  193. </thead>

  194. <tbody>

  195. <tr>

  196. <td><code>preview</code></td>

  197. <td>Points to an HTML template that is used to generate HTML preview out of the first <code>previewSize</code> (approximately) characters for each Markdown file</td>

  198. </tr>

  199. <tr>

  200. <td><code>index</code></td>

  201. <td>Points to an HTML template that is used to generate preview page to host previews</td>

  202. </tr>

  203. <tr>

  204. <td><code>paginationPrev</code></td>

  205. <td>Points to an HTML template that is used to generate pagination section to navigate backwards</td>

  206. </tr>

  207. <tr>

  208. <td><code>paginationNext</code></td>

  209. <td>Points to an HTML template that is used to generate pagination section to navigate forward</td>

  210. </tr>

  211. <tr>

  212. <td><code>paginationPrevNext</code></td>

  213. <td>Points to an HTML template that is used to generate pagination section</td>

  214. </tr>

  215. <tr>

  216. <td><code>previewSize</code></td>

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

  218. </tr>

  219. <tr>

  220. <td><code>previewEnding</code></td>

  221. <td>String to use at the end of each preview</td>

  222. </tr>

  223. <tr>

  224. <td><code>previewsPerPage</code></td>

  225. <td>Maximum number of previews hosted by a preview page</td>

  226. </tr>

  227. <tr>

  228. <td><code>previewsPageBaseName</code></td>

  229. <td>Base file name for preview pages</td>

  230. </tr>

  231. </tbody>

  232. </table>

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

  234. <ul>

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

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

  237. <li>preview pages host <code>3</code> previews maximum</li>

  238. <li>preview pages are saved as <code>index.html</code>, <code>index2.html</code>, <code>index3.html</code>, etc.</li>

  239. </ul>

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

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

  242. <ul>

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

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

  245. &lt;body&gt;

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

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

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

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

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

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

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

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

  254.         &lt;/div&gt;

  255.     &lt;/div&gt;

  256.     &lt;center&gt;

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

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

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

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

  261.             &lt;/h2&gt;

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

  263. PSKOV_ITEM_CONTENTS

  264.         &lt;/div&gt;

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

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

  267.         &lt;/div&gt;

  268.     &lt;/center&gt;

  269. &lt;/body&gt;

  270. - - - - Collapsed for brevity - - - -

  271. </code></pre></li>

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

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

  274. &lt;body&gt;

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

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

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

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

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

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

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

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

  283.         &lt;/div&gt;

  284.     &lt;/div&gt;

  285.     &lt;center&gt;

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

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

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

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

  290.             &lt;/h2&gt;

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

  292. PSKOV_ITEM_CONTENTS

  293.         &lt;/div&gt;

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

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

  296.         &lt;/div&gt;

  297.     &lt;/center&gt;

  298. &lt;/body&gt;

  299. - - - - Collapsed for brevity - - - -

  300. </code></pre></li>

  301. </ul>

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

  303. <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>

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

  305. <ul>

  306. <li>new URLs to reference pages in <code>page</code> directory and the first preview page in <code>blog</code> directory</li>

  307. <li>title is referenced inside <code>contents</code> section as a link pointing to a complete blog post</li>

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

  309. </ul>

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

  311. <table>

  312. <thead>

  313. <tr>

  314. <th>PSKOV constant</th>

  315. <th>Description</th>

  316. </tr>

  317. </thead>

  318. <tbody>

  319. <tr>

  320. <td><code>PSKOV_ITEM_DATE</code></td>

  321. <td>Value of <code>Date</code> key of the page's Markdown file</td>

  322. </tr>

  323. </tbody>

  324. </table>

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

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

  327. <ul>

  328. <li><p><code>en/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;Continue reading&lt;/a&gt;

  337.     &lt;/div&gt;

  338. &lt;/div&gt;

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

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

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

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

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

  344.     &lt;/h2&gt;

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

  346. PSKOV_PREVIEW

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

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

  349.     &lt;/div&gt;

  350. &lt;/div&gt;

  351. </code></pre></li>

  352. </ul>

  353. <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 preview pages.</p>

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

  355. <table>

  356. <thead>

  357. <tr>

  358. <th>PSKOV constant</th>

  359. <th>Description</th>

  360. </tr>

  361. </thead>

  362. <tbody>

  363. <tr>

  364. <td><code>PSKOV_PREVIEW</code></td>

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

  366. </tr>

  367. </tbody>

  368. </table>

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

  370. <h2 id="05investigatetemplatesofpreviewpages">05. Investigate templates of preview pages</h2>

  371. <ul>

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

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

  374. &lt;body&gt;

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

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

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

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

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

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

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

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

  383.         &lt;/div&gt;

  384.     &lt;/div&gt;

  385.     &lt;center&gt;

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

  387. PSKOV_PREVIEWS

  388. PSKOV_PAGINATION

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

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

  391.         &lt;/div&gt;

  392.     &lt;/center&gt;

  393. &lt;/body&gt;

  394. - - - - Collapsed for brevity - - - -

  395. </code></pre></li>

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

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

  398. &lt;body&gt;

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

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

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

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

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

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

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

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

  407.         &lt;/div&gt;

  408.     &lt;/div&gt;

  409.     &lt;center&gt;

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

  411. PSKOV_PREVIEWS

  412. PSKOV_PAGINATION

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

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

  415.         &lt;/div&gt;

  416.     &lt;/center&gt;

  417. &lt;/body&gt;

  418. - - - - Collapsed for brevity - - - -

  419. </code></pre></li>

  420. </ul>

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

  422. <ul>

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

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

  425. </ul>

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

  427. <table>

  428. <thead>

  429. <tr>

  430. <th>PSKOV constant</th>

  431. <th>Description</th>

  432. </tr>

  433. </thead>

  434. <tbody>

  435. <tr>

  436. <td><code>PSKOV_INDEX_URL</code></td>

  437. <td>Provides generated preview page file name: <code>&lt;previewsPageBaseName&gt;&lt;id&gt;.html</code></td>

  438. </tr>

  439. <tr>

  440. <td><code>PSKOV_PREVIEWS</code></td>

  441. <td>Provides a set of previews</td>

  442. </tr>

  443. <tr>

  444. <td><code>PSKOV_PAGINATION</code></td>

  445. <td>Provides pagination section to navigate preview pages</td>

  446. </tr>

  447. </tbody>

  448. </table>

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

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

  451. <p>Pagination templates represent HTML sections to navigate preview pages.</p>

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

  453. <table>

  454. <thead>

  455. <tr>

  456. <th>Pagination template</th>

  457. <th>Description</th>

  458. </tr>

  459. </thead>

  460. <tbody>

  461. <tr>

  462. <td>Previous</td>

  463. <td>A visitor can only go backwards</td>

  464. </tr>

  465. <tr>

  466. <td>Next</td>

  467. <td>A visitor can only go forward</td>

  468. </tr>

  469. <tr>

  470. <td>Both</td>

  471. <td>A visitor can either go backwards, or forward</td>

  472. </tr>

  473. </tbody>

  474. </table>

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

  476. <ul>

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

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

  479. &lt;p&gt;

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

  481. &lt;/p&gt;

  482. </code></pre></li>

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

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

  485. &lt;p&gt;

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

  487. &lt;/p&gt;

  488. </code></pre></li>

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

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

  491. &lt;p&gt;

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

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

  494. &lt;/p&gt;

  495. </code></pre></li>

  496. </ul>

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

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

  499. &lt;p&gt;

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

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

  502. &lt;/p&gt;

  503. </code></pre>

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

  505. <table>

  506. <thead>

  507. <tr>

  508. <th>PSKOV constant</th>

  509. <th>Description</th>

  510. </tr>

  511. </thead>

  512. <tbody>

  513. <tr>

  514. <td><code>PSKOV_PAGE_ID</code></td>

  515. <td>Provides preview page id starting from <code>1</code></td>

  516. </tr>

  517. <tr>

  518. <td><code>PSKOV_PAGES_COUNT</code></td>

  519. <td>Provides total number of generated preview pages</td>

  520. </tr>

  521. <tr>

  522. <td><code>PSKOV_PREV_PAGE_URL</code></td>

  523. <td>Provides previous preview page file name</td>

  524. </tr>

  525. <tr>

  526. <td><code>PSKOV_NEXT_PAGE_URL</code></td>

  527. <td>Provides next preview page file name</td>

  528. </tr>

  529. </tbody>

  530. </table>

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

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

  533. <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>

  534. <pre><code> Title: Bullocks

  535.  Date: 1885

  536.  Slug: 1885.01.bullocks

  537. 

  538.  ![Bullocks][bullocks]

  539. 

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

  541. 

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

  543. </code></pre>

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

  545. <table>

  546. <thead>

  547. <tr>

  548. <th>Header key</th>

  549. <th>Description</th>

  550. </tr>

  551. </thead>

  552. <tbody>

  553. <tr>

  554. <td><code>Date</code></td>

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

  556. </tr>

  557. </tbody>

  558. </table>

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

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

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

  562. <pre><code>$ /path/to/lfsa_1.0.0.py /path/to/dir/03.Blog

  563. </code></pre>

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

  565. <ul>

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

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

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

  569. <li>Navigate preview pages to make sure everything works fine</li>

  570. </ul>

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

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

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

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

  575. <table>

  576. <thead>

  577. <tr>

  578. <th>PSKOV constant</th>

  579. <th>Description</th>

  580. </tr>

  581. </thead>

  582. <tbody>

  583. <tr>

  584. <td><code>PSKOV_ITEM_DATE</code></td>

  585. <td>Value of <code>Date</code> key of the page's Markdown file</td>

  586. </tr>

  587. <tr>

  588. <td><code>PSKOV_PREVIEW</code></td>

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

  590. </tr>

  591. <tr>

  592. <td><code>PSKOV_INDEX_URL</code></td>

  593. <td>Provides generated preview page file name: <code>&lt;previewsPageBaseName&gt;&lt;id&gt;.html</code></td>

  594. </tr>

  595. <tr>

  596. <td><code>PSKOV_PREVIEWS</code></td>

  597. <td>Provides a set of previews</td>

  598. </tr>

  599. <tr>

  600. <td><code>PSKOV_PAGINATION</code></td>

  601. <td>Provides pagination section to navigate preview pages</td>

  602. </tr>

  603. <tr>

  604. <td><code>PSKOV_PAGE_ID</code></td>

  605. <td>Provides preview page id starting from <code>1</code></td>

  606. </tr>

  607. <tr>

  608. <td><code>PSKOV_PAGES_COUNT</code></td>

  609. <td>Provides total number of generated preview pages</td>

  610. </tr>

  611. <tr>

  612. <td><code>PSKOV_PREV_PAGE_URL</code></td>

  613. <td>Provides previous preview page file name</td>

  614. </tr>

  615. <tr>

  616. <td><code>PSKOV_NEXT_PAGE_URL</code></td>

  617. <td>Provides next preview page file name</td>

  618. </tr>

  619. </tbody>

  620. </table>

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

  622. <table>

  623. <thead>

  624. <tr>

  625. <th>Key</th>

  626. <th>Description</th>

  627. </tr>

  628. </thead>

  629. <tbody>

  630. <tr>

  631. <td><code>preview</code></td>

  632. <td>Points to an HTML template that is used to generate HTML preview out of the first <code>previewSize</code> (approximately) characters for each Markdown file</td>

  633. </tr>

  634. <tr>

  635. <td><code>index</code></td>

  636. <td>Points to an HTML template that is used to generate preview page to host previews</td>

  637. </tr>

  638. <tr>

  639. <td><code>paginationPrev</code></td>

  640. <td>Points to an HTML template that is used to generate pagination section to navigate backwards</td>

  641. </tr>

  642. <tr>

  643. <td><code>paginationNext</code></td>

  644. <td>Points to an HTML template that is used to generate pagination section to navigate forward</td>

  645. </tr>

  646. <tr>

  647. <td><code>paginationPrevNext</code></td>

  648. <td>Points to an HTML template that is used to generate pagination section</td>

  649. </tr>

  650. <tr>

  651. <td><code>previewSize</code></td>

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

  653. </tr>

  654. <tr>

  655. <td><code>previewEnding</code></td>

  656. <td>String to use at the end of each preview</td>

  657. </tr>

  658. <tr>

  659. <td><code>previewsPerPage</code></td>

  660. <td>Maximum number of previews hosted by a preview page</td>

  661. </tr>

  662. <tr>

  663. <td><code>previewsPageBaseName</code></td>

  664. <td>Base file name for preview pages</td>

  665. </tr>

  666. </tbody>

  667. </table>

  668. <p>Introduced header keys include:</p>

  669. <table>

  670. <thead>

  671. <tr>

  672. <th>Header key</th>

  673. <th>Description</th>

  674. </tr>

  675. </thead>

  676. <tbody>

  677. <tr>

  678. <td><code>Date</code></td>

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

  680. </tr>

  681. </tbody>

  682. </table>

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

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

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

  686. <table>

  687. <thead>

  688. <tr>

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

  690. <th>Index</th>

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

  692. </tr>

  693. </thead>

  694. <tbody>

  695. <tr>

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

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

  698. <td>Not available</td>

  699. </tr>

  700. </tbody>

  701. </table>

  702.         </div></center>

  703.         <div id="footer">

  704.             The site has been generated by <a href="http://opengamestudio.org/pskov">PSKOV</a>

  705.             from <a href="http://github.com/ogstudio/site-pskov">this source code</a>.

  706.             The site is hosted by <a href="https://pages.github.com">GitHub Pages</a>.

  707.         </div>

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

  709.         </script>

  710.     </body>

  711. </html>