-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
533 lines (446 loc) · 24.2 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
<!DOCTYPE html>
<html lang="en">
<head>
<title>PHP-документация — год спустя</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="shower/themes/ribbon/styles/styles.css">
<link rel="stylesheet" href="vendor/highlight.js/default.min.css">
<link rel="stylesheet" href="vendor/icomoon/style.css">
<link rel="stylesheet" href="styles.css">
</head>
<body class="shower list">
<header class="caption">
<h1>PHP-документация — год спустя</h1>
<p>@<strong>lex111</strong></p>
</header>
<section class="slide" id="intro">
<h2>
Боль, отчаяние и безысходность, или как я переводил документацию PHP
<span class="elephant-emoji">🐘</span>
</h2>
<div class="bottom-panel">
<div class="author-info">
<a target="_blank" href="https://github.com/lex111">
<img class="author-info-avatar" src="pictures/avatar.png" alt="lex111">
<strong>lex111</strong>
</a>
</div>
<span class="date">13.10.18, Ростов-на-Дону</span>
<a target="_blank" href="https://vk.com/rnd_php">
<img class="rnd-php-logo" src="pictures/rnd-php.png" alt="rnd-php-logo">
</a>
</div>
<img class="cover cover-main" src="pictures/main-page.png" alt="Главная страница руководства PHP">
</section>
<section class="slide">
<h2>Вопрос на засыпку: <br> кто кликал на одну из этих ссылок? 🧐</h2>
<img class="media full-width" src="pictures/edit.png" alt="Участие в документации">
</section>
<section class="slide">
<ul class="columns four no-bullets typos-list">
<li>функцуий</li>
<li>интекграцией</li>
<li>качесте</li>
<li>содеращая</li>
<li>прользователем</li>
<li>пакеп</li>
<li>фармат</li>
<li>библиотекм</li>
<li>звблокирует</li>
<li>цемыми</li>
<li>бцдет</li>
<li>запятоц</li>
<li>модет</li>
<li>дял</li>
<li>анпрямую</li>
<li>объевить</li>
<li>позваляет</li>
<li>дуступ</li>
<li>пердоствращает</li>
<li>атомармым</li>
<li>волзвращает</li>
<li>интерпритирован</li>
<li>примает</li>
<li>познее</li>
<li>движек</li>
<li>констуктор</li>
<li>убдет</li>
<li>аттрибут</li>
</ul>
<img class="cover cover-blurred" src="pictures/wtf.jpg" alt="Главная страница руководства PHP">
</section>
<section class="slide">
<h2>Краткая история русской документации 🕵️</h2>
<ul class="long-list">
<li>Начинается с конца 2001 года 🚀</li>
<li>На момент 2005 года в определенной степени переведены основные части 😌</li>
<li>C 2008 года команда переводчиков распалась — документация остаётся в
заброшенном
состоянии 😮</li>
<li>С конца 2009 года из-за сильной неактуальности русский перевод исчезает с
официального сайта 😢 <span class="note">(скорее всего из-за мажорной версии 5.3, вышедшей в конце июня 2009 года)</span></li>
<li>В октябре 2010 года начинается возрождение документации 😲</li>
<li>Летом 2011 года появляется веб-приложение для редактирования документации,
созданное, кстати, основным переводчиком французской документации —
Янником Торресом 👏
</li>
<li>В ноябре 2011 года русский перевод вновь, наконец, становится
доступным на
сайте 🎉</li>
</ul>
Продолжение следует ➡️
</section>
<section class="slide">
<h2>Краткая история русской документации: продолжение</h2>
<figure>
<blockquote>
<p>
На данный момент перевод на русский находится в некотором анабиозе. <br>
Все активные переводчики потеряли интерес или не могут найти на него время
(увы, включая меня). А все новые люди, проявлявшие интерес, тоже как-то
быстро пропадают =)
</p>
</blockquote>
<figcaption>Александр Москалёв о состоянии команды переводчиков в 2016 году</figcaption>
</figure>
<ul class="long-list">
<li>В 2016 году появляется новый мейнтейнер — Андрей Громов, он же единственный активный</li>
<li>На момент 2018 года в команде переводчиков всего два активных мейнтейнера,
но нужно больше 🤕</li>
</ul>
</section>
<section class="slide">
<h2>Что даст поддержка документации?</h2>
<ol>
<li class="next">Языковая практика английского языка 👌</li>
<li class="next">Прокачка знаний по PHP 💪. <span class="note">Спорно, однако точно что-то наверняка узнаешь новое.</span></li>
<li class="next">Улучшение понимания своего родного языка. <span class="note">Так или иначе, ошибаться станешь меньше, а может быть и вовсе станешь граммар-наци! 🤓</span></li>
<li class="next">Это опенсорс, поскольку ты добровольно
занимаешься общественно-полезным делом 😇</li>
<li class="next">«Ачивка» в резюме, а почему бы и нет?! 😉</li>
</ol>
</section>
<section class="slide">
<h2>Хм, звучит заманчиво, а что ещё?</h2>
<ol>
<li class="next">Самое главное — SVN-аккаунт, который помимо непосредственно редактирования документации даёт право голоса за RFC! 🗳️</li>
<li class="next">Профиль на сайтах PHP: people.php.net, wiki.php.net</li>
<li class="next">«Электронный» адрес с доменом @php.net 📧</li>
<!-- на самом деле это не настоящий почтовый
ящик, а пересылка сообщений на определенную почту, например, на Gmail, т.е.
отправлять сообщения не получится, но зато их можно получать через него. -->
<li class="next">Возможность редактировать/удалять комментарии пользователей на сайте <br>
<img class="media" src="pictures/edit-contributed-notes.png" alt="">
</li>
</ol>
</section>
<section class="slide">
<h2>Окей, я хочу заниматься русским переводом, с чего мне начать? ✍️</h2>
Есть два варианта:
<ol>
<li class="next">Переводить новые страницы, например, не хватает перевода по MongoDB</li>
<li class="next">Заниматься вычиткой существующих переводов: здесь уже всё более менее хорошо, однако есть ещё тысячи страниц для вычитки</li>
</ol>
</section>
<section class="slide">
<h2>Коротко, как устроена документация</h2>
<ul>
<li class="next">Хранится в <a href="http://svn.php.net/viewvc/phpdoc/ru/trunk/" target="_blank">SVN-репозитории</a></li>
<li class="next">Пишется в формате DocBlock (<a target="_blank" href="https://ru.wikipedia.org/wiki/SGML">SGML</a> -> XML)</li>
<li class="next">Собирается раз день около 8 часов утра (МСК), но есть специальное зеркало — <a target="_blank" href="http://docs.php.net/">http://docs.php.net/</a>, которое обновляется четыре раза в день с интервалом в шесть часов: 3:15, 9:15, 15:15, 21:15 (МСК)</li>
<li class="next">Генерируется с помощью инструмента <a target="_blank" href="http://doc.php.net/phd/docs/">Phd (Php Docbook Renderer)</a></li>
<li class="next">Редактируется через онлайн-редактор — <a target="_blank" href="http://edit.php.net">edit.php.net</a></li>
<!-- но владельцы SVN-аккаунта могут работать напрямую с репозиторием -->
<!-- <li class="next"></li> -->
</ul>
</section>
<section class="slide" id="example-doc">
<h2>Пример файла документации️</h2>
<pre>
<code><?xml version="1.0" encoding="utf-8"?>
<!-- <mark>$Revision: 344912</mark> $ -->
<!-- <mark>EN-Revision: 344864</mark> Maintainer: lex Status: ready -->
<!-- <mark>Reviewed: no</mark> -->
<refentry xml:id="function.is-countable" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>is_countable</refname>
<refpurpose>
Проверить, что содержимое переменной является счетным значением
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>is_countable</methodname>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
</methodsynopsis>
<para>
Проверить, что содержимое переменной массив (<type>array</type>) или
объект, реализующий <classname>Countable</classname>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem>
<para>
Значение для проверки
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает &true;, если <parameter>var</parameter> счетная или &false; в противном случае.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>7.3.0</entry>
<entry>
Добавлена функция <function>is_countable</function>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Примеры использования <function>is_countable</function></title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(is_countable([1, 2, 3])); // bool(true)
var_dump(is_countable(new ArrayIterator(['foo', 'bar', 'baz']))); // bool(true)
var_dump(is_countable(new ArrayIterator())); // bool(true)
var_dump(is_countable(new stdClass())); // bool(false)
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>is_array</function></member>
<member><function>is_object</function></member>
<member><function>is_iterable</function></member>
<member><function>is_bool</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
</code>
</pre>
<p><a target="_blank" href="http://php.net/manual/ru/function.is-countable.php">is_countable(), с PHP 7.3</a></p>
</section>
<section class="slide" id="broken-build-slide">
<h2>Бывает документация ломается 😧</h2>
<img class="media" src="pictures/pain.png" alt="">
<pre class="broken-build-detailed-slide next">
The ru build of the PHP Manual is broken, so it does not validate or build. Please fix it! ;)
Attached is the full log
Love, The docs.php.net server
…
Eyh man. No worries. Happ shittens. Try again after fixing the errors above.
=============> Something happenend when snapshotting ru
Failed completely
=============> Please have a look!
</pre>
<!-- <a target="_blank" href="http://news.php.net/php.doc.ru/start/6639">php.doc.ru</a> -->
</section>
<section class="slide">
<h2>А бывает и подобное 😟</h2>
<h3>Пример из французского перевода</h3>
<img class="media media-no-mh" src="pictures/pain-1.png" alt="">
<img class="fry" src="pictures/fry.png" alt="">
</section>
<section class="slide" id="contributors-slide">
<h2>Поблагодарим активных участников!</h2>
<ul class="no-bullets contributors-list">
<li>Алексей Шеин</li>
<li>Андрей Безруков</li>
<li>Максим Чабан</li>
<li>Александр Москалёв</li>
<li>Борис Клименко</li>
<li>Дмитрий Винярчук</li>
<li>Борис Флейтлих</li>
<li>Алексей Егоров</li>
<li>Юрий Бабиков</li>
<li>Михаил Баранов</li>
<li>Андрей Громов</li>
</ul>
<p>И многие другие...</p>
<img src="pictures/gatsby.jpg" class="cover cover-full" alt="">
</section>
<section class="slide">
<h2 class="shout shrink">Но среди них можешь быть <br> и ты!</h2>
</section>
<section class="slide">
<h2>Быстрый старт</h2>
<p>Проще показать непосредственно на примере...</p>
</section>
<section class="slide" id="typo-mem">
<img src="pictures/typo-mem.png" class="cover cover-full" alt="">
<div class="speech">
<span>Андрюха, у нас опечатка! Возможно, грамматическая ошибка. По коням! 🚨</span>
</div>
</section>
<section class="slide">
<h2>Ой! И что тут у нас?! Опечатка!</h2>
<h3>Немедленно исправляем...</h3>
<img src="pictures/typo.png" class="media" alt="">
</section>
<section class="slide">
<img src="pictures/edit-0.png" class="cover" alt="">
</section>
<section class="slide">
<img src="pictures/edit-1.png" class="cover" alt="">
</section>
<section class="slide">
<img src="pictures/edit-2.png" class="cover" alt="">
</section>
<section class="slide">
<h2>Онлайн-редактор документации ✏️</h2>
➡️ <a target="_blank" href="https://edit.php.net/">edit.php.net</a>
<br><br>
<ul>
<li>Сделан на Ext JS в 2011 году, но работает хорошо до сих пор 💯</li>
<li value="+">Интуитивно-понятный, простой и удобный ✔️</li>
<li value="−">Как минус — не работает проверка правописания ❌</li>
</ul>
<img src="pictures/edit-2.png" class="cover cover-blurred" alt="">
</section>
<section class="slide">
<img src="pictures/edit-3.png" class="cover" alt="">
</section>
<section class="slide">
<img src="pictures/edit-4.png" class="cover" alt="">
</section>
<section class="slide">
<img src="pictures/edit-5.png" class="cover" alt="">
</section>
<section class="slide">
<img src="pictures/edit-6.png" class="cover" alt="">
</section>
<section class="slide">
<img src="pictures/edit-7.png" class="cover" alt="">
</section>
<section class="slide">
<h2>Полезные ссылки 🎓</h2>
<ul class="useful-resources">
<li><a target="_blank" href="http://doc.php.net/">PHP: Documentation Tools</a></li>
<li><a target="_blank" href="http://news.php.net/php.doc.ru">Список рассылки русской документации</a></li>
<li><a target="_blank" href="http://svn.php.net/viewvc/phpdoc/ru/trunk/translation_standards.xml?view=markup">Соглашения по переводу терминов</a></li>
<li><a target="_blank" href="https://habr.com/post/125348/">«Команде переводчиков документации PHP требуется помощь» (Алексей Шеин)</a></li>
<li><a target="_blank" href="https://habr.com/post/125341/">«Новый инструмент перевода документации PHP: edit.php.net» (Александр Москалёв)</a></li>
<li><a target="_blank" href="https://habr.com/post/353490/">«И снова о переводе документации PHP» (Андрей Громов)</a></li>
<li class="next"><a style="color: inherit" href="https://github.com/php-ru/php-doc-ru">⭐ Git-репозиторий русской документации PHP ⭐</a></li>
<!-- <li><a target="_blank" href=""></a></li>
<li><a target="_blank" href=""></a></li> -->
</ul>
</section>
<section class="slide">
<h2>Давайте улучшим наши позиции! 🆘</h2>
<p>Круче русской локализации только японцы, испанцы и французы.</p>
<img class="media" src="pictures/common-state.png" alt="">
</section>
<section class="slide" id="hype">
<img src="pictures/hype.jpg" class="cover" alt="">
</section>
<section class="slide" id="hacktoberfest">
<div class="note-1">На правах <strike>рекламы</strike> опенсора. Количество товаров ограничено. Является публичной офертой. Перед применением ознакомиться с инструкцией.</div>
<img src="pictures/hacktoberfest.png" class="cover" alt="">
<ul>
<li>Зарегистрируйся на <a href="https://hacktoberfest.digitalocean.com/sign_up/register">сайте Hacktoberfest</a>, используя свой GitHub-аккаунт</li>
<li>Сделай 5 пулреквестов до 31 октября (поторопись, осталось 18 дней!)</li>
<li>???</li>
<li>Получи свою футболку! 😍</li>
</ul>
<div class="note-2">Имеются противопоказания, может привести к потере интереса к основной работе, проблемам с личной жизнью, резкому повышению ЧСВ, но это не точно 😁</div>
</section>
<section class="slide" id="child">
<img src="pictures/child.png" class="cover cover-full" alt="">
<div class="note-1">
Пожалуйста
</div>
<div class="note-2">
прими участие в опенсорсе
</div>
</section>
<section class="slide">
<h2>Спасибо за внимание! 🙏</h2>
<h4>Для вас занудствовал Алексей П<u>ы</u>льц<u>ы</u>н ✌️</h4>
<ul class="contacts-list no-bullets">
<li>
<span class="icon-envelope"></span>
<a href="mailto:lex@php.net">lex@php.net</a>
</li>
<li>
<span class="icon-telegram"></span>
<a target="_blank" href="https://web.telegram.org/#/im?p=@lexrulezzz">lexrulezzz</a>
</li>
<li>
<span class="icon-github"></span>
<a target="_blank" href="https://github.com/lex111"">lex111</a>
</li>
<li>
<span class="icon-medium"></span>
<a target="_blank" href="https://medium.com/@lex111">lex111</a>
</li>
</ul>
<img src="pictures/qr.png" alt="" class="qr">
<span class="link-more">
<a target="_blank" href="http://lex111.ru/phpdoc-inside-slides/" target="_blank">Ссылка на презентацию</a>
</span>
</section>
<footer class="badge">
<a target="_blank" href="https://github.com/lex111/phpdoc-inside-slides/">Fork me on GitHub</a>
</footer>
<div class="progress"></div>
<script src="shower/shower.min.js"></script>
<script src="vendor/highlight.js/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
</html>