> For the complete documentation index, see [llms.txt](https://docs.openbrim.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openbrim.org/faq/general/faq-illegal-chars.md).

# Illegal Characters

When you enter certain names for objects or projects, some characters are automatically replaced with an underscore (“\_”). This is due to the parametric computation logic used internally. These characters can interfere with parametric equations and cause unexpected results.

For example, if you name an object **PierCap1+5**, OpenBrIM interprets this as a parameter named *PierCap1* plus the value *5*, rather than a single name. To avoid such conflicts, the following characters are not allowed:

**Illegal characters:**

* (space)
* `'` (single quote)
* `\` (backslash)
* `/` (forward slash)
* `|` (vertical bar / pipe)
* `?` (question mark)
* `*` (asterisk)
* `-` (hyphen)
* `+` (plus sign)
* `<` (less than)
* `>` (greater than)
* `:` (colon)
* `.` (period / dot)
* `@` (at sign)
* `(` (left parenthesis)
* `)` (right parenthesis)
* `"` (double quote)
* `%` (percent sign)
* `,` (comma)

All of these will be replaced automatically with an underscore (`_`) to ensure parametric stability. The ampersand (`&`) is replaced with the word `and`, and spaces at the start and end of a name are removed.

## Object names must be unique in the project

Every object in a project (a construction stage, a pier stem, a material, a section and so on) is identified by its name, so no two objects can share one. When you type a name in the spreadsheet, OpenBrIM first replaces the illegal characters above, then changes the name again if it still cannot be used:

| What you type                                                                                     | What happens                                                 | Example                                                                                                                        |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| A name another object in the project already has, of any type                                     | The smallest number that makes it unique is added to the end | `Pier 1` becomes `Pier_1`; if an object named `Pier_1` already exists (for example the pier stem itself), it becomes `Pier_11` |
| A name that starts with a digit                                                                   | The name is replaced with `NewObj` plus a number             | `1Pier` becomes `NewObj1`                                                                                                      |
| The name of an analysis object type (such as `Node`, `Material` or `Section`), in any letter case | A number is added to the end                                 | `node` becomes `node1`                                                                                                         |
| The name of a parameter used by an object of the workflow                                         | A number is added to the end                                 |                                                                                                                                |

So if a name keeps changing to the same text followed by a number, the name is already taken. Give the object a name no other object uses: for example, name the construction stage `Pier1_Stage` rather than reusing the pier's own name.

## Project names

Project names follow a lighter rule: spaces, hyphens, parentheses, commas and `%` are allowed. The characters `'` `\` `/` `|` `?` `*` `+` `<` `>` `:` `.` `@` and `"` are replaced with an underscore, and `&` with `and`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openbrim.org/faq/general/faq-illegal-chars.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
