Talk:Ru/api/kernel: Difference between revisions
m (New page: Огромная статья. Может, лучше разбить на отдельные статьи?) |
m (fix links) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Огромная статья. Может, лучше разбить на отдельные статьи? | Огромная статья. Может, лучше разбить на отдельные статьи? | ||
Разбить API на 70 статей? Да, было бы здорово. Короткие темы логично было бы дополнять примерами кода и описаниями соответствующих оберток системных вызовов. | |||
В качестве примера: [[SysFn07/ru]]. Может, еще какой-нибудь шаблон для удобства добавить? --[[User:Art zh|Art zh]] 01:15, 27 March 2010 (EET) | |||
Хм, шаблон. Интересная идея. Можно попробовать сделать либо полный шаблон, навроде такого: | |||
---- | |||
'''Системная функция name''' - about | |||
==Параметры== | |||
* eax = eax | |||
==Возвращаемое значение== | |||
return | |||
==Замечания== | |||
notes | |||
---- | |||
Такой вот скрипт, проверяющий, что поле eax, например, не пустое: | |||
<nowiki> | |||
* {{#if: {{eax}} | |||
| eax = {{eax}} | |||
}} | |||
</nowiki> | |||
Тогда обращаться к шаблону надо будет примерно так: | |||
<nowiki> {{SysFn|name=7|eax=7 - номер функции|ebx=указатель на изображение в формате BBGGRRBBGGRR|ecx=[размер по оси x]*65536 + [размер по оси y]|edx = [координата по оси x]*65536 + [координата по оси y]|return=функция не возвращает значения|notes= Координаты изображения - это координаты верхнего левого угла изображения относительно окна.<br /> | |||
Размер изображения в байтах = ''3 * Xsize * Ysize''. <br /> | |||
Соответствующий системный вызов: '''??''' <br />}}</nowiki> | |||
Насколько рационально делать такой шаблон - не знаю. Ведь для каждой функции могут быть детали... | |||
Просто прийти к какому-нибудь стандарту по оформлению статей - как с приложениями определились более-менее. | |||
Мне кажется, что правильнее начинать статью не с дублирования её заголовка как подраздела, а сразу с пояснения сути функции. Вроде бы так принято в вики. | |||
Плюс... И/или добавить шаблон для отображения в нижней части страницы - как с приложениями. | |||
Если таковой востребован, могу наваять :)--[[User:SoUrcerer|SoUrcerer]] 08:52, 27 March 2010 (EET) | |||
Ах, да. Ещё нужно определиться с именами для шаблона... Если для полного шаблона - то предлагаю System_function, а для шаблона оглавления - Syscalls?--[[User:SoUrcerer|SoUrcerer]] 09:02, 27 March 2010 (EET) | |||
И ещё :) почему такой странный адрес? Ru/api/SysFn07 | |||
Не логичнее просто создавать статью c именем функции или её номером, а потом объединить всё в категории? Автопереключение языка не работает, английскую версию вики вряд ли кто-то возьмется править в ближайшее время...--[[User:SoUrcerer|SoUrcerer]] 09:09, 27 March 2010 (EET) | |||
---- | |||
Разбить исходную статью на 70 частей не так сложно и вручную, особых скриптов не требуется. | |||
Я имел в виду шаблон для удобства ''навигации'' (в нижней части статьи) как сейчас сделано у приложений, а вовсе не для удобства ''редактирования''. В шаблоне можно будет сгруппировать функции по темам (графические, хардверные, управление задачами и т.п.). | |||
Насчет странного адреса - действительно, имхо любой другой был бы лучше :) . Я потому и остановился на одной страничке - как представил на что будет похож список категории! Просто, помнится, кто-то пару месяцев назад настоятельно рекомендовал структурировать адреса статей по языку и категории...--[[User:Art zh|Art zh]] 11:41, 27 March 2010 (EET) | |||
---- | |||
Окей, категория SysCalls есть. Можно создать в ней подкатегории функций, и тогда можно будет указывать сразу две категории - для удобства поиска статьи в категориях. Я думаю, что структурировать адреса статей по языку совсем не обязательно, лучше распихивать их по категориям одного языка - так правильнее ИМХО--[[User:SoUrcerer|SoUrcerer]] 21:04, 27 March 2010 (EET) | |||
<nowiki>{{System_functions}} </nowiki> - новый навигационный шаблон для системных функций. Подфункции не расписаны, потому что и такой вариант занимает не так уж мало места. Думаю, будет удобным такой вариант... | |||
В основном шаблоне навигации будет что-то вроде: | |||
[[SysFn18|18 - системные службы]] <code>([[Template:SysFn18Sub|есть подфункции]])</code> | |||
Вторая ссылка будет вести на шаблон навигации подфункций для функции 18. | |||
Либо же можно расписать подфункции в основном шаблоне. | |||
Ещё вопрос, который может возникнуть. На странице подфункции отображать только шаблон навигации по сосденим подфункциям данной функции - или же оба шаблона? | |||
Нужно все же наконец прикрутить к вики коллапсирующие таблицы. --[[User:SoUrcerer|SoUrcerer]] 21:54, 27 March 2010 (EET) | |||
---- | |||
По-моему, первые 10 функций у нас с тобой классно получились. | |||
Пока что буду продолжать в том же духе (когда время будет), когда дойдем до сложных/составных функций - посмотрим, как лучше. ИМХО шаблон по подфункциям - это лишнее. Лучше оставить подфункции в заголовках (как сейчас)--[[User:Art zh|Art zh]] 15:18, 28 March 2010 (EEST) | |||
Отлично :) | |||
По крайней мере на русском языке на вики будет нормальный список системных вызовов. | |||
Было бы наверное очень полезно заняться разбором функций библиотек... Жалко, что они довольно плохо документированы авторами большей частью :(--[[User:SoUrcerer|SoUrcerer]] 21:38, 28 March 2010 (EEST) | |||
Latest revision as of 06:29, 4 April 2010
Огромная статья. Может, лучше разбить на отдельные статьи?
Разбить API на 70 статей? Да, было бы здорово. Короткие темы логично было бы дополнять примерами кода и описаниями соответствующих оберток системных вызовов.
В качестве примера: SysFn07/ru. Может, еще какой-нибудь шаблон для удобства добавить? --Art zh 01:15, 27 March 2010 (EET)
Хм, шаблон. Интересная идея. Можно попробовать сделать либо полный шаблон, навроде такого:
Системная функция name - about
==Параметры== * eax = eax
==Возвращаемое значение== return
==Замечания== notes
Такой вот скрипт, проверяющий, что поле eax, например, не пустое:
* {{#if: {{eax}} | eax = {{eax}} }}
Тогда обращаться к шаблону надо будет примерно так:
{{SysFn|name=7|eax=7 - номер функции|ebx=указатель на изображение в формате BBGGRRBBGGRR|ecx=[размер по оси x]*65536 + [размер по оси y]|edx = [координата по оси x]*65536 + [координата по оси y]|return=функция не возвращает значения|notes= Координаты изображения - это координаты верхнего левого угла изображения относительно окна.<br /> Размер изображения в байтах = ''3 * Xsize * Ysize''. <br /> Соответствующий системный вызов: '''??''' <br />}}
Насколько рационально делать такой шаблон - не знаю. Ведь для каждой функции могут быть детали... Просто прийти к какому-нибудь стандарту по оформлению статей - как с приложениями определились более-менее.
Мне кажется, что правильнее начинать статью не с дублирования её заголовка как подраздела, а сразу с пояснения сути функции. Вроде бы так принято в вики.
Плюс... И/или добавить шаблон для отображения в нижней части страницы - как с приложениями. Если таковой востребован, могу наваять :)--SoUrcerer 08:52, 27 March 2010 (EET)
Ах, да. Ещё нужно определиться с именами для шаблона... Если для полного шаблона - то предлагаю System_function, а для шаблона оглавления - Syscalls?--SoUrcerer 09:02, 27 March 2010 (EET)
И ещё :) почему такой странный адрес? Ru/api/SysFn07
Не логичнее просто создавать статью c именем функции или её номером, а потом объединить всё в категории? Автопереключение языка не работает, английскую версию вики вряд ли кто-то возьмется править в ближайшее время...--SoUrcerer 09:09, 27 March 2010 (EET)
Разбить исходную статью на 70 частей не так сложно и вручную, особых скриптов не требуется.
Я имел в виду шаблон для удобства навигации (в нижней части статьи) как сейчас сделано у приложений, а вовсе не для удобства редактирования. В шаблоне можно будет сгруппировать функции по темам (графические, хардверные, управление задачами и т.п.).
Насчет странного адреса - действительно, имхо любой другой был бы лучше :) . Я потому и остановился на одной страничке - как представил на что будет похож список категории! Просто, помнится, кто-то пару месяцев назад настоятельно рекомендовал структурировать адреса статей по языку и категории...--Art zh 11:41, 27 March 2010 (EET)
Окей, категория SysCalls есть. Можно создать в ней подкатегории функций, и тогда можно будет указывать сразу две категории - для удобства поиска статьи в категориях. Я думаю, что структурировать адреса статей по языку совсем не обязательно, лучше распихивать их по категориям одного языка - так правильнее ИМХО--SoUrcerer 21:04, 27 March 2010 (EET)
{{System_functions}} - новый навигационный шаблон для системных функций. Подфункции не расписаны, потому что и такой вариант занимает не так уж мало места. Думаю, будет удобным такой вариант...
В основном шаблоне навигации будет что-то вроде:
18 - системные службы (есть подфункции)
Вторая ссылка будет вести на шаблон навигации подфункций для функции 18.
Либо же можно расписать подфункции в основном шаблоне.
Ещё вопрос, который может возникнуть. На странице подфункции отображать только шаблон навигации по сосденим подфункциям данной функции - или же оба шаблона?
Нужно все же наконец прикрутить к вики коллапсирующие таблицы. --SoUrcerer 21:54, 27 March 2010 (EET)
По-моему, первые 10 функций у нас с тобой классно получились.
Пока что буду продолжать в том же духе (когда время будет), когда дойдем до сложных/составных функций - посмотрим, как лучше. ИМХО шаблон по подфункциям - это лишнее. Лучше оставить подфункции в заголовках (как сейчас)--Art zh 15:18, 28 March 2010 (EEST)
Отлично :) По крайней мере на русском языке на вики будет нормальный список системных вызовов. Было бы наверное очень полезно заняться разбором функций библиотек... Жалко, что они довольно плохо документированы авторами большей частью :(--SoUrcerer 21:38, 28 March 2010 (EEST)