Abills Developer
Child pages
  • Поиск конфигурационных переменных с документации
Skip to end of metadata
Go to start of metadata

С 1.32.00.

   Config Vars Search
   Dev Tool for searching config variables in files

  PATH - config search path
    default: /usr/abills/
  BY_MODULES - split config into %module%.json, searching by PATH + /Abills/modules
    optional
  CREATE_DIFF - create diff_%date%.json from existing abills.json
    optional

  get_docs    - docs by whole confs from config_variables.sql, can take to 10 minutes
  no_docs     - variables which doesnt have descriptions, but possibly have pages
  no_page     - variables which doesnt have any pages
  CACHE       - path to .json generated by get_docs for no_docs AND no_page options

Принцип работы

Опция get_docs

config_vars_search.pl get_docs > config_docs.json


При опции get_docs, система производит поиск по каждой переменной с документации, которая находится в config_variables.sql
(Почему именно config_variables.sql? Поскольку там находятся вручную посортированные переменные, которые должны попадать в веб.)

Этот процес может длиться около 10 минут.
Пример вывода:

{
   "ACCEPT_RULES": [
      "Возможность включения страницы ознакомления и принятия правил провайдера. Если правила ещё не были приняты пользователем, при первом его заходе показываются правила. Система разрешает пользоваться личным кабинетом только после подтверждения правил.  Страница правил также работает для формы регистрации.  Шаблон отвечающий за данные правила...",
      "http://abills.net.ua/wiki/pages/viewpage.action?pageId=2523382"
   ],
   "ACCIDENT_WARNING": [
      "http://abills.net.ua/wiki/display/AB/Accident"
   ],
   "ACCT_DEBUG": []
}

Если система нашла упоминание и смогла спарсить описание (при правильно оформленной таблице) - соответственно прилагает описание и ссылку на описание.

Если система нашла упоминание и не смогла найти описание - прилагается только ссылка.

Если не найдено ничего - массив останется пустым.

Опция no_docs

Тот же принцип что и get_docs, только будут показываться ТОЛЬКО переменные у которых есть упоминания, но нет описания.
Ради экономии времени и ресурсов - существует опция CACHE, в которой вы указываете название вывод программы с get_docs

config_vars_search.pl no_docs CACHE=config_docs.json > config_no_docs.json

Опция no_page

Тот же принцип что и get_docs, только будут показываться ТОЛЬКО переменные у которых нет НИ упоминания, ни описания.
Ради экономии времени и ресурсов - существует опция CACHE, в которой вы указываете название вывод программы с get_docs

config_vars_search.pl no_docs CACHE=config_docs.json > config_no_page.json


  • No labels