search

Maximus5 / conemu-old-issues

Old issues imported from googlecode. Project was moved to
https://conemu.github.io
6 stars 1 forks source link

Helping with documentation #609

Open Maximus5 opened 9 years ago

Maximus5 commented 9 years ago

Originally reported on Google Code with ID 609

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.

Reported by thecybershadow on 2012-06-21 08:24:23

Maximus5 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.

Reported by ConEmu.Maximus5 on 2012-06-21 09:01:24

Maximus5 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 :)

Reported by ConEmu.Maximus5 on 2012-06-21 09:30:21

Maximus5 commented 9 years ago

Reported by ConEmu.Maximus5 on 2012-06-21 09:42:54

Maximus5 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".

Reported by thecybershadow on 2012-06-21 14:42:36

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

Reported by thecybershadow on 2012-06-21 14:49:00

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

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

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

Reported by thecybershadow on 2012-06-23 12:12:47

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

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

Reported by ConEmu.Maximus5 on 2012-06-23 12:23:38

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

Reported by ConEmu.Maximus5 on 2012-06-23 12:24:40

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

Reported by thecybershadow on 2012-06-23 12:26:52

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

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

Reported by ConEmu.Maximus5 on 2012-06-23 12:32:12

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

Reported by thecybershadow on 2012-06-23 12:33:54

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

Reported by ConEmu.Maximus5 on 2012-06-23 12:39:16

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

Reported by thecybershadow on 2012-06-23 12:41:26

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

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

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

Reported by ConEmu.Maximus5 on 2012-06-24 15:56:47

Maximus5 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,
или в этот постить?

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

Reported by thecybershadow on 2012-06-24 16:02:10

Maximus5 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.

Reported by Merlyell on 2013-01-16 14:24:57

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

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

Reported by ConEmu.Maximus5 on 2013-01-16 15:37:47

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

Reported by ConEmu.Maximus5 on 2013-01-16 16:27:38

Maximus5 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. Что странно - если оригинал написан на одном из языков, логично предположить, что
он будет полностью на этом языке.

Reported by Merlyell on 2013-01-16 16:33:53

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

Reported by Merlyell on 2013-01-16 16:52:43

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

Reported by Merlyell on 2013-01-16 18:14:00

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

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

Reported by ConEmu.Maximus5 on 2013-01-16 19:47:23

Maximus5 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

Reported by ConEmu.Maximus5 on 2013-01-16 22:27:38

Maximus5 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.

Reported by rogersillito on 2013-06-05 11:38:47

Maximus5 commented 9 years ago 
@ rogersillito
Done

Reported by ConEmu.Maximus5 on 2013-06-05 11:57:13

Maximus5 commented 9 years ago 
* me too!

Reported by leon.zac.williams.1999 on 2013-10-15 12:59:05

Maximus5 commented 9 years ago 
@ leon
Done

Reported by ConEmu.Maximus5 on 2013-10-15 13:13:21

Maximus5 commented 9 years ago 
it didnt work sorry

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

Reported by leon.zac.williams.1999 on 2013-10-17 11:45:57

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

Reported by ConEmu.Maximus5 on 2013-10-17 12:38:23