hs.doc.hsdocs

Получение или установка значения, определяющего, отображается ли вывод веб-браузера Hammerspoon в тёмном режиме.

• value — необязательный булево значение, число или nil, определяющие, отображается ли веб-браузер документации в тёмном режиме.
  • если значение равно true, HTML-вывод всегда будет инвертирован
  • если значение равно false, HTML-вывод никогда не будет инвертирован
  • если значение равно nil, вывод будет инвертирован только тогда, когда тема OS X установлена в тёмный режим
  • если значение — число от 0 до 100, оно определяет коэффициент инверсии, где 0 означает отсутствие инверсии, 100 — полную инверсию, а 50 — нечитаемый результат, потому что передняя и задняя части одинаково скорректированы.

• текущее, возможно новое значение

• Инверсия применяется с помощью фильтра CSS, поэтому, хотя значения, отличные от 0 (false) и 100 (true), допускаются, результат обычно не тот, который ожидается.

• Изменения, внесенные с помощью этой функции, сохраняются с помощью hs.settings с меткой "_documentationServer.invertDocs" и сохранятся при перезагрузке или перезапуске Hammerspoon.

Получить или установить текущее сохранённое начальное расположение фрейма для браузера документации.

• frameTable - таблица фреймов, содержащая значения x, y, h и w, определяющие начальное положение браузера при запуске Hammerspoon.

• текущее, возможно новое, значение

• Если hs.doc.hsdocs.trackBrowserFrame имеет значение false или nil (по умолчанию), то вы можете использовать эту функцию для указания начального положения браузера документации.

• Если hs.doc.hsdocs.trackBrowserFrame имеет значение true, то любое значение, заданное этой функцией, будет перезаписано всякий раз, когда окно браузера перемещается или изменяет размер.

• Внесённые изменения с помощью этой функции сохраняются с hs.settings с меткой "_documentationServer.browserFrame" и сохраняются при перезагрузке или перезапуске Hammerspoon.

Получить или установить, использует ли hs.doc.hsdocs.help внешний браузер.

• value - необязательное логическое значение или строка, по умолчанию false, определяющее, будут ли запросы документации отображаться во внешнем браузере или во внутреннем, обрабатываемом hs.webview.

• текущее, возможно новое, значение

• Если это значение установлено в true, запросы справки, вызванные hs.doc.hsdocs.help, будут вызваны по умолчанию вашим системным обработчиком для http схемы.

• Если это значение установлено в строку, строка определяет идентификатор пакета приложения, который будет использоваться для обработки запроса URL для документации. Строка должна совпадать с одним из элементов, возвращаемых hs.urlevent.getAllHandlersForScheme("http").

• Это поведение срабатывает автоматически, независимо от этого параметра, если вы работаете с версией OS X до 10.10, так как hs.webview требует OS X 10.10 или новее.

• Изменения, внесённые с помощью этой функции, сохраняются с hs.settings с меткой "_documentationServer.forceExternalBrowser" и сохраняются при перезагрузке или перезапуске Hammerspoon.

Отобразить документацию для указанной функции Hammerspoon или содержание для документации Hammerspoon в встроенном мини-браузере.

• необязательная строка, определяющая модуль, функцию или метод Hammerspoon для отображения документации. Если вы опустите этот параметр, будет отображено содержание документации Hammerspoon.

• Нет

Получить или установить сетевой интерфейс, на котором будет предоставляться веб-сервер документации Hammerspoon.

• interface - необязательная строка или nil, определяющая сетевой интерфейс, на котором будет предоставляться веб-сервер документации Hammerspoon. Явное nil указывает, что веб-сервер должен слушать на всех активных интерфейсах машины. По умолчанию "localhost".

• текущее, возможно новое, значение

• См. hs.httpserver.setInterface для описания допустимых значений, которые могут быть указаны в качестве аргумента interface для этой функции.

• Изменение интерфейса может произойти только тогда, когда сервер документации не запущен. Если сервер активен во время вызова этой функции с аргументом, сервер будет временно остановлен, а затем перезапущен после изменения интерфейса.

• Изменения, внесённые с помощью этой функции, сохраняются с hs.settings с меткой "_documentationServer.interface" и сохраняются при перезагрузке или перезапуске Hammerspoon.

Получить или установить, отображается ли список сущностей модуля как столбец слева от рендерной страницы.

• value - необязательное логическое значение, определяющее, отображается ли список сущностей модуля в строке документации (false) или в боковой панели слева (true).

• текущее, возможно новое, значение

• Это экспериментальная функция, по умолчанию отключена. Она была вдохновлена скриптом пользователя, написанным krasnovpro. Оригинал можно найти по адресу https://openuserjs.org/scripts/krasnovpro/hammerspoon.org_Documentation/source.

• Изменения, внесённые с помощью этой функции, сохраняются с hs.settings с меткой "_documentationServer.entitiesInSidebar" и сохраняются при перезагрузке или перезапуске Hammerspoon.

Получить или установить HTTP порт сервера документации Hammerspoon.

• value - необязательное число, определяющее порт веб-сервера документации Hammerspoon

• текущее, возможно новое, значение

• Номер порта по умолчанию 12345.

• Изменения, внесённые с помощью этой функции, сохраняются с hs.settings с меткой "_documentationServer.serverPort" и сохраняются при перезагрузке или перезапуске Hammerspoon.

Запустить веб-сервер внутренней документации Hammerspoon.

• Нет

• таблица, представляющая модуль hs.doc.hsdocs

• Эта функция автоматически вызывается при необходимости, когда вызывается hs.doc.hsdocs.help.
• Веб-сервер документации можно просмотреть в веб-браузере, перейдя по адресу "http://localhost:порт", где port — порт, на котором работает сервер, по умолчанию 12345 — см. hs.doc.hsdocs.port.

Остановить веб-сервер внутренней документации Hammerspoon.

• Нет

• таблица, представляющая модуль hs.doc.hsdocs

Установить или получить, сохраняются ли изменения в местоположении и размере окна браузера документации при запуске Hammerspoon.

• value - необязательный boolean, определяющий, сохранять ли положение окна браузера при запуске Hammerspoon.

• текущее, возможно новое, значение

• Изменения, внесенные с помощью этой функции, сохраняются с hs.settings с меткой "_documentationServer.trackBrowserFrameChanges" и сохранятся при перезагрузке или перезапуске Hammerspoon.