A Resource Container (RC) link allows one RC to reference content from another RC. Also, web links may be used to reference content online.


Applications using RCs may want to search the RC data for external links and cache the online content so the RC can be used while offline without missing content such as images.

How links are written depends on the file format. For example, a link within a markdown file would be displayed with the title in brackets and the url in parenthesis:

[Link Title](

In markdown we support an additional link form that provides a link without a title. The title in these cases will be automatically generated from the context:


RC links follow the same form as web links in that they have a scheme and uri.



RC links are identified by the rc schema in the same way that websites are identified by http. The scheme tells the software how to process the uri.



The uri in an RC link is composed of the following components.

Any additional information you include must be added after those mentioned above.



Some times it can be helpful to create a generic link. Such as when referencing an entire resource like the English Unlocked Literal Bible.

To facilitate this RC links support a wildcard * that can be used in place of any component in the uri.


If the wildcard occurs at the end of the link you can exclude it entirely.

# or

You can also do things like link to a book in any language



An RC link is resolved like a file path. The first few components address which RC to use. And any remaining components address the specific content inside the RC.

This is illustrated below:

# link

# bundle RC on file system
    |-02-EXO.usfm <=== the manifest will indicate that exo points here

From this point we can lengthen the link to include a chapter Identifier.


If the RC is a Bundle (bundle) the client application is responsible for understanding how to resolve to the chapter or any other location in the content.

# link

# book RC on file system
    |   |-01/ <=== link points here
    |   ...

Going a step further we can link to a specific chunk

# link

# file system
            | <=== link points here

In some of the examples above the link was pointing to a directory. In those cases the link should resolve to the first available file in order of the sorting priority described in Naming Chapters and Chunks.


Depending on the client application, several files may be combined together when displayed to the user. For example: when linking to a chapter in a book of the Bible it would make more sense to show at least the title and summary, if not the rest of the chapter, rather than just the title.



  • [Genesis 1:2](rc://en/ulb/book/gen/01/02)
  • [Open Bible Stories 1:2](rc://en/obs/book/obs/01/02)


  • [[rc://en/tq/help/gen/01/02]] - links to translationQuestions for Genesis 1:2
  • [[rc://en/tn/help/gen/01/02]] - links to translationNotes for Genesis 1:2


  • [Canaan](rc://en/tw/dict/bible/other/canaan)


  • [Translate Unknowns](rc://en/ta/man/translate/translate-unknown)


  • [Genesis](rc://en/ulb/bundle/gen/01/01)


Linking to a Bundle (bundle) will resolve down to the project level. The application will need to support parsing the bundle format (if references are supported) in order to continue resolving the link.

Formats that support references are:

  • usfm
  • osis


When using RCs with multiple projects the application will need to inspect the Manifest File to determine which Project Directory to read while resolving a link.


In certain cases it is appropriate to abbreviate a link. Below are a list of cases where you are allowed to use an abbreviation.

Bible References

Bible references in any RC may be automatically converted into resolvable links according to the linking rules for book resource types. Of course, if the biblical reference is already a link nothing needs to be done.

Conversion of biblical references are limited to those resources that have been indexed on the users’ device. Conversion should be performed if in the text either of the following conditions is satisfied:

  • a case insensitive match of the entire project title. e.g. Genesis is found in the text.
  • a start case (first letter is uppercase) match of the project Identifier e.g. Gen.

For each case above there must be a valid chapter:verse reference immediately after the matching word separated a single white space. For example:

Genesis 1:1
genesis 1:1
Gen 1:1
Gen 1:1-3

The chapter and verse numbers should be converted to properly formatted identifiers.


Given the French reference below:

Genèse 1:1

If the user has only downloaded the English resource the link will not resolve because the title Genesis or genesis does not match Genèse or genèse. Neither does the camel case Identifier Gen match since it does not match the entire word.

If the user now downloads the French resource the link will resolve because Genèse or genèse does indeed match Genèse or genèse. The result will be:

[Genèse 1:1](rc://fr/ulb/book/gen/01/01)

Multiple Matches

When a match occurs there may be several different resources that could be used in the link such as ulb or udb. When more than one resource Identifier is available use the following rules in order until a unique match is found:

  1. use the same resource as indicated by the application context.
  2. use the RC allowed by the translate_mode set in the application.
  3. choose the first resource found or let the user choose (e.g. pop up).

Aligning Verses to Chunks

Because chunks may contain a range of verses, a passage reference may not exactly match up to a chunk. Therefore some interpolation may be necessary. For both chapter and verse numbers perform the follow:

Given a chapter or verse number key. And an equivalent sorted list list of chapters or verses in the matched resource
  • incrementally compare the key against items in the list.
  • if the integer value of the current list item is less than the key: continue.
  • if the integer value of the current list item is greater than the key: use the previous item in the list.
  • if the end of the list is reached: use the previous item in the list.

For example chunk 01 may contain verses 1-3 whereas chunk 02 contains verses 4-6. Therefore, verse 2 would resolve to chunk 01.

If no chapter or chunk can be found to satisfy the reference it should not be converted to a link.