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.

388 lines
14KB

  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. #header a
  13. {
  14. color: white;
  15. text-decoration: none;
  16. padding: 0.5em 1em 0.5em 1em;
  17. }
  18. #title
  19. {
  20. color: #433729;
  21. }
  22. html
  23. {
  24. font-family: sans-serif;
  25. }
  26. body
  27. {
  28. line-height: 1.5em;
  29. }
  30. body
  31. {
  32. background: #FAFAFA;
  33. }
  34. table
  35. {
  36. border-collapse: collapse;
  37. width: 100%;
  38. }
  39. table, th, td
  40. {
  41. border: 1px solid #aaa;
  42. padding: 0.5em;
  43. margin-top: 0.5em;
  44. margin-bottom: 0.5em;
  45. }
  46. code, pre
  47. {
  48. font-family: monospace, serif;
  49. font-size: 1em;
  50. color: #7f0a0c;
  51. background: #f5f5f5;
  52. white-space: pre-wrap;
  53. }
  54. .contents
  55. {
  56. background: #FFFFFF;
  57. width: 720px;
  58. padding: 1em;
  59. margin-top: 2em;
  60. margin-bottom: 2em;
  61. border: 1px solid #E0E0E0;
  62. text-align: left;
  63. color: #444;
  64. }
  65. #footer
  66. {
  67. text-align: center;
  68. }
  69. #lang
  70. {
  71. float: right;
  72. }
  73. </style>
  74. <title>
  75. PSKOV
  76. </title>
  77. </head>
  78. <body>
  79. <div id="header">
  80. <strong id="title">ПСКОВ</strong>
  81. <a href="pskov_1.0.0+ru.html">Инструмент</a>
  82. <a href="education.html">Обучение</a>
  83. <div id="lang">
  84. <a href="../en/education.03.site.html">EN</a>
  85. <a href="../ru/education.03.site.html">RU</a>
  86. </div>
  87. </div>
  88. <center><h1>
  89. Обучение: 03. Сайт
  90. </h1></center>
  91. <center><div class="contents">
  92. <table>
  93. <thead>
  94. <tr>
  95. <th>&lt; Назад</th>
  96. <th>Начало</th>
  97. <th>Далее &gt;</th>
  98. </tr>
  99. </thead>
  100. <tbody>
  101. <tr>
  102. <td><a href="education.02.deps.html">02. Зависимости</a></td>
  103. <td><a href="education.html">Обучение</a></td>
  104. <td><a href="education.04.lang.html">04. Язык</a></td>
  105. </tr>
  106. </tbody>
  107. </table>
  108. <p></div><div class="contents"></p>
  109. <p>В этом документы мы создадим простой статический сайт с двумя страницами.</p>
  110. <p>Ожидаемое время завершения: 10 минут.</p>
  111. <p><strong>Содержание</strong></p>
  112. <ul>
  113. <li><a href="#inspiration">01. Вдохновление</a></li>
  114. <li><a href="#cfg">02. Изучите файл <code>pskov.cfg</code></a></li>
  115. <li><a href="#item">03. Изучите файл <code>item.template</code></a></li>
  116. <li><a href="#md">04. Изучите файлы <code>about.md</code> и <code>cv.md</code></a></li>
  117. <li><a href="#lfsa">05. Запустите ЛФСД</a></li>
  118. <li><a href="#gen">06. Сгенерируйте сайт</a></li>
  119. <li><a href="#summary">07. Итог</a></li>
  120. </ul>
  121. <p><a name="inspiration"/></p>
  122. <h2 id="01">01. Вдохновление</h2>
  123. <p>Представьте, что вы являетесь выдающимся русским живописцем Валентином Серовым. Каждый раз, когда кто-либо хочет узнать о вас, он идёт на <a href="https://ru.wikipedia.org/wiki/%D0%A1%D0%B5%D1%80%D0%BE%D0%B2,_%D0%92%D0%B0%D0%BB%D0%B5%D0%BD%D1%82%D0%B8%D0%BD_%D0%90%D0%BB%D0%B5%D0%BA%D1%81%D0%B0%D0%BD%D0%B4%D1%80%D0%BE%D0%B2%D0%B8%D1%87">Википедию</a>. Сегодня утром вы просыпаетесь раньше обычного с отчётливым желанием создать свой собственный веб-сайт.</p>
  124. <p>Вы приступаете к созданию следующих страницы:</p>
  125. <ul>
  126. <li>About me</li>
  127. <li>Curriculum vitae (CV)</li>
  128. </ul>
  129. <p>Несколько позже в <a href="https://github.com/OGStudio/site-pskov-sample/tree/master/01.TwoPages">директории вашего сайта</a> у вас оказываются следующие файлы:</p>
  130. <ul>
  131. <li>pskov.cfg</li>
  132. <li>item.template</li>
  133. <li>about.md</li>
  134. <li>cv.md</li>
  135. </ul>
  136. <p>Давайте взглянем на их содержимое.</p>
  137. <p><a name="cfg"/></p>
  138. <h2 id="02pskovcfg">02. Изучите файл <code>pskov.cfg</code></h2>
  139. <p>Файл <code>pskov.cfg</code> содержит следующее:</p>
  140. <pre><code>input = .
  141. item = item.template
  142. </code></pre>
  143. <p><code>pskov.cfg</code> является <a href="https://ru.wikipedia.org/wiki/.ini">файлом настроек</a> со следующими ключами:</p>
  144. <table>
  145. <thead>
  146. <tr>
  147. <th>Ключ</th>
  148. <th>Описание</th>
  149. </tr>
  150. </thead>
  151. <tbody>
  152. <tr>
  153. <td><code>input</code></td>
  154. <td>Указывает на директорию с файлом, на который ссылается ключ <code>item</code></td>
  155. </tr>
  156. <tr>
  157. <td><code>item</code></td>
  158. <td>Указывает на файл с шаблоном HTML, который используется для генерации файлов HTML из Markdown</td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <p>В нашем случае файл <code>item.template</code> расположен рядом с <code>pskov.cfg</code>, поэтому мы используем <code>.</code> для обозначения текущей директории.</p>
  163. <p><a name="item"/></p>
  164. <h2 id="03itemtemplate">03. Изучите файл <code>item.template</code></h2>
  165. <p>Файл <code>item.template</code> содержит следующее:</p>
  166. <pre><code>&lt;!DOCTYPE html&gt;
  167. &lt;html&gt;
  168. &lt;meta charset="utf-8"&gt;
  169. &lt;head&gt;
  170. &lt;style&gt;
  171. - - - - Схлопнуто для краткости - - - -
  172. &lt;/style&gt;
  173. &lt;title&gt;Serov&lt;/title&gt;
  174. &lt;/head&gt;
  175. &lt;body&gt;
  176. &lt;div id="header"&gt;
  177. &lt;strong&gt;Serov&lt;/strong&gt;
  178. &lt;a href="about.html"&gt;About me&lt;/a&gt;
  179. &lt;a href="cv.html"&gt;CV&lt;/a&gt;
  180. &lt;/div&gt;
  181. &lt;center&gt;
  182. &lt;h1&gt;PSKOV_ITEM_TITLE&lt;/h1&gt;
  183. &lt;div class="contents"&gt;
  184. PSKOV_ITEM_CONTENTS
  185. &lt;/div&gt;
  186. &lt;div id="footer"&gt;
  187. This sample web site has been generated by &lt;a href="http://opengamestudio.org/pskov"&gt;PSKOV&lt;/a&gt;.
  188. &lt;/div&gt;
  189. &lt;/center&gt;
  190. &lt;/body&gt;
  191. &lt;/html&gt;
  192. </code></pre>
  193. <p><strong>Внимание</strong>: стиль схлопнут для краткости.</p>
  194. <p>Как видите, <code>item.template</code> представляет из себя обычный файл HTML с двумя константами <strong>ПСКОВА</strong>:</p>
  195. <table>
  196. <thead>
  197. <tr>
  198. <th>Константа ПСКОВА</th>
  199. <th>Описание</th>
  200. </tr>
  201. </thead>
  202. <tbody>
  203. <tr>
  204. <td><code>PSKOV_ITEM_TITLE</code></td>
  205. <td>Значение ключа <code>Title</code> из файла Markdown страницы</td>
  206. </tr>
  207. <tr>
  208. <td><code>PSKOV_ITEM_CONTENTS</code></td>
  209. <td>Предоставляет содержимое HTML, сгенерированное из Markdown</td>
  210. </tr>
  211. </tbody>
  212. </table>
  213. <p><strong>Замечания</strong>:</p>
  214. <ul>
  215. <li>другие константы <strong>ПСКОВА</strong> описаны позже</li>
  216. <li>файл Markdown страницы описан ниже</li>
  217. </ul>
  218. <p><a name="md"/></p>
  219. <h2 id="04aboutmdcvmd">04. Изучите файлы <code>about.md</code> и <code>cv.md</code></h2>
  220. <p>Файл <code>about.md</code> содержит следующее:</p>
  221. <pre><code> Title: About me
  222. Slug: about
  223. Hi, my name is Valentin Serov. Here's my self-portrait:
  224. ![Valentin Serov self-portrait][serov-portrait]
  225. - - - - Схлопнуто для краткости - - - -
  226. Have a look at my [CV][cv] now.
  227. [serov]: https://en.wikipedia.org/wiki/Valentin_Serov
  228. [revolution]: https://en.wikipedia.org/wiki/Russian_Revolution
  229. [serov-portrait]: myself.jpg
  230. [serov-work]: mywork.jpg
  231. [girl-with-peaches]: https://en.wikipedia.org/wiki/Girl_with_Peaches
  232. [pskov]: http://opengamestudio.org/pskov
  233. [cv]: cv.html
  234. </code></pre>
  235. <p><code>about.md</code> начинается с так называемого заголовка:</p>
  236. <table>
  237. <thead>
  238. <tr>
  239. <th>Ключ заголовка</th>
  240. <th>Описание</th>
  241. </tr>
  242. </thead>
  243. <tbody>
  244. <tr>
  245. <td><code>Title</code></td>
  246. <td>Предоставляет значение для константы <code>PSKOV_ITEM_TITLE</code> во время генерации HTML из Markdown</td>
  247. </tr>
  248. <tr>
  249. <td><code>Slug</code></td>
  250. <td>Сообщает <strong>ПСКОВУ</strong> о том, что этот файл должен быть сохранён как <code>&lt;slug&gt;.html</code></td>
  251. </tr>
  252. </tbody>
  253. </table>
  254. <p>В остальном содержимое <code>about.md</code> ничем не отличается от любых других файлов Markdown.</p>
  255. <p><strong>Внимание</strong>: ссылка на страницу <code>cv</code> указана как <code>cv.html</code>, не <code>cv.md</code></p>
  256. <p>Файл <code>cv.md</code> содержит следующее:</p>
  257. <pre><code> Title: Curriculum vitae
  258. Slug: cv
  259. Here's my CV in case my paintings still interest you. I took a bit of a modern IT approach to structure my CV as key-value pairs of a dictionary (map), enjoy!
  260. | Key | Value |
  261. |---|---|
  262. | Name | Valentin Serov |
  263. | Age | 46 |
  264. | Marital status | Married |
  265. | Country | Russian Empire |
  266. | Alma mater | Imperial Academy of Arts |
  267. | Education | * Member Academy of Arts (1898) &lt;br&gt; * Full Member Academy of Arts (1903) |
  268. </code></pre>
  269. <p>Как видите, в <code>cv.md</code> нет ничего нового за исключением таблицы Markdown.</p>
  270. <p><a name="lfsa"/></p>
  271. <h2 id="05">05. Запустите ЛФСД</h2>
  272. <p>Запустите <a href="http://opengamestudio.org/lfsa/ru">ЛФСД</a> с указанием директории, содержащей только что рассмотренные файлы:</p>
  273. <pre><code>$ /путь/до/lfsa_1.0.0.py /путь/до/директории/01.TwoPages
  274. </code></pre>
  275. <p>Вы должны увидеть примерно такой вывод:</p>
  276. <pre><code>DIR: '/Users/kornerr/p/site-pskov-sample/01.TwoPages'
  277. PORT: '8000'
  278. </code></pre>
  279. <p><a name="gen"/></p>
  280. <h2 id="06">06. Сгенерируйте сайт</h2>
  281. <p>Настало время сгенерировать свой собственный веб-сайт:</p>
  282. <ul>
  283. <li>Перейдите на страницу <a href="http://opengamestudio.org/pskov/ru/pskov_1.0.0+ru.html">Инструмент</a></li>
  284. <li>Убедитесь в том, что:<ul>
  285. <li><code>Путь</code> указывает на нужную директорию</li>
  286. <li><code>Входящая директория</code> и <code>Шаблон элемента</code> содержат значения из <code>pskov.cfg</code></li></ul></li>
  287. <li>Нажмите кнопку <code>Генерировать</code> для генерации файлов HTML рядом с файлами Markdown</li>
  288. <li>Откройте сгенерированный файл <code>about.html</code> из директории сайта</li>
  289. <li>Перед вами ваш собственный веб-сайт, запущенный локально</li>
  290. </ul>
  291. <p><a name="summary"/></p>
  292. <h2 id="07">07. Итог</h2>
  293. <p>Вы успешно сгенерировали веб-сайт с двумя страницами. <a href="http://opengamestudio.org/pskov/sample/01.TwoPages/about.html">Проверьте результат</a>.</p>
  294. <p>Представлены константы <strong>ПСКОВА</strong>:</p>
  295. <table>
  296. <thead>
  297. <tr>
  298. <th>Константа ПСКОВА</th>
  299. <th>Описание</th>
  300. </tr>
  301. </thead>
  302. <tbody>
  303. <tr>
  304. <td><code>PSKOV_ITEM_TITLE</code></td>
  305. <td>Значение ключа <code>Title</code> из файла Markdown страницы</td>
  306. </tr>
  307. <tr>
  308. <td><code>PSKOV_ITEM_CONTENTS</code></td>
  309. <td>Предоставляет содержимое HTML, сгенерированное из Markdown</td>
  310. </tr>
  311. </tbody>
  312. </table>
  313. <p>Представлены ключи настроек:</p>
  314. <table>
  315. <thead>
  316. <tr>
  317. <th>Ключ</th>
  318. <th>Описание</th>
  319. </tr>
  320. </thead>
  321. <tbody>
  322. <tr>
  323. <td><code>input</code></td>
  324. <td>Указывает на директорию с файлом, на который ссылается ключ <code>item</code></td>
  325. </tr>
  326. <tr>
  327. <td><code>item</code></td>
  328. <td>Указывает на файл с шаблоном HTML, который используется для генерации файлов HTML из Markdown</td>
  329. </tr>
  330. </tbody>
  331. </table>
  332. <p>Представлены ключи заголовка:</p>
  333. <table>
  334. <thead>
  335. <tr>
  336. <th>Ключ заголовка</th>
  337. <th>Описание</th>
  338. </tr>
  339. </thead>
  340. <tbody>
  341. <tr>
  342. <td><code>Title</code></td>
  343. <td>Предоставляет значение для константы <code>PSKOV_ITEM_TITLE</code> во время генерации HTML из Markdown</td>
  344. </tr>
  345. <tr>
  346. <td><code>Slug</code></td>
  347. <td>Сообщает <strong>ПСКОВУ</strong> о том, что этот файл должен быть сохранён как <code>&lt;slug&gt;.html</code></td>
  348. </tr>
  349. </tbody>
  350. </table>
  351. <p></div><div class="contents"></p>
  352. <table>
  353. <thead>
  354. <tr>
  355. <th>&lt; Назад</th>
  356. <th>Начало</th>
  357. <th>Далее &gt;</th>
  358. </tr>
  359. </thead>
  360. <tbody>
  361. <tr>
  362. <td><a href="education.02.deps.html">02. Зависимости</a></td>
  363. <td><a href="education.html">Обучение</a></td>
  364. <td><a href="education.04.lang.html">04. Язык</a></td>
  365. </tr>
  366. </tbody>
  367. </table>
  368. </div></center>
  369. <div id="footer">
  370. Сайт сгенерирован <a href="http://opengamestudio.org/pskov">ПСКОВОМ</a>
  371. из <a href="http://github.com/ogstudio/site-pskov">этого исходного кода</a>.
  372. Сайт расположен на <a href="https://pages.github.com">GitHub Pages</a>.
  373. </div>
  374. <script type="text/javascript">
  375. </script>
  376. </body>
  377. </html>