Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use relative links instead of $docs syntax #3291

Merged
merged 3 commits into from
Mar 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/changehistory/1.10.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ iModel.js will now perform smooth animations when changing between saved views,
## IModel Transformation and Data Exchange

[IModelExporter](https://www.imodeljs.org/v1/reference/imodeljs-transformer/imodels/imodelexporter), [IModelTransformer](https://www.imodeljs.org/v1/reference/imodeljs-transformer/imodels/imodeltransformer), and [IModelImporter](https://www.imodeljs.org/v1/reference/imodeljs-transformer/imodels/imodelimporter) are now beta and provide low-level functionality needed for iModel transformation and data exchange.
See the [iModel Transformation and Data Exchange]($docs/learning/transformer/index.md) article for more information.
See the [iModel Transformation and Data Exchange](../learning/transformer/index.md) article for more information.

## High-DPI display support

Expand Down
2 changes: 1 addition & 1 deletion docs/changehistory/1.5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ version: '1.5.0'
## Blank IModelConnections

- The new method `IModelConnection.createBlank` provides a way for applications to create an `IModelConnection` that is not connected to an iModel or a backend. This is useful for using iModel.js to show *just* Reality data (reality meshes, point clouds, terrain, etc.), background maps, and other non-iModel-based graphics without requiring a backend server.
- There is also a new convenience method [SpatialViewState.createBlank](https://www.imodeljs.org/v1/reference/imodeljs-frontend/imodelconnection/imodelconnection/#createblank) to create a *blank* spatial view appropriate for these non-iModel based visualizations. See the [Blank Connection]($docs/learning/frontend/BlankConnection.md) learning article for further details.
- There is also a new convenience method [SpatialViewState.createBlank](https://www.imodeljs.org/v1/reference/imodeljs-frontend/imodelconnection/imodelconnection/#createblank) to create a *blank* spatial view appropriate for these non-iModel based visualizations. See the [Blank Connection](../learning/frontend/BlankConnection.md) learning article for further details.

## Favorite Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/changehistory/1.8.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ When the cursor moves over the icon, a set of *Logo Cards* with notices and logo

If the user clicks or taps on the iModel.js icon, a modal dialog opens showing the logo cards.

See [Logo Cards]($docs/learning/frontend/LogoCards.md) for more information.
See [Logo Cards](../learning/frontend/LogoCards.md) for more information.

## View-independent Geometry

Expand Down
4 changes: 2 additions & 2 deletions docs/changehistory/2.11.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Note that [DisplayStyleSettings.addExcludedElements]($common) and [DisplayStyleS

In previous versions the method to open briefcases ([BriefcaseDb.open]($backend)) and standalone files (`StandaloneDb.open` renamed to `StandaloneDb.openFile`) provided options to upgrade the schemas in the iModel. This functionality has been now separated out, and there are separate methods to validate and upgrade the schemas in the iModel. As a result [OpenBriefcaseProps]($common) and [SnapshotOpenOptions]($common) do not include options to upgrade anymore.

See section on [Upgrading Schemas]($docs/learning/backend/IModelDb.md#upgrading-schemas-in-an-imodel) for more information.
See section on [Upgrading Schemas](../learning/backend/IModelDb.md#upgrading-schemas-in-an-imodel) for more information.

## Filtering in Property Grid

Expand Down Expand Up @@ -296,7 +296,7 @@ A property value renderer for instance key values has been added, which allows u

### Breaking changes to `ContentRelatedInstances`

Behavior of `ContentRelatedInstances` specification used in content rules was changed. It used to include input instances into the result if all paths in `relationshipPaths` property had `count: "*"` and target class matched input instance class. The behavior was changed to match cases where steps `relationshipPaths` have `count` set to specific number - the result only includes instances resulting from step outputs. See [RelationshipPathSpecification documentation]($docs/presentation/RelationshipPathSpecification.md) for more details and examples.
Behavior of `ContentRelatedInstances` specification used in content rules was changed. It used to include input instances into the result if all paths in `relationshipPaths` property had `count: "*"` and target class matched input instance class. The behavior was changed to match cases where steps `relationshipPaths` have `count` set to specific number - the result only includes instances resulting from step outputs. See [RelationshipPathSpecification documentation](../presentation/RelationshipPathSpecification.md) for more details and examples.

Example:

Expand Down
2 changes: 1 addition & 1 deletion docs/changehistory/2.12.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Updated recommended version of Electron from 10.1.3 to 11.1.0. Note that Electro

## IpcSocket for use with dedicated backends

For cases where a frontend and backend are explicitly paired (e.g. desktop and mobile apps), a more direct communication path is now supported via the [IpcSocket api]($docs/learning/IpcInterface.md). See the [Rpc vs Ipc learning article]($docs/learning/RpcVsIpc.md) for more details.
For cases where a frontend and backend are explicitly paired (e.g. desktop and mobile apps), a more direct communication path is now supported via the [IpcSocket api](../learning/IpcInterface.md). See the [Rpc vs Ipc learning article](../learning/RpcVsIpc.md) for more details.

## External textures

Expand Down
7 changes: 3 additions & 4 deletions docs/changehistory/2.13.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,8 @@ Presentation.initialize({
### Accessing selection in instance filter of content specifications

Added a way to create and filter content that's related to given input through some ID type of property that is not part of a relationship. That can be done by
using [ContentInstancesOfSpecificClasses specification]($docs/presentation/content/ContentInstancesOfSpecificClasses.md) with an instance filter that makes use
of the newly added [SelectedInstanceKeys]($docs/presentation/content/ECExpressions.md#instance=filter) ECExpression symbol. Example:
using [ContentInstancesOfSpecificClasses specification](../presentation/content/ContentInstancesOfSpecificClasses.md) with an instance filter that makes use
of the newly added [SelectedInstanceKeys](../presentation/content/ECExpressions.md#instance=filter) ECExpression symbol. Example:

```json
{
Expand All @@ -198,7 +198,7 @@ Previously this was not possible, because there is no ECRelationship between `EC

### ECInstance ECExpression context method enhancements

Added lambda versions for [ECInstance ECExpression context]($docs/presentation/Advanced/ECExpressions.md#ecinstance) methods: `GetRelatedInstancesCount`,
Added lambda versions for [ECInstance ECExpression context](../presentation/Advanced/ECExpressions.md#ecinstance) methods: `GetRelatedInstancesCount`,
`HasRelatedInstance`, `GetRelatedValue`. This allows using those methods without the need of an ECRelationship between "current" ECInstance
and related ECInstance. Example:

Expand All @@ -221,4 +221,3 @@ and related ECInstance. Example:
```

The above example returns `ECDbMeta:ECClassDef` instances only if there are `BisCore:Elements` of those classes.

2 changes: 1 addition & 1 deletion docs/changehistory/2.15.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Clip volumes now nest. For example, if you define a view clip, a model clip grou

## Txn monitoring

[TxnManager]($backend) now has additional events for monitoring changes to the iModel resulting from [Txns]($docs/learning/InteractiveEditing.md), including:
[TxnManager]($backend) now has additional events for monitoring changes to the iModel resulting from [Txns](../learning/InteractiveEditing.md), including:

- [TxnManager.onModelsChanged]($backend) for changes to the properties of [Model]($backend)s and
- [TxnManager.onModelGeometryChanged]($backend) for changes to the geometry contained within [GeometricModel]($backend)s.
Expand Down
6 changes: 3 additions & 3 deletions docs/changehistory/2.16.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,15 @@ instance. The related instance, possibly being a of a different ECClass, might h

### Custom category renderers

[VirtualizedPropertyGrid]($components-react) now allows developers to fully customize displayed category contents, if the category is assigned a custom renderer via Presentation Rules. You can read more about that in our [Category customization learning page]($docs/presentation/Customization/PropertyCategoryRenderers.md).
[VirtualizedPropertyGrid]($components-react) now allows developers to fully customize displayed category contents, if the category is assigned a custom renderer via Presentation Rules. You can read more about that in our [Category customization learning page](../presentation/Customization/PropertyCategoryRenderers.md).

### Custom category nesting

A new `parentId` attribute was added to [PropertyCategorySpecification]($presentation-common) to provide nesting abilities. See more details in our [property categorization page]($docs/presentation/Content/PropertyCategorization.md#category-nesting).
A new `parentId` attribute was added to [PropertyCategorySpecification]($presentation-common) to provide nesting abilities. See more details in our [property categorization page](../presentation/Content/PropertyCategorization.md#category-nesting).

### Presentation rule schema requirements

A new `requiredSchemas` attribute was added to [Ruleset]($presentation-common), [Rule]($presentation-common) and [SubCondition]($presentation-common) definitions. The attribute allows specifying ECSchema requirements for rules and avoid using them when requirements are not met. See the [schema requirements page]($docs/presentation/Advanced/SchemaRequirements.md) for more details.
A new `requiredSchemas` attribute was added to [Ruleset]($presentation-common), [Rule]($presentation-common) and [SubCondition]($presentation-common) definitions. The attribute allows specifying ECSchema requirements for rules and avoid using them when requirements are not met. See the [schema requirements page](../presentation/Advanced/SchemaRequirements.md) for more details.

## Promoted APIs

Expand Down
7 changes: 4 additions & 3 deletions docs/changehistory/2.17.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Within [IpcApp]($frontend)-based applications, [BriefcaseConnection]($frontend)s
## Reality model APIs

Several APIs relating to reality models have been introduced, in some cases replacing previous `beta` APIs. A reality model can be displayed in a [Viewport]($frontend) in one of two ways:

* Adding to the [ViewState]($frontend)'s [ModelSelector]($backend) the Id of a persistent [SpatialModelState]($frontend) containing a URL pointing to a 3d tileset; or
* Attaching to the [DisplayStyleState]($frontend) a [ContextRealityModel]($common) with a URL pointing to a 3d tileset.

Expand All @@ -45,7 +46,7 @@ A reality model displaying simple building meshes for locations all over the wor

## Popout Widgets

IModelApps, that use AppUi version "2", can now specify if a Widget can support being "popped-out" to a child popup window. The child window runs in the same javascript context as the parent application window. See [Child Window Manager]($docs/learning/ui/appui-react/ChildWindows.md) for more details.
IModelApps, that use AppUi version "2", can now specify if a Widget can support being "popped-out" to a child popup window. The child window runs in the same javascript context as the parent application window. See [Child Window Manager](../learning/ui/appui-react/ChildWindows.md) for more details.

## External textures

Expand All @@ -67,7 +68,7 @@ Disabling this feature is not recommended and will incur a performance penalty.

## ECClass Ids in changed events

The events [TxnManager.onElementsChanged]($backend) and [TxnManager.onModelsChanged]($backend) now include the Id of each changed entity's [ECClass]($docs/bis/intro/glossary/#ecclass). The [OrderedId64Array]($core-bentley) properties of [TxnChangedEntities]($backend) are deprecated in favor of the new [EntityIdAndClassIdIterable]($common) properties.
The events [TxnManager.onElementsChanged]($backend) and [TxnManager.onModelsChanged]($backend) now include the Id of each changed entity's [ECClass](../bis/intro/glossary/#ecclass). The [OrderedId64Array]($core-bentley) properties of [TxnChangedEntities]($backend) are deprecated in favor of the new [EntityIdAndClassIdIterable]($common) properties.

## Presentation

Expand Down Expand Up @@ -106,6 +107,7 @@ The arguments for the @beta protected static methods called during modifications
* [ElementAspect]($backend) `[onInsert, onInserted, onUpdate, onUpdated, onDelete, onDeleted]`

In addition, new protected static methods were added:

* [Element]($backend) `[onChildInsert, onChildInserted, onChildUpdate, onChildUpdated, onChildDelete, onChildDeleted, onChildAdd, onChildAdded, onChildDrop, onChildDropped]`

### [@itwin/webgl-compatibility](https://www.itwinjs.org/reference/webgl-compatibility/)
Expand Down Expand Up @@ -144,4 +146,3 @@ To make it easier to use async APIs while exporting a schema, [IModelExportHandl
[IModelTransformer.shouldExportSchema]($transformer) now gets a [SchemaKey]($ecschema-metadata) schema key as argument, instead of a full [Schema]($ecschema-metadata). If you
need to check the full schema, return `true` in shouldExportSchema and in [IModelExportHandler.onExportSchema]($transformer), you can use the schema object to check and then
return early.

Loading