/usr/share/bibledit-gtk/site/gtk/reference/internals.html is in bibledit-gtk-data 4.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<link href="../../bibledit.css" rel="stylesheet" type="text/css" /><!--
Copyright (©) 2003-2011 Teus Benschop and Contributors to the Wiki.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled "GNU
Free Documentation License" in the file FDL.
-->
<title></title>
</head>
<body>
<div id="menu">
<ul>
<li>
<a href="../../home.html">1 Bibledit</a>
</li>
<li>
<a href="../reference.html">Reference</a>
</li>
<li style="list-style: none; display: inline">
<hr />
</li>
<li>
<a href="changes-log.html">Changes Log</a>
</li>
<li>Internals
</li>
<li>
<a href="keyboard-accelerators.html">Keyboard accelerators</a>
</li>
<li>
<a href="menu.html">Menu</a>
</li>
<li>
<a href="usfm.html">USFM</a>
</li>
</ul>
</div>
<div id="content">
<h1>
Internals
</h1>
<h2>
<a name="TOC-Introduction" href="" id="TOC-Introduction"></a>Introduction
</h2>
<p>
This page describes the internals of Bibledit. That is, it gives technical specifications and information about how Bibledit works internally.
</p>
<h2>
<a name="TOC-Temporary-directory" href="" id="TOC-Temporary-directory"></a>Temporary directory
</h2>
<h3>
<a name="temporarydirectory" href="" id="temporarydirectory"></a>
</h3>
<p>
The directory where Bibledit stores all temporary working data is in directory
</p>
<pre>
/tmp/bibledit
</pre>
<h2>
<a name="TOC-Stylesheets-storage" href="" id="TOC-Stylesheets-storage"></a>Stylesheets storage
</h2>
<h3>
<a name="stylesheetsstorage" href="" id="stylesheetsstorage"></a>
</h3>
<p>
The stylesheets, as templates, are xml files, stored in <a href="https://sites.google.com/site/bibledit/gtk/4-management/data"><data directory></a>/stylesheets. Same for imported and exported stylesheets, except that they are zipped.
</p>
<h2>
<a name="TOC-Data-storage" href="" id="TOC-Data-storage"></a>Data storage
</h2>
<h3>
<a name="datastorage" href="" id="datastorage"></a>
</h3>
<p>
Data, that means, the USFM files, are internally stored as flat files, one file per chapter. This gives faster access to the data. The files are stored in <a href="https://sites.google.com/site/bibledit/gtk/4-management/data"><data directory></a>/projects/<project name>, along with other files related to this project.
</p>
<h3>
<a name="gittasks" href="" id="gittasks"></a>
</h3>
<h2>
<a name="TOC-Bibledit-Windows-Outpost" href="" id="TOC-Bibledit-Windows-Outpost"></a>Bibledit Windows Outpost
</h2>
<p>
The Outpost allows Bibledit to interact with Windows related stuff.
</p>
<p>
The Outpost does not have any visible functionality of its own.
</p>
<p>
For communication to take place, Windows Outpost needs to use the same emulator as the other Windows programs you use on Linux. This means that if you install BibleWorks using Wine, then Windows Outpost must also be installed on Wine. And if you use CrossOver Office, then you need to use CrossOver Office for both, and both need to be installed in the same bottle.
</p>
<p>
Bibledit connects to the interface on the Outpost, and communicates through that channel. This TCP/IP interface listens on port 51515.
</p>
<p>
For diagnostics or control you can connect to it. In a terminal type
</p>
<pre>
telnet localhost 51515
</pre>
<p>
The following commands are recognized.
</p>
<pre>
BibleWorksReferenceGet
</pre>
<p>
This returns the reference that BibleWorks now displays.
</p>
<pre>
BibleWorksReferenceSet Mat 1:1
</pre>
<p>
This causes BibleWorks to scroll to Matthew 1:1.
</p>
<pre>
SantaFeFocusReferenceGet
</pre>
<p>
This returns the reference that is displayed by programs that work with the SantaFeFocus system, such as Paratext.
</p>
<pre>
SantaFeFocusReferenceSet MAT 1:1
</pre>
<p>
This lets programs, that work with the SantaFeFocus system, display Matthew 1:1.
</p>
<pre>
SantaFeFocusWordSet Saviour
</pre>
<p>
This lets programs like Toolbox, that work with the SantaFeFocus system, jump to the word "Saviour".
</p>
<pre>
Version
</pre>
<p>
This gives the version number.
</p>
<pre>
Hide
</pre>
<p>
This hides Bibledit Windows Outpost.
</p>
<pre>
Show
</pre>
<p>
This shows Bibledit Windows Outpost.
</p>
<pre>
Quit
</pre>
<p>
This disconnects from Bibledit Windows Outpost.
</p>
<pre>
Exit
</pre>
<p>
This exist Bibledit Windows Outpost.
</p>
<pre>
Open http://domain.org
</pre>
<p>
This opens a html or pdf file. Works on Windows only.
</p>
<p>
All this information is not really needed in normal cases. Bibledit takes care of it.
</p>
<p>
Outpost version 1.7 and later have support for the Online Bible. See the examples below of what can be done with it.
</p>
<pre>
OLB Connect
</pre>
<p>
Connects to the Online Bible.
</p>
<pre>
OLB GetVersionList
</pre>
<p>
This gets the list of abbreviations of Bibles that the Online Bible provides, e.g. AV.
</p>
<pre>
OLB GetVersionTitleList
</pre>
<p>
This is like "GetVersionList", but it provides the full titles, e.g. AV - 1769 Authorized Version.
</p>
<pre>
OLB GetBookNamesForVersion
</pre>
<p>
This gets the list of names of the books that is in a certain version. The version is to be provided, e.g.: OLB GetBookNamesForVersion AV.
</p>
<pre>
OLB GetBookAbbreviationsForVersion
</pre>
<p>
This is like GetBookNamesForVersion, but it provides the abbreviations.
</p>
<pre>
OLB GetChapterCountForBook
</pre>
<p>
This gets the number of chapters in a book. The version has to be provided, and the book abbreviation, e.g.: OLB GetChapterCountForBook AV Ge.
</p>
<pre>
OLB GetVerseCountForChapter
</pre>
<p>
This gets the number of verses in a chapter. The version has to be provided, then the book abbreviation, then the chapter number, e.g. "OLB GetVerseCountForChapter AV Ge 1".
</p>
<pre>
OLB GetVerseText
</pre>
<p>
This gets the text of a verse, e.g.: OLB GetVerseText AV "Ge 1:1". Notice the use of quotes.
</p>
<pre>
OLB GetSearchList
</pre>
<p>
This searches a version in for some text. Sample:
</p>
<pre>
OLB GetSearchList AV "Noah"
</pre>
<p>
You can add a "T" at the end to make it a phrase search, and a "F" to make it a word search. A space should be before the T or the F.
</p>
<pre>
OLB ShowPassage
</pre>
<p>
Scrolls the Online Bible to the passage, e.g.: OLB ShowPassage AV "Ge 2:4". Quotes are needed.
</p>
<pre>
OLB GetPassage
</pre>
<p>
This receives the focused passage from the Online Bible.
</p>
<pre>
OLB Disconnect
</pre>
<p>
Disconnects from the Online Bible.
</p>
<h2>
<a name="TOC-Floating-windows" href="" id="TOC-Floating-windows"></a>Floating windows
</h2>
<h3>
<a name="floatingwindows" href="" id="floatingwindows"></a>
</h3>
<p>
All the windows of Bibledit are floating and can be resized. If a new window is opened, then Bibledit will look for the largest available open space, and place the window there. It will also size the window so that it fills that open space. If there is no sufficient space available to place a window in, then Bibledit will look for the largest window, make it half the size, and place the new window in the open space so created.
</p>
<h2>
<a name="TOC-Commandline-parameters" href="" id="TOC-Commandline-parameters"></a>Commandline parameters
</h2>
<p>
--debug. For debugging in gdb.
</p>
<p>
--xembed <window identifier>. If that argument is present, it creates a plug for its main window instead of a normal top-level window.
</p>
<p>
-r|-w <project> <book> chapter|0 fileName. For reading from or writing to Bibledit USFM data. See source file readwrite.cpp for more information.
</p>
</div>
</body>
</html>
|