Skip to content

Commit

Permalink
GHAction - Commit content changes pulled from notion
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-polk authored and github-actions[bot] committed Aug 22, 2024
1 parent 354979c commit 0d6a7ec
Show file tree
Hide file tree
Showing 242 changed files with 1,431 additions and 156 deletions.
2 changes: 1 addition & 1 deletion docs/About-Bloom/Release-Notes/_category_.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"position":5, "label":"Release Notes"}
{"position":6, "label":"Release Notes"}
2 changes: 1 addition & 1 deletion docs/About-Bloom/bloom-platform.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Overview of the Bloom Platform
sidebar_position: 2
sidebar_position: 3
slug: /bloom-platform
---

Expand Down
127 changes: 127 additions & 0 deletions docs/About-Bloom/shell-books-in-bloom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
---
title: Shell Books in Bloom
sidebar_position: 2
slug: /shell-books-in-bloom
---



:::note

Content is being updated.

:::




## What is a Shell Book? {#a4f834733ad241eea4f4e94e2960d742}


A shell book is a template used to create other books. It sets the page layout, text box locations, pictures, and more. Shell books are not language-specific, meaning they can be used to create books in any language. For more information, see [this Glossary entry](/glossary#a9855df550204e1caffc0d245164ab11).


### Key Features of Shell Books {#f23de047840745d487111816015dd302}

- **Page Layout**: Defines the structure of each page.
- **Text Boxes and Pictures**: Specifies where text and images should be placed.
- **Source Text**: Contains source text that can be translated into other languages.

### Important Note {#9559de174e9b472fb09f45b14edcda93}

- Each Bloom book functions as a small database of texts in various translations.
- Any local language book can be turned into a shell book for other languages. Shell books and local language books have identical formats.

### Create a Shell Book for Others {#a37bf0a0c93c4666a375c92aee9fdc87}

1. **Open** the collection that uses the language(s) you want the shell book to contain.
2. In the **Collections** tab, click on the appropriate **source template** (e.g., Arithmetic, Basic Book, Big Book).
3. Click `MAKE A BOOK USING THIS SOURCE`. The new book opens in the **Edit tab**.
4. Complete the book:
- Fill in the appropriate **metadata**.
- Add all the intended pages.
- Add a **Translation Instructions** page, if needed.
- Type in all the **source text** in one or more languages.
- Configure all the intended **styles**.
- Choose all the **pictures** that you want to appear in the published book.
5. **Share** the shell book:
- Publish to **BloomLibrary**.
- Make a **Bloom Pack**.
- Make a **Reader Template Bloom Pack**.

### Make a Book from a Sample Shell {#8066b6a3790542f7951c49d4c68d9a07}

1. Click the **Collections tab**.
2. In the left pane, below **Sources For New Books**, click the **sample shell** you will use.
3. Click `MAKE A BOOK USING THIS SOURCE`. The book is added and opens in the **Edit tab**.
4. Follow the relevant steps based on the type of **sample shell** (e.g., basic book, arithmetic). If the book has a **Translation Instructions** page, follow those instructions.

### Install a Basic Bloom Pack from Others {#16c84172c365490b9a209a46623ad172}

1. **Copy** the Bloom Pack file onto your computer (e.g., into the Bloom folder under My Documents or another convenient folder).
2. **Double-click** the file to install the shell books and templates. A message will appear stating, "The <name> Collection is now ready to use on this computer". Click `OK`.
3. **Close and restart** Bloom. The new sources will appear below **Sources for New Books** on the **Collections tab**.

:::tip

You can change the file extension to *.zip if needed. The recipient can change it back to *.BloomPack.

:::




### Related Topics {#aba9893a664945779e070d99e3e2c855}


Here are some suggested related topics:

- Basic Tasks Overview
- Collections Tab Tasks
- Edit Tab Tasks
- Create Shell Books for Others to Use
- Publish to BloomLibrary
- Make a Bloom Pack
- Make a Reader Template Bloom Pack

:::note

This is an info note.

:::




### Install a Basic Bloom Pack from Others {#f7b8e6bc0c4e453eb186a20630567674}

1. **Copy** the Bloom Pack file onto your computer (e.g., into the Bloom folder under My Documents or another convenient folder).
2. **Double-click** the file to install the shell books and templates. A message will appear stating, "The <name> Collection is now ready to use on this computer". Click `OK`.
3. **Close and restart** Bloom. The new sources will appear below **Sources for New Books** on the **Collections tab**.

<aside>
💡 You can change the file extension to *.zip if needed. The recipient can change it back to *.BloomPack.


</aside>


### Related Topics {#6b82b8bd2cef4954876c749a66e67e08}


Here are some suggested related topics:

- Basic Tasks Overview
- Collections Tab Tasks
- Edit Tab Tasks
- Create Shell Books for Others to Use
- Publish to BloomLibrary
- Make a Bloom Pack
- Make a Reader Template Bloom Pack

<aside>
ℹ️ This is an info note.


</aside>

2 changes: 1 addition & 1 deletion docs/About-Bloom/when-to-use-bloom.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Is Bloom right for my project?
sidebar_position: 3
sidebar_position: 4
slug: /when-to-use-bloom
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ There are two bad habits that violate best practices:
- Using spaces to center or indent text.
- Formatting entire text boxes using _character_ formatting instead of using the text box style.

## Using Spaces to Center or Indent Text {#78392b559be3468ca66edc6b5b128560}
## Do not use spaces to center or indent Text {#78392b559be3468ca66edc6b5b128560}


![](./bloom-editor-best-practices.97b360ea-59c9-4902-a67e-bbfd05b58498.png)
Expand Down Expand Up @@ -68,7 +68,7 @@ Conclusion: Do not use spaces to center text or to indent text. Instead, use a
![](./bloom-editor-best-practices.7becff2e-8b11-4f94-b801-c0aeee2b9eb4.png)


## Formatting the entire text box using _character_ formatting instead of using a style {#db922f79470c42baa2dc8fa8d06e427b}
## Do not format the entire text box using _character_ formatting instead of using a style {#db922f79470c42baa2dc8fa8d06e427b}


Bloom allows you to select certain words in a text box and make them bold, italic etc.. This is useful for highlighting particular words, e.g.:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
170 changes: 170 additions & 0 deletions docs/Bloom-Editor/Collections-and-Books/collection-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
---
title: Collection Settings
sidebar_position: 1
slug: /collection-settings
---



:::note

This page is a draft version.

:::




To open/change the settings for your current collection:

1. Click on the `Collections` tab.
2. Click on `Settings` in the **upper-right corner** of the Bloom window.

![](./collection-settings.1c7d9e36-8357-4619-9bcb-af1dff31dcb0.png)


There are five different tabs in the **Collection Settings** window:

- [**Languages**](/collection-settings#666299e09b6c4f36bd368dcbd8a20a10): Set the language(s) for the books in this collection.
- [**Book Making**](/collection-settings#ce3b078271804fad95b986b382a8d7eb):
- [**Project Information**](/collection-settings#06fe40e899ee450686c2cf937cd56380)**:**
- [**Bloom Enterprise**](/collection-settings#d375f428f63d4ccc9721bb4c81db0f76)**:**
- [**Advanced Program Settings**](/collection-settings#be4f20d8ed584ed2bceb94d29da72ed7)**:**

## Languages Tab {#666299e09b6c4f36bd368dcbd8a20a10}


In the Languages tab, you can choose the languages for the books in this collection.


![](./collection-settings.e67f7f62-70bb-474d-b588-870104b80005.png)


:::note

The Collection settings tab defines the languages that are available for display in the books in the collection. The languages that are actually displayed in each book are controlled by the Book Settings in the toolbar of the Edit tab.

:::




## Book Making Tab {#ce3b078271804fad95b986b382a8d7eb}


Choosing the default fonts and numbering style for the languages in your book, plus front/back matter layouts and Bloom Library bookshelf (for Enterprise customers).


![](./collection-settings.cca0a0d3-e431-4e74-8895-adb8ad41931b.png)


(1) Default Fonts:
You can choose default fonts for your local language, Language 2, and Language 3 can be set here.


(2) Page Numbering Style:
You can choose the page numbering style here. The default style is `Decimal`, using western Arabic numerals Other available styles include Arabic-Indic, Bengali, CJK-Decimal, and many others.


(3) Front/Back Matter Pack:
You can select the front/back matter arrangement here. The Basic Book template includes the following layouts:

- Traditional: Credits on the back of the title page
- Device: This is automatically applied when publishing to Bloom Reader (Android). It moves front matter pages (other than the cover) to the back.
- Paper Saver: Designed to save paper, this puts the credits on the inside of the front cover.
- Super Paper Saver: Designed to save paper, this puts the title page on the inside of the front cover, and the credits on the inside of the back cover.
- SIL-PNG: Has SIL Papua New Guinea customizations, including hiding some fields and changing instructions in others.

(4) Bloom Library Bookshelf (Bloom Enterprise customers only):
Projects that have Bloom Enterprise subscriptions can arrange for one or more bookshelves on the Bloom Library. All books uploaded from this collection will go into the selected bookshelf.


## Project Information Tab {#06fe40e899ee450686c2cf937cd56380}


The Project Information tab lets you set the country, province, and district description. You can also change the name of the collection here (but remember that each collection on your computer must have a unique name).


![](./collection-settings.e05ef283-cd4b-4e8b-abc9-4cab7e1209ee.png)


## Bloom Enterprise Tab {#d375f428f63d4ccc9721bb4c81db0f76}


[Bloom Enterprise](/about-bloom-enterprise) adds features and services that are important for publishers, governments, and international organizations. This paid subscription meets their unique needs while supporting the development and user support of Bloom for the community at large.


In addition, Bloom Enterprise features are available to projects that are funded by local communities.


![](./collection-settings.960ca528-5f95-4038-9cea-ea303f61349d.png)


If you have a Bloom Enterprise subscription, click the `Enterprise Subscription` tab and enter your Bloom Enterprise code there.


If your project is funded by the local community, you can enable Bloom Enterprise features by clicking `Funded by the local community only`.


:::note

Books produced with the locally-funded Bloom Enterprise features will have “Bloom Local” automatically branding applied to them.

:::




## Team Collection {#c9f1df86137140738adb9c016f45158a}


[Team Collections](/team-collections-intro) are a way for a group of authors, illustrators, and editors to work together on a collection of books. Team collections use a “shadow collection” stored on a shared file service to manage and synchronize a collection of books. Team Collections are a Bloom Enterprise feature.


Use this tab to convert a regular Bloom collection into a team collection. For detailed instructions, see [Get Started With Team Collections](/team-collections-getting-started).


:::note

Team collections are an experimental feature. Be sure the `Team Collections` box is checked in the `Advanced Program Settings` tab.

:::




![](./collection-settings.daaea4c1-7b73-40b6-8273-5341a36df5af.png)


## Advanced Program Settings Tab {#be4f20d8ed584ed2bceb94d29da72ed7}


The Advanced Program Settings has a variety of additional features. As of Bloom 6.0 the following advanced program settings are available:

- `Automatically Update Bloom`: check this have Bloom automatically download and install software updates.

:::note

If `Automatically Update Bloom` is not checked, you can manually download updates using the `Check for New Version` command in the help (?) menu.

:::



- `Show Experimental Book Sources`: Some sources are marked as experimental: these are available to you, but they are known to have problems. Unchecking this box will hide them.
- `Team Collections`: This box must be checked for a collection to be made into a team collection. Team Collections are a [Bloom Enterprise feature](/enterprise-features#55c8baa318884dcf874c76f7e0dd9859).
- `Spreadsheet Import/Export`: This [Bloom Enterprise feature](/enterprise-features#04fd63f5a0fa443bb635115674b580a2) allows text and images from a Bloom book to be exported to a spreadsheet, and re-imported into a Bloom book. This can be useful for making translations or for troubleshooting language encodings. For more details see [Spreadsheet Import and Export](/spreadsheet-import-export).

![](./collection-settings.6027d13a-67ce-4987-9c65-68582153d1ab.png)


## Settings Protection {#422fb5b9640a47af9841db4a7b5758c6}


At the bottom section of the Collection Settings window link to the `Settings Protection` dialog box. If you are supporting inexperienced users of Bloom, you may wish to hide the Settings dialog box to prevent them from making inappropriate changes to the collection settings.

- `Hide the button that opens settings`: Checking this box hides the button in the Collections toolbar that shows the Settings button. Hold down the `Ctrl` and `Shift` keys at the same time to show the button.
- `Require the factory password to get into settings`: If this box is checked, you must enter the factory-set `b7loom` password to access the Settings dialog box.

![](./collection-settings.0d26e334-4e84-4869-bbdd-c0b7120f4dbf.png)

20 changes: 20 additions & 0 deletions docs/Bloom-Editor/Decodable-Readers/create-decodable-book.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Create a Decodable Book from a Decodable Book Template
sidebar_position: 2
slug: /create-decodable-book
---


1. Go to the **Collections Tab**.
2. In the **Sources for New Books section**, scroll down until you find the **Decodable Reader Template(s)**.
1. In this example, there is a set of templates, one for each decodable stage.
3. Select a template that corresponds to the decodable stage for your book.
1. For example, if you want to write a Stage 2 Decodable Reader, select the Stage 2 Template.
4. Click `MAKE A BOOK USING THIS SOURCE`.
5. The book is added to your collection and is opened for editing.

## Write a Decodable Reader Book {#5f3aefc29dc7439897a80ed44ff88073}


See [Use the Decodable Reader Tool](/use-decodable-reader-tool) to learn how to write a decodable reader book.

Loading

0 comments on commit 0d6a7ec

Please sign in to comment.