Skip to content

Commit e598b93

Browse files
mergify[bot]williamkbentleycalebmshafer
authored
Use relative links instead of $docs syntax (backport #3291) (#3309)
* Use relative links instead of $docs syntax (#3291) * Use relative links instead of $docs syntax * Fix bad merge (cherry picked from commit 1b80b21) Co-authored-by: williamkbentley <[email protected]> Co-authored-by: Caleb Shafer <[email protected]>
1 parent b6cdb2f commit e598b93

40 files changed

+158
-159
lines changed

docs/changehistory/1.10.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ iModel.js will now perform smooth animations when changing between saved views,
1313
## IModel Transformation and Data Exchange
1414

1515
[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.
16-
See the [iModel Transformation and Data Exchange]($docs/learning/transformer/index.md) article for more information.
16+
See the [iModel Transformation and Data Exchange](../learning/transformer/index.md) article for more information.
1717

1818
## High-DPI display support
1919

docs/changehistory/1.5.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ version: '1.5.0'
1818
## Blank IModelConnections
1919

2020
- 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.
21-
- 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.
21+
- 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.
2222

2323
## Favorite Properties
2424

docs/changehistory/1.8.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ When the cursor moves over the icon, a set of *Logo Cards* with notices and logo
1616

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

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

2121
## View-independent Geometry
2222

docs/changehistory/2.11.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Note that [DisplayStyleSettings.addExcludedElements]($common) and [DisplayStyleS
198198

199199
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.
200200

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

203203
## Filtering in Property Grid
204204

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

297297
### Breaking changes to `ContentRelatedInstances`
298298

299-
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/Common-Rules/RelationshipPathSpecification.md) for more details and examples.
299+
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/Common-Rules/RelationshipPathSpecification.md) for more details and examples.
300300

301301
Example:
302302

docs/changehistory/2.12.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Updated recommended version of Electron from 10.1.3 to 11.1.0. Note that Electro
1717

1818
## IpcSocket for use with dedicated backends
1919

20-
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.
20+
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.
2121

2222
## External textures
2323

docs/changehistory/2.13.0.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@ Presentation.initialize({
170170
### Accessing selection in instance filter of content specifications
171171
172172
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
173-
using [ContentInstancesOfSpecificClasses specification]($docs/presentation/content/ContentInstancesOfSpecificClasses.md) with an instance filter that makes use
174-
of the newly added [SelectedInstanceKeys]($docs/presentation/content/ECExpressions.md#instance=filter) ECExpression symbol. Example:
173+
using [ContentInstancesOfSpecificClasses specification](../presentation/content/ContentInstancesOfSpecificClasses.md) with an instance filter that makes use
174+
of the newly added [SelectedInstanceKeys](../presentation/content/ECExpressions.md#instance=filter) ECExpression symbol. Example:
175175
176176
```json
177177
{
@@ -198,7 +198,7 @@ Previously this was not possible, because there is no ECRelationship between `EC
198198
199199
### ECInstance ECExpression context method enhancements
200200
201-
Added lambda versions for [ECInstance ECExpression context]($docs/presentation/Advanced/ECExpressions.md#ecinstance) methods: `GetRelatedInstancesCount`,
201+
Added lambda versions for [ECInstance ECExpression context](../presentation/Advanced/ECExpressions.md#ecinstance) methods: `GetRelatedInstancesCount`,
202202
`HasRelatedInstance`, `GetRelatedValue`. This allows using those methods without the need of an ECRelationship between "current" ECInstance
203203
and related ECInstance. Example:
204204
@@ -221,4 +221,3 @@ and related ECInstance. Example:
221221
```
222222
223223
The above example returns `ECDbMeta:ECClassDef` instances only if there are `BisCore:Elements` of those classes.
224-

docs/changehistory/2.15.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Clip volumes now nest. For example, if you define a view clip, a model clip grou
2323

2424
## Txn monitoring
2525

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

2828
- [TxnManager.onModelsChanged]($backend) for changes to the properties of [Model]($backend)s and
2929
- [TxnManager.onModelGeometryChanged]($backend) for changes to the geometry contained within [GeometricModel]($backend)s.

docs/changehistory/2.16.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,15 +100,15 @@ instance. The related instance, possibly being a of a different ECClass, might h
100100

101101
### Custom category renderers
102102

103-
[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).
103+
[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).
104104

105105
### Custom category nesting
106106

107-
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).
107+
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).
108108

109109
### Presentation rule schema requirements
110110

111-
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.
111+
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.
112112

113113
## Promoted APIs
114114

docs/changehistory/2.17.0.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Within [IpcApp]($frontend)-based applications, [BriefcaseConnection]($frontend)s
3030
## Reality model APIs
3131

3232
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:
33+
3334
* Adding to the [ViewState]($frontend)'s [ModelSelector]($backend) the Id of a persistent [SpatialModelState]($frontend) containing a URL pointing to a 3d tileset; or
3435
* Attaching to the [DisplayStyleState]($frontend) a [ContextRealityModel]($common) with a URL pointing to a 3d tileset.
3536

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

4647
## Popout Widgets
4748

48-
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.
49+
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.
4950

5051
## External textures
5152

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

6869
## ECClass Ids in changed events
6970

70-
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.
71+
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.
7172

7273
## Presentation
7374

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

108109
In addition, new protected static methods were added:
110+
109111
* [Element]($backend) `[onChildInsert, onChildInserted, onChildUpdate, onChildUpdated, onChildDelete, onChildDeleted, onChildAdd, onChildAdded, onChildDrop, onChildDropped]`
110112

111113
### [@itwin/webgl-compatibility](https://www.itwinjs.org/reference/webgl-compatibility/)
@@ -144,4 +146,3 @@ To make it easier to use async APIs while exporting a schema, [IModelExportHandl
144146
[IModelTransformer.shouldExportSchema]($transformer) now gets a [SchemaKey]($ecschema-metadata) schema key as argument, instead of a full [Schema]($ecschema-metadata). If you
145147
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
146148
return early.
147-

0 commit comments

Comments
 (0)