-
Notifications
You must be signed in to change notification settings - Fork 4
Index of Directories
You can navigate this page by searching the directory name in your browser.
Or, you can write https://github.com/bibledit/cloud/wiki/Index-of-Directories#[DIRECTORY_NAME] in your browser's URL bar.
This page contains relevant basic explanations for each directory and its contents of the source tree.
Because Bibledit is basically a web application with a built-in browser engine, around a third of the directories here contains:
- a markup,
index.html - a server side display logic,
index.cpp - a client side display logic,
index.js(a sixth of the directories) - a server side internal logic,
logic.cpp
The rest are internal logic.
This directory only contains internal logic. The internal logic contained here is for managing access level of users.
As Bibledit is a multi-user application and are aimed for translation teams, so access level management are required as there are different roles in Bible translation teams.
This directory contains parts of pages and the logic to display pages. The parts of pages contained here are the page's header, footer, and a couple functionalities. The logic to display pages contained here are both for parts of pages (assets/header.cpp) and whole pages (assets/view.cpp). The logic includes error handling.
The logic to display whole pages is basically an implementation of the template engine (flate/flate.cpp).
This directory is empty by default. It would contain USFM split into Bibledit's unique file system database directory structure.
Bibledit's unique file system database directory structure is:
- a USFM file split by chapter named
100000001, - inside a directory that's recognized as a chapter named by the chapter's number,
- inside a directory that's recognized as a Bible book named by the Bible book's index number,
- inside a directory that's recognized as the whole Bible named by the Bible's chosen name.
This directory only contains internal logic. The internal logic contained here is for generating HTML templates.
The Flate template engine recognizes three types of markup unique to Bibledit: zones, variables, and string localization calls (to locale/translate.cpp.
Zones
Syntax example in an index.html file:
<!-- #BEGINZONE display_topbar -->
<div id="topbar" class="menu-advanced">
<!-- .. more code .. -->
</div>
<!-- #ENDZONE display_topbar -->Corresponding configuration in an index.cpp: