index.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. <html>
  2. <head>
  3. <title>Документация QStarDict</title>
  4. <link rel="stylesheet" type="text/css" href="styles/style.css">
  5. </head>
  6. <body>
  7. <div id="wrap">
  8. <h1>Документация QStarDict</h1>
  9. <p>
  10. QStarDict &mdash; это словарное приложение. Оно позволяет пользователю
  11. устанавливать словари Kiwix и StarDict и искать слова в этих словарях.
  12. </p>
  13. <p>Эта инструкция должна помочь Вам в использовании QStarDict.</p>
  14. <h2>Содержание</h2>
  15. <ul>
  16. <li><a href="#запуск-qstardict">Запуск QStarDict</a></li>
  17. <li><a href="#работа-в-фоне">Работа в фоне</a></li>
  18. <li><a href="#запуск-с-системой">Запуск с системой</a></li>
  19. <li><a href="#установка-словарей-kiwix">Установка словарей Kiwix</a></li>
  20. <li><a href="#установка-словарей-stardict">Установка словарей StarDict</a></li>
  21. <li><a href="#поиск-слов">Поиск слов</a></li>
  22. <li><a href="#всплывающее-окно">Всплывающее окно</a></li>
  23. </ul>
  24. <a href="#запуск-qstardict" name="запуск-qstardict"><h2>Starting QStarDict</h2></a>
  25. <p>QStarDict можно запустить либо через меню среды среды рабочего стола в разделе
  26. «Образование», либо с использованием командной строки путем набора команды
  27. <p><code>
  28. qstardict
  29. </code></p>
  30. <a href="#работа-в-фоне" name="работа-в-фоне"><h2>Работа в фоне</h2></a>
  31. <p>Когда QStarDict запущен, он может быть либо в нормальном режиме, когда главное
  32. окно показано, как здесь:
  33. <img src="images/main-window-intro.png" width="100%">
  34. или он может быть запущен в фоновом режиме.
  35. </p>
  36. <p>
  37. Когда QStarDict запущен в фоновом режиме, он может быть показать в области
  38. уведомлений:
  39. </p>
  40. <p align="center"><img src="images/notification-area.png"></p>
  41. <p>
  42. Предназначение фонового режима &mdash; сделать возможным для QStarDict сканирование
  43. cвыделения в других приложениях и показ всплывающего окна со словарными статьями.
  44. Смотрите раздел о <a href="#всплывающее-окно">всплывающем окне</a> для деталей.
  45. </p>
  46. <p>
  47. Для того, чтобы сделать возможным для QStarDict быть запущенным в фоне,
  48. соответствующая настройка должна быть включена:
  49. <img src="images/settings-run-in-background.png" width="100%">
  50. По умолчанию она включена.
  51. </p>
  52. <p>
  53. QStarDict запоминает, был ли он в нормальном или фоновом режиме, при выходе,
  54. и при последующем запуске восстанавливает состояние нахождения в фоновом режиме.
  55. </p>
  56. <p>
  57. Если Вы хотите, чтобы QStarDict запускался в фоновом режиме, используйте
  58. опцию командной строки <code>--background</code>, запуская QStarDict как
  59. </p><p>
  60. <code>
  61. qstardict --background
  62. </code>
  63. </p>
  64. <a href="#запуск-с-системой" name="запуск-с-системой"><h2>Запуск с системой</h2></a>
  65. <p>
  66. Возможно настроить запуск QStarDict вместе с системой в распространенных средах
  67. рабочего стола. Для того, чтобы включить запуск QStarDict с системой, используйте
  68. соответствующую настройку:
  69. </p>
  70. <p align="center"><img src="images/settings-start-with-system.png" width="100%"></p>
  71. <p>
  72. По умолчанию запуск с системой отключен.
  73. </p>
  74. <a href="#установка-словарей-kiwix" name="установка-словарей-kiwix">
  75. <h2>Установка словарей Kiwix</h2></a>
  76. <p>
  77. <a href="https://kiwix.org/en/">Kiwix</a> &mdash; это проект, целью которого
  78. является создание оффлайн-версий веб-сайтов. Наиболее выдающимся среди этих
  79. веб-сайтов для использования с QStarDict является <a href="https://www.wiktionary.org/">Викисловарь</a>.
  80. </p>
  81. <p>
  82. Для того, чтобы загрузить оффлайн-версии Викисловаря для языков, которые Вам
  83. требуются, посетите
  84. <a href="https://download.kiwix.org/zim/wiktionary/">Страницу загрузки ZIM-файлов</a>
  85. и выберите версию "nopic" Викисловаря для языка, который Вам требуется.
  86. </p>
  87. <p>Обратите внимание, что язык, указанный в имени файла является целевым языком,
  88. а не исходным языком. Каждый язык содержит статьи для слов на всех исходных
  89. языках на целевом языке. К примеру, если Вы хотите смотреть слова на английском,
  90. переведенные на русский, Вам нужно выбрать файл с языковым кодом «ru_all».
  91. </p>
  92. <p>Примеры названий файлов:</p>
  93. <ul>
  94. <li>«wiktionary_ru_all_nopic_2023-09.zim» &mdash; словарь на русском для всех языков;</li>
  95. <li>«wiktionary_en_all_nopic_2023-07.zim» &mdash; словарь на английском для всех языков.</li>
  96. </ul>
  97. <p>
  98. Предположим, что Вы загрузили файл «wiktionary_en_all_nopic_2023-07.zim» в
  99. директорию «~/Загрузки».
  100. </p>
  101. <p>
  102. Он может быть установлен из вкладки «Словари» диалога настроек, который может
  103. быть открыт с использованием меню «Настройки»&nbsp;→&nbsp;«Конфигурация» в главном
  104. окне:
  105. <img src="images/settings-dictionaries-add.png" width="100%">
  106. </p>
  107. <p>Для того, чтобы установить словарь, нажмите кнопку «Добавить словарь», которая
  108. отмечена на скриншоте.
  109. </p>
  110. <p>
  111. Выполнение этого приведет к открытию файлового диалога:
  112. </p>
  113. <img src="images/file-dialog-kiwix.png" width="100%">
  114. <p>
  115. В файловом диалоге выберите фильтр «ZIM файлы Kiwix» (отмеченный на скриншоте)
  116. и затем выберите ZIM файл, который Вы хотите добавить.
  117. </p>
  118. <p>Когда файл выбран, появится диалог добавления словаря:</p>
  119. <img src="images/add-dialog-kiwix.png">
  120. <p>
  121. Он предложит Вам переместить словарь в директорию QStarDict.
  122. </p>
  123. <p>
  124. Также возможно не перемещать словарный файл, а создать символическую ссылку на
  125. словарный файл. Для того, чтобы сделать это, выберите пункт меню "Symlink" в
  126. комбинированном списке в диалоге добавления.
  127. </p>
  128. <p>
  129. После импорта словарю он появится наверху в списке словарей в диалоге настроек:
  130. </p>
  131. <img src="images/settings-dictionaries-dict-kiwix.png" width="100%">
  132. <p>
  133. После нажатия кнопки OK добавленные словари будут включены и станет возможным
  134. <a href="#поиск-слов">искать слова</a> из него.
  135. </p>
  136. <a href="#установка-словарей-stardict" name="установка-словарей-stardict"><h2>Установка словарей StarDict</h2></a>
  137. <p>
  138. QStarDict поддерживает словари в формате StarDict 2.x и StarDict 3.x.
  139. </p>
  140. <p>
  141. Словарь StarDict состоит из трех файлов:
  142. </p>
  143. <ul>
  144. <li>«.ifo» &mdash; файл, содержащий метаданные о словаре;
  145. <li>«.idx» &mdash; индексный файл словаря;
  146. <li>«.dict.dz» &mdash; файл, содержащий словарные статьи.
  147. </ul>
  148. <p>
  149. Словарь StarDict может быть установлен в QStarDict путем открытия вкладки «Словари»
  150. в диалоге настроек, который может быть открыт с использованием меню
  151. «Настройки»&nbsp;→&nbsp;«Конфигурация» в главном окне:
  152. <img src="images/settings-dictionaries-add.png" width="100%">
  153. Для того, чтобы установить словарный файл в QStarDict, нажмите кнопку
  154. «Добавить словарь», которая отмечена на скриншоте.
  155. </p>
  156. <p>
  157. Это приведет к открытию файлового диалога:
  158. </p>
  159. <img src="images/file-dialog-stardict.png" width="100%">
  160. <p>
  161. В файловом диалоге выберите фильтр «IFO файлы StarDict» (отмеченный на скриншоте)
  162. и затем выберите ".ifo" файл, который Вы хотите добавить.
  163. </p>
  164. <p>
  165. Обратите внимание, что «.idx» и «.dict.dz» файлы должны быть в той же директории,
  166. что и «.ifo» файл для того, чтобы словарь мог быть успешно импортирован.
  167. </p>
  168. <p>
  169. После импортирования словаря он появится наверху списка словарей в диалоге настроек:
  170. </p>
  171. <img src="images/settings-dictionaries-dict-stardict.png" width="100%">
  172. <p>
  173. После нажатия OK добавленные словари будут включены и станет возможным
  174. <a href="#поиск-слов">искать слова</a> в нем.
  175. </p>
  176. <a href="#поиск-слов" name="поиск-слов"><h2>Поиск слов</h2></a>
  177. <p>
  178. Является возможным искать слова в главном окне QStarDict. Слова, которые требуется
  179. найти, могут быть введены в текстовое поле ввода. По умолчанию слова ищутся
  180. по мере того, как они введены, но это поведение может быть отключено в разделе
  181. «Общие настройки» диалога конфигурации.
  182. </p>
  183. <a href="#всплывающее-окно" name="всплывающее-окно"><h2>Всплывающее окно</h2></a>
  184. <p>
  185. Всплывающее окно &mdash; это окно, которое может быть показано рядом со словами,
  186. выделенными мышью. Его поведение может быть настроено во вкладке «Всплывающее окно»
  187. диалога конфигурации.
  188. </p>
  189. </div>
  190. </body>
  191. </html>