CoolProxy Help changers

 
Манифест :)
==========

 Как известно (заинтересованным людям), контекстный help CoolProxy находится в папке: "..\CoolProxy2\images\" и представляет собой набор html - страничек. Каждая из этих страничек соответствует своему разделу настроек. Такая реализация, с технической точки зрения спорна, но зато, открывает возможность сообществу пользователей CP совместными усилиями быстро и (я надеюсь) качественно поправить ситуацию с описанием настроек CP, примерами, советами, а так же снабдить встроенный help необходимым минимумом кратких дополнительных статей.

Это и является целью данного проекта.

PeterTomsky, 2006.06.29


[2]-[2006/07/11]
       Теперь буду комментировать я (Станислав, хотя, пожалуй, мне комфортнее представляться STaN'ом, не хочу лишнего официоза)
     В этом архиве вашему вниманию представляется вторая стадия обновления/дополнения справки к CoolProxy. В основном изменения претерпели структура сортировки и оформление текста + разумеется добавлены новые описания параметров.
     Данный архив содержит папки, отражающие структуру конфигурационного файла СР - каждому разделу своя папка. Т.к. я 90% времени за компьютером провожу, работая в Total Commander'е, мне удобнее оставлять комментарии в виде файлов descript.ion, и в них сейчас содержатся пометки о готовности разделов: при наведении мыши на папку/файл видим подсказку - для завершённого пункта "+", для не начатого/не законченного - "-" (или отсутствие), для находящегося в процессе работы/имеющего замечания - "~". Просмотреть комментарии к папкам также можно просто открыв файл описания текст.редактором.
     Все файлы явно переведены в Windows1251 кодировку с добавлением заголовка; в папке с графикой, используемой СР есть картинка fon.gif, которая, как ни странно, не использовалась. Я решил, что будет эстетичнее использовать её по назначению и добавил соответствующую директиву во все файлы.
     Далее. Уже на этом этапе справка смотрится гораздо приятнее, и я выкладываю параллельную версию - без сортировки файлов по разделам, - архив можно распаковать в соответствующую папку СР и наблюдать изменения.
Версия с сортировкой по разделам сохраняется для работы остальных заинтересованных людей (надеюсь, такие есть): т.е. если есть желание присоединиться к работе - скачиваем архив cp_help_update_file*.zip, распаковываем и выбираем папку для обработки. Если хочется лишь обновить справку в СР, то скачиваем архив cp_help_preview*.zip, распаковываем в папку \images\ и перезапускаем клиент СР.
     Обращаю ваше внимание на то, что приветствуется проверка орфографии, стилистики, корректности описания в файлах, сделанных другими людьми - взгляд со стороны будет совсем не лишним (я часто сам допускаю опечатки, за которые потом неудобно, но они банально проскакивают незамеченными, когда пишешь быстро)
     Ещё: пока я не сделал этого, но, думаю, будет весьма кстати сделать более-менее подробное описание разделов в файлах __*.html(оглавление, отображающееся, когда фокус не на параметре, а на папке/ветви) - к размышлению на следующие обновления и не только мне.
 
*заметка: если у кого для Iexplore.exe вообще запрещён доступ к сети (как было у меня, - по соображениям безопасности) - придётся разрешить, клиент СР пользуется движком ИЕ для отображения html и при блокировании ИЕ фаерволом справка отображаться не будет.
STaN

 
Что находится в архиве:
====================

v1

В этом архиве находятся, почти полностью (как мне кажется), оформленные 4е раздела help'a CP: 'portmap', 'sheduler', 'socks5' и 'web'.

'absent images files' - в этой папке содержатся файлы - "заглушки". Это файлы которых НЕТ в папке "\images" после установки CoolProxy 2.1 (b1107). Как следствие, при "хождении" по дереву настроек, и остановке на пунктах, для которых отсутствуют help-файлы, через некоторое время CP "вылетает" (cообщение: "Error in program" + "dump created") , зачастую обнуляя файл 'CoolProxy.ini'.

'old' - в этой папке находятся мои "первые эксперименты", появившиеся после того, как я заинтересовался возможностью изменения help'a CP. По мере оформления и написания help'a эта папка исчезнет. Все изменённые файлы не свалены в кучу, а СПЕЦИАЛЬНО разделены по своим папкам-разделам, что облегчает ориентацию в них и позволит в дальнейшем разделить работу между желающими. Предлагаю и в дальнейшем придерживаться такого подхода.

 
v2
      Архив содержит папки "Lists"(списки), "Main"(осн настройки), "Users"(учётные записи пользователей СР), "Var"(не отнесённое к другим разделам), "_EmptyFiles"(шаблоны), "_Images"(используемая графика - фон, например), "__PeterTomsky_"(файлы из версии 1, скопированы согласно новой структуры)
     Совсем пустых разделов нет, но следует обратить внимание на эти:
Ftp  Http-proxy  Ipstat  Log  Mime  Path  Pop  Pop3  Port  Proxyconnection  Ras  Scheduler  Smtp
В них либо присутствуют заглушки, которые надо бы наполнить текстом (у меня до них руки пока не доходят), либо неясные мне моменты (в частности - про домены почты)
     Тем не менее все разделы приветствуется проверить на корректность и орфографию.
 
В файлах (мной) принята следующая цветовая кодировка:

тёмно красный (коричневый) - для выделения важных моментов;
тёмно зелёный - названия разделов CP в ini - файле, протоколы, программы, фирмы
тёмно синий - адреса, пути, разделы настроек в CP.
Bold - заголовки, названия контор, важные элементы и т.д.
курсив - (редко) также для выделения, когда Bold не подходит.

Тут конечно нужен компромисс, между размером и наглядностью. Но "чёрные" файлы (имхо) смотрятся постно. В общем смотрите сами! Пишите своё мнение на форум CoolProxy. "Ключи" от этой странички у Станислава (см. форум)

 
Как пользоваться
================
1. скачать архив;
2. проверить его антивирусом!; // совет для параноиков, имхо - у кого рука поднимется
подложить сюда жучка? Для себя же делаем...
3. сделать BackUp папки images, сохранить его "в сторонке";
4. распаковать архив, и из каждой папки, по очереди скопировать
  файлы в images. Начинать, желательно, с папки  "..\absent images files".
  // применительно к cp_help_preview*.zip - просто распаковать
5. перезапустить CoolProxy.
 
 
Дата Размер (byte) Файл
2006.06.29 45903 cp_help_update_file_1.0.zip
2006.07.11 277 317 cp_help_update_file_2.0.zip
2006.07.11 213 255 cp_help_preview_v1.zip
   
 
2006   Cool Proxy Homepage    Cool Proxy forum
 
Hosted by uCoz