search

rheostat2718 / conemu-maximus5

Automatically exported from code.google.com/p/conemu-maximus5
7 stars 1 forks source link

Helping with documentation #609

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
The StackOverflow ad mentions that help with documentation is needed, but I 
can't find specific plans or instructions anywhere. It would help if there was 
a project plan / to-do list / "documentation" category in issues. The project 
wiki is also not editable to outsiders.

I could help with Russian/English translation and improving wording/grammar 
where appropriate.

Original issue reported on code.google.com by thecybershadow on 21 Jun 2012 at 8:24

GoogleCodeExporter commented 9 years ago 
Project wiki (english) may be edited by the people, who has special privilege. 
I can grant it to persons interested.

Another way to improve wiki (available to any user) is writing comments to wiki 
pages.

Files (screenshoots hosted on this project) and russian wiki may be changed via 
svn only.

Original comment by ConEmu.Maximus5 on 21 Jun 2012 at 9:01

GoogleCodeExporter commented 9 years ago 
I just have grant you "Edit wiki" privilege. You may try it.

Some words about documention exists in RoadMap. Do you think, it must be more 
detailed plan?

1. improving wording/grammar, of course

2. Nearest pages, which must be translated/edited, I think, must be
http://code.google.com/p/conemu-maximus5/wiki/ConEmuFAQ
http://code.google.com/p/conemu-maximus5/wiki/AnsiEscapeCodes

3. And I think, each page of settings must have screenshot and description of 
options.

Any help will be appriciated :)

Original comment by ConEmu.Maximus5 on 21 Jun 2012 at 9:30

GoogleCodeExporter commented 9 years ago

Original comment by ConEmu.Maximus5 on 21 Jun 2012 at 9:42

GoogleCodeExporter commented 9 years ago 
Is it possible to obtain read-only access to the Russian parts of the wiki, or 
at least the source code of the Russian FAQ page? Translation is much easier 
when it can be done "in place".

Original comment by thecybershadow on 21 Jun 2012 at 2:42

GoogleCodeExporter commented 9 years ago 
Never mind, found the source in SVN:
http://code.google.com/p/conemu-maximus5/source/browse/wiki/ru/ConEmuFAQ.wiki

Original comment by thecybershadow on 21 Jun 2012 at 2:49

GoogleCodeExporter commented 9 years ago 
Непонятное место: 

> Создать файл можно после загрузки !ConEmu, в 
этом случае в XML можно сохранить настройки, 
загруженные из реестра.

"Загрузка" в каком смысле? Кто будет 
сохранять в XML настройки из реестра (юзер 
или !ConEmu)?

Original comment by thecybershadow on 23 Jun 2012 at 12:12

GoogleCodeExporter commented 9 years ago 
"Загрузка" - в смысле запуск. Шаги

1. запустить ConEmu (без xml-файла), настройки 
загружаются из реестра
2. создать пустой ConEmu.xml (рядом с ConEmu.exe или 
ConEmuC.exe)
3. Открыть окно Settings (в заголовке должен 
появиться суффикс [xml]) и нажать кнопку Save 
settings

Original comment by ConEmu.Maximus5 on 23 Jun 2012 at 12:23

GoogleCodeExporter commented 9 years ago 
Если считаешь, что и русский faq подправить 
надо - давай вариант

Original comment by ConEmu.Maximus5 on 23 Jun 2012 at 12:24

GoogleCodeExporter commented 9 years ago 
"Создать файл можно после запуска !ConEmu, что 
позволяет скопировать настройки 
загруженные из реестра в XML-файл."

Original comment by thecybershadow on 23 Jun 2012 at 12:26

GoogleCodeExporter commented 9 years ago 
наверное все-таки так

Создать файл можно после запуска !ConEmu, что 
позволяет сохранить загруженные из 
реестра настройки в XML-файл.

Original comment by ConEmu.Maximus5 on 23 Jun 2012 at 12:32

