Features

Last updated: v0.0.9

Here's a simple outline of the main features of the Codex editor. Features marked "EXPERIMENTAL" have been implemented but are under active development and are thus unstable depending on your system, the state of your project, etc.

  • Scripture Explorer: The "Scripture Explorer" is an activity bar view container that gives users a dedicated space to navigate through scripture files easily. It enhances the workflow by organizing and providing quick access to different parts of the scripture being worked on.

  • Project Creation: Located within the "Scripture Explorer" view, this feature offers users a webview panel named "Create a new project." It's designed to assist users in starting new translation projects by guiding them through the setup process.

Note: we are pulling together various project creation functionalities that we build over the first three months of the project into a more unified process.

  • Resource Explorer: This view container is a hub for managing and accessing various resources needed for translation projects. It includes a panel for seeing downloaded resources and another panel for allowing the user to download resources from Door43.

    • Downloaded Resources: This view is part of the "Resource Explorer" and displays resources that have been downloaded for use in translation projects. It helps users manage and access their downloaded materials efficiently.

    • All Resources: Also within the "Resource Explorer," this view shows all available resources, not just those downloaded. It's a comprehensive view for users to explore and select resources for their translation work.

  • Dictionary Summary: This view container aggregates dictionary-related tools, including the Dictionary Table and Thesaurus. It's a comprehensive resource for understanding and translating terms accurately.

    • Dictionary Table: This view offers a dictionary table for managing the project dictionary. It enables users to the "Dictionary Summary" view container. It's a tool for users to reference and understand specific terms better. We have implemented very basic features for this table so far, and plan to expand the functionality significantly.

    • [EXPERIMENTAL] Thesaurus: The "Semantic View" or Thesaurus provides synonyms and related terms to help in the translation process. It's part of the "Dictionary Summary" view container, enhancing the user's ability to find the right words.

  • OBS Editor: The "OBS Editor" view container is specifically designed for managing and editing Open Bible Stories (OBS) projects. It currently lists the available OBS stories and enables users to open each story for editing.

  • [EXPERIMENTAL] Parallel Passages View: This view provides users with a side panel named "Parallel Passages" that allows them to search for scripture passages based on semantic similarity. You can search the "Draft" (your translation so far) or "Source" (any source Bibles you have downloaded).

  • Comments View: This view enables users to create comment threads on any verse of the Bible. Comment threads can also be extended with additional comments. For now, it makes sense to write you name in your comment, but once the username project setting is stabilized we will automatically add your user name to any comment you add. These comments are synced across projects.

  • [EXPERIMENTAL] Genesis Translator Bar (Chatbot) View: This view enables users to chat with an AI model to ask questions about any verse of the Bible, or about related content.

    • Important: In order to use this chatbot, you need to have a Large Language Model running on your computer (we recommend using LM Studio), and you need to activate LM Studio's server feature to ensure that the LLM is being served on https://localhost:1234. You can change this URL in your project settings (File > Settings > Settings), under the setting translators-copilot.llmEndpoint.

    • If you have access to OpenAI's API, you can also configure the endpoint, model, and API key under the translators-copilot settings.

    • If you highlight any text in the main editor, you will see this text in a small box above the chat

Last updated