jcshaw / namedfolders

Automatically exported from code.google.com/p/namedfolders
0 stars 0 forks source link

Актуализация справки #31

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago
С версии 244 плагин уже стал выходить в виде 
нормального пакета с справкой и 
документацией. это очень хорошо.

Я уже как то для себя правил русский хелп от 
NF. там не закрытые или сломанные ссылки на 
разделы, немного форматирования. 
Если в версии 244 в русской справке 
изменилась только информация от автора, то 
могу выслать свой вариант. если менялось 
что то большее, могу посмотреть то что есть 
и выслать исправления.

Навскидку, в @Contents поправить email автора, 
добавить '@'.
Хотя, только что просмотрел, вроде бы 
ссылки на подразделы уже все правильные.

Original issue reported on code.google.com by Joye.Ram...@gmail.com on 22 Dec 2010 at 9:09

GoogleCodeExporter commented 8 years ago
Я уже правил хелп местами. Собственно, для 
релиза не хватает именно правки хелпа (ну и 
если в 244 баги вылезут - поправлю). 

С правкой хелпа есть одна загвоздка. С 
давних времен справка к NF пишется как 
отдельный XML файл, который потом с помощью 
XSLT преобразований преобразуется в хелп для 
сайта www.rammus.ru и в справку NF. Так что все 
изменения нужно вносить именно в XML файл. 
Точнее XML-файла два: NamedFolders.Hlf.xml и 
NamedFoldersRus.Hlf.xml (английская и русская версии). 
Лежат они здесь:

http://code.google.com/p/namedfolders/source/browse/trunk/nf3x/help/

Кстати, я собираюсь на основе этих файлов 
генерить вики-страницы с документацией для 
данного сайта (хотя возможно сделаю 
наоборот - этот файл будет генерироваться 
из вики-страниц, подумаю).

Я могу дать тебе доступ на заливку 
изменений в исходники и объяснить как 
работать с xml-файлами. Тогда ты сможешь, 
если будет желание, вносить исправления в 
справку напрямую. Что думаешь? 

Если такой вариант не удобен, высылай 
исправленную версию справки (можно ее 
приаттачить прямо сюда), я посмотрю что 
исправлено и поправлю XML-файлы.

Original comment by dvpubl...@gmail.com on 22 Dec 2010 at 9:50

GoogleCodeExporter commented 8 years ago
я просмотрел бегло xml. вроде бы все 
относительно ясно и образно понятно.
нужно конечно описание и формат тегов 
где-то подсмотреть.

да, в таком направлении и нужно 
действовать. править hlf, а потом 
перекручивать все обратно как то не 
правильно.

сегодня попробую просто забрать себе это 
дело и собрать-посмотреть что получится.

единственное, я могу только править 
справку на предмет ошибок/форматирования, 
автор текстов из меня довольно слабоватый )

вечером отпишусь о результатах

Original comment by Joye.Ram...@gmail.com on 22 Dec 2010 at 10:05

GoogleCodeExporter commented 8 years ago
Хорошо. Для того, чтобы генирировались hlf 
файлы нужно установить:
1) msxml 4.0

http://www.microsoft.com/downloads/en/details.aspx?FamilyID=3144b72b-b4f2-46da-b
4b6-c5d7485f2b42

2) msxsl.exe 

http://www.microsoft.com/downloads/en/details.aspx?FamilyID=2fb55371-c94e-4373-b
0e9-db4816552e41&displaylang=en

Msxsl.exe нужно поместить в директорию с xml 
файлами NF. Справка генерируется запуском 
"!make.bat". Результаты складываются в 
поддиректорию lang.

Original comment by dvpubl...@gmail.com on 22 Dec 2010 at 10:13

GoogleCodeExporter commented 8 years ago
ну вот примерно так. особо не пинайте. я 
первый раз в жизни справку в фаре пытался 
оформить )
поправил <CONTACT_EMAIL_HELP> @ -> @@
поправил несколько сломанных переносом 
тегов
поправил форматирование абзацев под один 
лад

если это важно нужно выбрать правила как 
оформлять абзацы и прочее. я потом анг тоже 
подправлю под это дело.

из xslt знаю только принципы работы.
например не могу понять, почему шаблон external 
разворачивается не с указанной позиции 
если перед ним нету текста. можно увидеть 
тут:
NamedFoldersRus.Hlf.xml в строке 654 тег "  <external 
name="RUS/COPYRIGHT"/>"
но в результате получаю текст с самого 
начала строки.

Original comment by Joye.Ram...@gmail.com on 22 Dec 2010 at 12:33

Attachments:

GoogleCodeExporter commented 8 years ago
Спасибо. Я посмотрю, но не раньше завтра - 
завал по работе. Отпишу.

Original comment by dvpubl...@gmail.com on 22 Dec 2010 at 12:40

GoogleCodeExporter commented 8 years ago
дополнение, справка не вызывается в меню - 
результате команды "cd: soft". а там прилично 
горячих клавиш. можно показывать или 
раздел @HowUseComandLine или выделить то что там 
написано по запуску команд в отдельный 
раздел.

так же если вызвать справку с панелей NF 
лучше показывать раздел @HowUsePanel

Original comment by Joye.Ram...@gmail.com on 27 Dec 2010 at 10:19

GoogleCodeExporter commented 8 years ago
Справку на русском немножко подправил. В 
частности, ввел новый раздел справки 
StartApplications, который теперь вызывается при 
нажатии F1 в cd: soft.

Для панели раздел справки указать нельзя. 
Справка указывается для плагина. Поэтому 
при нажатии на панели клавиши F1 
показывается основной раздел справки .. и 
это правильно :)

Original comment by dvpubl...@gmail.com on 7 Jan 2011 at 2:55

GoogleCodeExporter commented 8 years ago
согласен. так будет нормально.

Original comment by Joye.Ram...@gmail.com on 7 Jan 2011 at 6:16

GoogleCodeExporter commented 8 years ago
в релизе, в разделе @HowUseComandLine файла 
namedfoldersrus.hlf неправильно указана ссылка на 
новый подраздел @StartApplications - не указано 
текстовое имя ссылки.
нужно примерно так: 
" См. раздел ~Запуск программ~@StartApplications@."

Original comment by Joye.Ram...@gmail.com on 3 Feb 2011 at 9:08

GoogleCodeExporter commented 8 years ago
Исправил, спасибо.

Original comment by dvpubl...@gmail.com on 3 Feb 2011 at 9:20