GoogleCodeExporter commented 9 years ago 
Можно. "Скопировать" яснее передает 
намерение (ответ на вопрос "зачем/кому это 
нужно") ИМО

Original comment by thecybershadow on 23 Jun 2012 at 12:33

GoogleCodeExporter commented 9 years ago 
Только непонятно "как" это можно сделать (в 
смысле скопировать). Написать про "Открыть 
Settings, нажать кнопку Save"?

Original comment by ConEmu.Maximus5 on 23 Jun 2012 at 12:39

GoogleCodeExporter commented 9 years ago 
Думаю, новая формулировка достаточно ясна. 
Если возникнет вопрос, можно добавить 
пункт FAQ (не зря целая секция про 
портабильность?)

Original comment by thecybershadow on 23 Jun 2012 at 12:41

GoogleCodeExporter commented 9 years ago 
Еще в очередь на вычитку и перевод
http://code.google.com/p/conemu-maximus5/wiki/Settings?wl=en

Буду наверное потихоньку, как позволит 
время, которое все уходит на 
программирование, описывать вкладки 
диалога настроек... И вот подумалось, там 
дофига будет... Может разнести по разделам? 
Каждая вкладка в отдельном wiki.

PS. Для удобства работы с тикетами я 
ссылочку сделал "Documentation issues" на вкладке 
"Issues". Как считаешь, если чего нового на 
перевод нужно будет - создавать новый Issue, 
или в этот постить?

Original comment by ConEmu.Maximus5 on 24 Jun 2012 at 3:56

GoogleCodeExporter commented 9 years ago 
> Может разнести по разделам? Каждая 
вкладка в отдельном wiki.

Думаю идеальное решение было бы либо CHM, 
либо что-то которое позволяет строить CHM и 
Wiki из единого текста. CHM бы позволило 
сделать хелп-систему аля point-and-click (либо 
ссылка в всплывающих подсказках, либо по 
стандартной кнопке ? в заголовке диалога). В 
принципе, думаю не трудно будет построить 
что-то что берет HTML прямо с code.google.com и 
собирает из него CHM. У меня с этим опыт есть 
(thecybershadow.net/d/docs).

> PS. Для удобства работы с тикетами я 
ссылочку сделал "Documentation issues" на вкладке 
"Issues". Как считаешь, если чего нового на 
перевод нужно будет - создавать новый Issue, 
или в этот постить?

Думаю проще новые тикеты делать, чтобы было 
сразу ясно что уже сделано, а что уже нет. 
Так людям которые "не в курсе" но хотят 
помочь легче будет найти чем заняться.

Original comment by thecybershadow on 24 Jun 2012 at 4:02

GoogleCodeExporter commented 9 years ago 
Не знал, куда лучше закинуть, пишу здесь.
1. Имхо, опцию "End selection on typing" лучше 
переименовать в "Reset selection on typing" или в "Reset 
selection on input". Я бы выбрал второй вариант.
2. "3s" в подсказках озадачивает - не всегда 
сразу догадаешься, что это "3d state". Нужно 
что-то другое придумать
3. Для этой же опции 3s можно преобразовать в 
дополнительный чекбокс. Т.е. выделяешь 
опцию, становится доступным чекбокс "any key" 
и, скажем, "copy to clipboard"

И последнее - очень не хватает инструкции 
для людей, которые бы хотели предложить 
пару исправлений в переводах, но просто не 
могут догадаться, как и куда это сделать. 
Для таких людей доступ на запись в вики не 
нужен, им проще написать пару предложений в 
Issues. Возможно, кроме Concept и Defect есть смысл 
сделать тип issue Translation.

Original comment by Merly...@gmail.com on 16 Jan 2013 at 2:24

GoogleCodeExporter commented 9 years ago 
1. "Reset" не подходит - оно может копирование 
выполнять, а не только сброс. Поменять "typing" 
на "input" наверное можно, мне без разницы.
2. можно и полностью писать. Длинно, вот и 
сокращал.
3. 3е состояние это для экономии места. В 
большинстве случаев его нагляднее 
радиокнопками заменять, но это будет 3-4 
контрола вместо одного. А диалог и так 
насыщен донельзя.

Тип создать можно. На счет "интрукции" - не 
уверен. Что там писать в той инструкции?? 
Если кто помочь хочет - масса вариантов для 
связи, выбирай любой.

Original comment by ConEmu.Maximus5 on 16 Jan 2013 at 3:37

GoogleCodeExporter commented 9 years ago 
Хотя... "input any key" как-то "не по-русски"? Не?

Original comment by ConEmu.Maximus5 on 16 Jan 2013 at 4:27

GoogleCodeExporter commented 9 years ago 
1. Reset selection - сброс выделения. Как нельзя 
подходит сюда. Вот "end" точно не подходит. "End 
selection" ближе скорее к "выделение закончено, 
больше ничего не будет выделяться, можно со 
спокойной душой набирать текст". Кроме 
своего опыта переводов, мне кажется, где-то 
я уже подобную опцию видел :)
И лучше даже не просто "input", а "user input".
2. Полностью писать не нужно, нужно как-то 
придумать коротко, но ясно.
3. Я понимаю, что в большинстве случаев 
выгоднее использовать радио с 3 пунктами. 
Но в данном случае, имхо, выгоднее сделать 
доп. опцию, т.к. там уже есть одна - any key. Т.е. 
логично сделать - вкл/выкл + опция1 + опция2. А 
на данный момент получается, что 
вкл/выкл/опция1 + опция2. Смысла совмещать 
первую опцию с вкл/выкл никакого.

