Снегопат

Коллеги.

В этой ветке я хочу обсудить создаваемую мной документацию по объектной модели снегопата - SnegAPI.
Пока она доступна в таком виде.

Всю описать ее за один раз не могу, выкладываю по мере набора.
Пока всю не закончу, больше ничего делать не буду, надо закрыть уже этот вопрос.

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

Пока получается просто некий справочник, и чтобы понять, как и что можно сделать - нужно проштудировать все.
Но это базис, костяк. Набрав его один раз, можно будет в дальнейшем преобразовывать его в другие, более удобные формы.

Благодарю за внимание и сотрудничество.

1. В описании синтаксиса MessageBox небольшая опечатка:


Вчера читал доку (тобой проделан титанический труд!) и видел еще какие-то непонятки/опечатки. Сейчас не могу их найти

P.S.Что-то в форума тэг [highlight=]Подсветки[/highlight] не работает

А это все еще реализовать надо было

Саш. Я пока тоже первую вычитку сделал, для предложений по коректуре и опечатках буду делать вторую.

У меня больше оффтопик - я себе смутно представляю тот труд который надо было потратить на все это дело, но также знаю сколько надо было труда потратить чтобы домашних убедить что эта работа не впустую.

P.S. Пошел еще раз читать.

Ну да. После двух лет моего сидения по ночам, терпение у жены практически лопнуло. Тогда и пришлось объявить предзаказ на еще не готовый релиз.
И я очень благодарен всем тем, кто тогда поверил в меня и купил "кота в мешке" заранее. Ты, Алексей, кстати был самым первым.
Без всех вас снегопата наверное бы не было. Так что для всех, кто приобрел снегопат до 11.11.11 - техподдержка бессрочная.

эх не успел.

Жень, договоримся
Скриптописателям - аналогично.

По итогам второй вычитки получилось следующее:

1. описание метода v8new - абзац начинающийся с "Как оказалось... " необходимо переработать я думаю примерно так



2. свойство profileRoot - не хватает по моему примера как с ним работать.

3. про globalContex - увидел слово "перебирает", я так понял в режиме Предприятие ? Отсюда сразу отдельный момент - насколько быстр такой перебор в режиме 1С Предприятие ? сразу хочется как то оптимизировать само 1С предприятие. Но это видимо вопрос не к API.

В итоге после второго прочтенья я опять больше задумываюсь о самой объектной модели и способах ее использовании, чем о неточностях или опечатках - поэтому пока видимо, стоит ограничиться следующими вещами:

1. я скопировал текст напрямую со страницы и вставил в Notepad++ - там у меня работает SpellChecker (так же как и на форуме, для проверки опечаток достаточно будет этого). Красных подчеркиваний много - поэтому я не думаю что стоит это писать на форуме: можно попробовать diff патчами на основе fossil - я так понимаю, что у тебя там markdown текст ?

2. стоит все таки наверное структурировать на дерево страниц, а не на одну страницу.

3. примеры использования в виде вставок кода можно видимо тоже вставлять через diff - кое что могу я накопипастить из своих экспериментов, кое-что остальные.

P.S. Кстати насчет поддержки - ты же помнишь что в начале я предлагал не платную версию, а некий способ donate. А получился этакий краудсорсинг (или как он там называется) - который я бы считал успешным, учитывая мои замеры по увеличению производительности. Есть же модель такая сейчас модная - когда группа людей собирает деньги на идею, без конечного продукта. А насчет домашних - у меня же такая же ситуация, поэтому я знаю насколько сложно объяснить, что я делаю сидя за компом по 14 часов в день и засыпая по ночам часиков так в 2-4 ночи.

Алексей, для проверки не надо копипастить со страницы. Исходники страницы в markdown лежат в репозитарии:
core\docs\help\snegapi.markdown
Просто fossil когда этот файл отдает на лету markdown парсит.

В процессе изучения объектной модели Снегопата скопипастила информацию о библиотеке типов Library SnegopatLib из просмотрщика структуры COM-объекта. Проставлены все перекрестные ссылки (вроде, ничего не забыла). Мне было удобно пользоваться этим файликом прямо из конфигуратора – открыв HTML-файл на вкладке «Просмотр». На всякий случай, выкладываю.