devel.xml
|
|
Всем привет,
Рассказываю о последних изменениях в документации SPF_DEVEL - список часто используемых либ. Раньше было два текста в markdown для английской и русской версии, которые автоматически конвертировались на сервере в HTML. Это было неудобно потому что 1) приходилось много писать повторяющегося текста и оформления при добавлении каждой либы 2) сложно и неудобно синхронизировать две версии для двух языков. 3) в онлайн версии ссылки вели не туда куда надо (так как рассчитано было в первую очередь для локального просмотра в дистре) Решение проблем, уже в docs :) Один толстый devel.xml, который для каждой либы содержит только необходимую информацию - путь, слово, описание на обоих языках. HTML автоматически генерируется XSLT скриптом tools/xsl/devel.xsl (на сервере - каждый час в случае если были изменения). При вызове с параметром usage=local генерируется локальная документация, при usage=web ссылки ведут на http://forth.org.ru и добавляется SF logo. Параметр lang определяет язык который будет использоваться. Также этот xml будет служить списком либ для ~ygrek/doc/docbook/devel.docbook. Вообщем призываю всех следить за актуальностью этого списка, добавлять либы (я добавлял по принципу - что сам использовал/проверил, поэтому мог обойти некоторые либы вниманием :) -- wbr, ~ygrek ------------------------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Still grepping through log files to find problems? Stop. Now Search log events and configuration files using AJAX and a browser. Download your FREE copy of Splunk now >> http://get.splunk.com/ _______________________________________________ Spf-dev mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/spf-dev |
||||||||
attachment0 (196 bytes)
|
|
||||||||
|
|
||||||||
|
|
In reply to this post
by azekeprofit
Привет,
> 1. Предлагаю добавить или атрибут или тэг, в общем, некий знак > обозначающий "обёрточность". Для обёрток к XML, expat, zlib, bregexp, > sqlite, 7-zip. Возможно, стоит ставить ссылки на обёртываемые > библиотеки. Да, думаю это будет полезно, со ссылкой на где эту дллку можно взять. > 2. Сделать тэг <doc></doc> или ещё что-то подобное, для обозначения > тех редких случаев когда у нас есть некое или описание к библиотеке > (не которое в самом исходнике, вперемежку с кодом, а которое > нормальное) или аж документация. Пути туда давать через <path></path> > -- т. е. давать (принципиально) только то, что уже в дистре (оно же > -- на CVS). Как вариант -- сделать атрибут для тэга <path>, а в > выводимом html-исходнике помечать ссылку иконкой. > 3. Аналогичное предложение с рабочими, запускающими примерами кода > (опять же в тех случаях когда они отделены). > Для обоих последних случаев надо учитывать что примеров (описаний) > может быть несколько. Как их визуально показывать? - слишком много места займёт. ЗЫ Там в некоторых местах есть использование path внутри comment в перемешку с текстом (см. пункт WinLib например) - я не умею выдирать xslt'ом такие теги, а хотелось бы.. -- ~ygrek ------------------------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Still grepping through log files to find problems? Stop. Now Search log events and configuration files using AJAX and a browser. Download your FREE copy of Splunk now >> http://get.splunk.com/ _______________________________________________ Spf-dev mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/spf-dev |
||||||||
|
|
||||||||
|
|
Привет Юрий,
> >ЗЫ Там в некоторых местах есть использование path внутри comment в перемешку с текстом (см. пункт WinLib например) - я не умею выдирать xslt'ом такие теги, а хотелось бы.. > > > > > Покажи, что надо. Я попробую. Рувим показал как это делать, уже на cvs. -- ~ygrek ------------------------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Still grepping through log files to find problems? Stop. Now Search log events and configuration files using AJAX and a browser. Download your FREE copy of Splunk now >> http://get.splunk.com/ _______________________________________________ Spf-dev mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/spf-dev |
||||||||
|
|
In reply to this post
by Ruvim Pinka
Привет,
> Элемет link (есть и в XHTML 2.0) хорошо отвечает по всем пунктам. > Еще, предлагаю заменить word на key и path на src. Обобщенный пример: > > <lib> > <key>word</key> > <src>pathname</src> > <comment><ru> A </ru> <en> B </en></comment> > <link rel="wrap" href="uri to dll manual" > xml:lang="ru|en|enc">caption</link> > <link rel="manual" href="" xml:lang="ru|en|etc">caption</link> > <link rel="example" href="" >caption</link> > <link rel="example" href="" >example 2</link> > </lib> > > Опциональные атрибуты xml:lang, type="mime-type", charset="encoding", > title="short hint". разный? Будет два элемента link? Как сделать линку на "локальную" документацию (собственно у нас вся дока и примеры - локальные), т.е. чтобы обрабатывалось так как сейчас для <path>? Может ввести два типа ссылок - локальные и глобальные? Или атрбитом - <src target="local"> и <src target="global">? -- ~ygrek ------------------------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Still grepping through log files to find problems? Stop. Now Search log events and configuration files using AJAX and a browser. Download your FREE copy of Splunk now >> http://get.splunk.com/ _______________________________________________ Spf-dev mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/spf-dev |
||||||||
|
|
|
||||||||
|
|
In reply to this post
by ygrek-3
|
||||||||
|
|
|
||||||||
|
|
|
||||||||
|
|
|
||||||||
|
|
On Wed, 26 Sep 2007 11:50:27 +0400
"Ruvim Pinka" <[hidden email]> wrote: > On 9/26/07, azekeProfit <[hidden email]> wrote: > > > > > Тогда следует наложить ограничение, что эти имена не должны содержать > > > символов, запрещенных для имен файлов (типа '?', '*'). > > Необязательно. Можно заменять запрещённые символы на безопасные для имён > > файлов. > > да, действительно! Мне это не нравится. Лучше адресоваться как сейчас по имени файла. Можно ввести нумерацию для совпадающих имён.. 1. У разных ФС могут быть разные ограничения на имена. 2. Название файла лучше идентифицирует либу чем слово, вдобавок замангленное 3. Слова тоже могут совпадать :) > Да пусть папка алиасов даже и является полным дублем уже имеющейся > > информации в devel.xml, но она всё равно должна быть полезна -- по ней > > удобно "ходить" и "открывать новое". > > Согласен. Но, чтобы "ходить" — я мечтаю о веб-сервисе, который будет > отдавать исходники раскрашенными и с гиперссылками (хотя бы в местах INCLUDE > и т.п.). Аналогично + личная страничка для отдельных либ, с ссылками на автора/доку, с поиском по ключевым словам. Т.е. каталогизатор не ограниченный devel'ом, с возможностью удобного добавления. Чтобы был единый источник поиска либ/примеров. Мне вообще кажется что для такой цели лучше подошла бы система тегов, а не строгая иерархия. -- ------------------------------------------------------------------------- This SF.net email is sponsored by: Microsoft Defy all challenges. Microsoft(R) Visual Studio 2005. http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ _______________________________________________ Spf-dev mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/spf-dev |
||||||||
|
|
||||||||
| Free Embeddable Forum Powered by Nabble | Help |