По поводу инструкции. Честно говоря, 
сказать что писать в инструкцию не могу, 
т.к. не знаю, что действительно нужно 
переводить и где. Вот в этом и проблема. 
Возможно в багах нужно подробнее описывать 
задания.
Например, я не понимаю, что значит баг 616. 
Т.е. я вижу этот текст, но совсем не понимаю, 
что с ним делать. Там мешанина русского и 
английского и в варианте en, и в варианте ru. 
Что странно - если оригинал написан на 
одном из языков, логично предположить, что 
он будет полностью на этом языке.

Original comment by Merly...@gmail.com on 16 Jan 2013 at 4:33

GoogleCodeExporter commented 9 years ago 
> Хотя... "input any key" как-то "не по-русски"? Не?
Честно - не рассматривал как предложение в 
одну строчку. "Type any key" тоже слух режет.

Original comment by Merly...@gmail.com on 16 Jan 2013 at 4:52

GoogleCodeExporter commented 9 years ago 
Кстати, насколько я понимаю, опция "any key" 
позволяет снимать выделение при нажатии 
любой функциональной клавиши, не только 
клавиши с символом. В 130113 (не знаю, как 
раньше было) при отпускании shift'а (который 
был нажат для выделения), похоже, приходит 
keycode и выделение сбрасывается. Т.е. тут 
получается уже не "on user input", а просто 
автоматически сбрасывается выделение. 
Если так и планировалось, то опцию вообще 
можно (и нужно) назвать по-другому, т.к. юзер 
вроде бы ничего и не вводит :)

Original comment by Merly...@gmail.com on 16 Jan 2013 at 6:14

GoogleCodeExporter commented 9 years ago 
"Finish selection"? )
Хотя и "Reset" при наличии рядом опции 
наверное нормально будет.

На счет перевода.
Многие странички писались в течение 
длительного времени, по мере возможности, 
на языке на котором "подумалось", кое-что 
вообще копипастилось.
На счет 616-го - русский и английский файлы 
идентичны (за исключением одного абзаца). 
Так что там нужно делать перевод 
"двусторонний", ну типа привести файл к 
соответствующему языку.
Как всегда все упирается во время, лишнего 
ни у кого не наблюдается.
Тот же Whatsnew - стараюсь писать на английском, 
потому что переводить времени нет, даже 
обновить русскую версию странички перед 
выкладкой новой сборки... голова не всегда 
соображает как сказать по-русски то что на 
английском в 3 слова влезло.

Original comment by ConEmu.Maximus5 on 16 Jan 2013 at 7:47

GoogleCodeExporter commented 9 years ago 
Добавлена страничка
http://code.google.com/p/conemu-maximus5/wiki/ConEmuHelping
Если чего непонятно или есть чего туда 
добавить - пишите.

Добавлен шаблон для Issue "О документации и 
переводе", в самом конце странички
http://code.google.com/p/conemu-maximus5/wiki/Issues?tm=3

Original comment by ConEmu.Maximus5 on 16 Jan 2013 at 10:27

GoogleCodeExporter commented 9 years ago 
Hi, I would like to help improve some of the English documentation - please 
give me wiki edit rights if you would like me to do so.

Original comment by rogersil...@gmail.com on 5 Jun 2013 at 11:38

GoogleCodeExporter commented 9 years ago 
@ rogersillito
Done

Original comment by ConEmu.Maximus5 on 5 Jun 2013 at 11:57

GoogleCodeExporter commented 9 years ago 
* me too!

Original comment by leon.zac...@gmail.com on 15 Oct 2013 at 12:59

GoogleCodeExporter commented 9 years ago 
@ leon
Done

Original comment by ConEmu.Maximus5 on 15 Oct 2013 at 1:13

GoogleCodeExporter commented 9 years ago 
it didnt work sorry

On 15/10/2013, conemu-maximus5@googlecode.com
<conemu-maximus5@googlecode.com> wrote:

Original comment by leon.zac...@gmail.com on 17 Oct 2013 at 11:45

GoogleCodeExporter commented 9 years ago 
What are you trying to do? Show screenshot.

Original comment by ConEmu.Maximus5 on 17 Oct 2013 at 12:38