Подходит к концу работа по смене шаблона для документаций. Шаблон делал молодой, неопытный верстальщик, делал долго, но, молодец, справился. Дока, как нам кажется стала выглядеть современнее. Есть функция сворачивания меню, что позволяет без проблем читать её на мобильных устройствах. Пока шаблон применён только к D7, но скоро появится и на пользовательской и на доке по API. [spoiler]
Документация API Сделано
Добавлено описание класса CBlogImage и его методов
Скажу честно, у меня новый шаблон для документации вызывает отторжение. На любых устройствах и с любым разрешением экрана читать доки стало неудобно. Во первых всё стало огромным, размеры шрифтов вообще не ясно по какой логике подобраны (почему в хлебных крошках 18px, а основной текст 14px? И зачем в заголовках таблиц 16px?). Отступы мало того, что большие (зачем они такие в таблицах и коде, например?), ещё и разные (внутренние отступы таблиц - 10px, кода - 20px, цитат 10px 20px; а внешние вообще только у цитат в 20px). И эту несогласованность стилей можно продолжать бесконечно, слишком всё сырое, огромное и неаккуратное. Конечно, это моё личное мнение, и может я чего-то не понимаю, но старыми доками пользоваться удобнее на текущий момент
По поводу хлебных крошек согласен - они огромные 14 или хотя бы 16 шрифт уже намного приятнее По поводу таблица - добавьте border-collapse:collapse, уменьшите отступы до 7px как в ячейчак так и в заголовке таблицы Заголовки я бы выровнял по левому краю и убрал жирность. получилось бы вот так - http://joxi.ru/V2VKXQbixNVOBA Постраничка 16 выглядит тоже лучше - http://joxi.ru/D2PQZbztpv1E1A Делаем padding в меню 3 сверху 5 снизу против 5 и 7 и получаем более компактное меню - http://joxi.ru/krDDEZzuEwL9xr Убираем в классе - div.reviews-reply-field-settings input - ширину и высоту и получаем более компактные инпуты(стандартыне) - ну или если хотели их стилизовать то надо довести до конца хотя бы можно сделать так как в jqueryStyler - http://joxi.ru/vAWZx6zS1GKzQ2
В целом меня напрягает только таблица и хлебные крошки.
Не стыдно хоть за дизайн нулевых. Первое впечатление от продукта для разработчика может складываться из дизайна и удобства обращения для разработчиков. Когда новичек видит документацию в стиле нулевых, по сравнению с модными доками на др. платформах, я думаю у него это вызовет чуство уныния и того что вендор не особо заботится об удобстве разработчиков)
В общем я за редизайны, документации в т.ч. Мелкие недочеты думаю скоро исправят.
Сегодня еще заметили что скрипт импорта наконец то тоже средизайнили. Может и админку на новые гриды переведут)
За XmlWriter отдельное спасибо! Правда есть одно "но", бросился проверять, создал в лаборатории битрикс демо сайт, обновился до 17.0.3 и протестил пример из документации, вылезла ошибка:
Fatal error: Call to undefined method Bitrix\Main\XmlWriter::getInstance() in /home/bitrix/www/bitrix/modules/main/admin/php_command_line.php(138) : eval()'d code on line 1
Собственно взглянув на исходники проблема решилась быстро, просто не нужно использовать getInstance(), а передавать массив параметров непосредственно в конструктор класса:
На дня, как я понимаю обновился шаблон для документации (https://dev.1c-bitrix.ru/api_help/) по моему даже сегодня, по крайней мере вчера был еще старый шаблон, работать стало не совсем удобно, а именно, где кнопка вперед ? Может быть, если просматривать одну страницу документации то нормально, но когда вы допустим хотите пройтись по секции, то вам приходиться использывать левую панель навигации, чтобы смотреть след функцию или метод. Вот пример http://joxi.ru/v29DnVZcVPLomG ,чтобы посмотреть метод "CopyFile" вам надо на него нажать, страница обновиться и чтобы посмотреть след. метод Вам придеться скролить левую панель в низ и т.д все время.
На старом шаблоне такое дело было, кнопка хоть и была не совсем в удобном месте, но была......... Внешне, все же можно и по контрастнее сделать, хотя бы так http://joxi.ru/Dr81OV8tx6dOm6
Мы обсуждали кнопки Следующая/Предыдущая, был такой вариант. За него высказалось очень мало людей. Публично - ваша просьба вообще первая. Если будут ещё аналогичные запросы - то добавим.
1. Левое меню сейчас неудобное. Сначала скролим меню, потом отдельно скролим и саму страницу. Как мне кажется, стоит рассмотреть вариант где js высчитывает высоту экрана и ставит фиксированное значение на id="DocGeneral". Не знаю можно ли эту проблему решить средствами CSS, но я бы поправил это в первую очередь.
2. Я бы просто добавил всё что написал Фролов Сергей
А где на форуме анонсы выходов апдейтов? случайно попала в эту блогоСферу...
Где подписаться подписаться на обновления документации в формате RSS/Atom ? Иметь возможность *держать руку на пульсе* и читать в формате удобном мне ( все уже настроено).
__________ *держать руку на пульсе* двояко звучит т.к. сей процесс с критически больными либо уходящими в *руки нового хозяина* ...
По поводу таблица - добавьте border-collapse:collapse, уменьшите отступы до 7px как в ячейчак так и в заголовке таблицы
Заголовки я бы выровнял по левому краю и убрал жирность.
получилось бы вот так -
Постраничка 16 выглядит тоже лучше -
Делаем padding в меню 3 сверху 5 снизу против 5 и 7 и получаем более компактное меню -
Убираем в классе - div.reviews-reply-field-settings input - ширину и высоту и получаем более компактные инпуты(стандартыне) - ну или если хотели их стилизовать то надо довести до конца хотя бы можно сделать так как в jqueryStyler -
В целом меня напрягает только таблица и хлебные крошки.
Не стыдно хоть за дизайн нулевых. Первое впечатление от продукта для разработчика может складываться из дизайна и удобства обращения для разработчиков. Когда новичек видит документацию в стиле нулевых, по сравнению с модными доками на др. платформах, я думаю у него это вызовет чуство уныния и того что вендор не особо заботится об удобстве разработчиков)
В общем я за редизайны, документации в т.ч. Мелкие недочеты думаю скоро исправят.
Сегодня еще заметили что скрипт импорта наконец то тоже средизайнили. Может и админку на новые гриды переведут)
лаконичность и скупость красок!!!
и конечно отсутствие ошибок...
p.s. за возможность легко и удобно создавать подобные структуры из коробки ещё раз спасибо!
На старом шаблоне такое дело было, кнопка хоть и была не совсем в удобном месте, но была......... Внешне, все же можно и по контрастнее сделать, хотя бы так
2. Я бы просто добавил всё что написал Фролов Сергей
А вообще в целом очень симпатично и свежо!
случайно попала в эту блогоСферу...
Где подписаться подписаться на обновления документации в формате RSS/Atom ?
Иметь возможность *держать руку на пульсе* и читать в формате удобном мне ( все уже настроено).
__________
*держать руку на пульсе*
двояко звучит т.к. сей процесс с критически больными либо уходящими в *руки нового хозяина* ...
масса признаков смены собственников Битрикс.
конкретно *обновление документации битрикс* последнее 2015 ...