Skip Navigation
Type MethodMethod

rowIdentifier(forPath:)

Returns the id of the row representing a documentation path.

static func rowIdentifier(forPath path: String) -> String

Parameters

path

The documentation path of the row.

Return Value

The row identifier.

Discussion

The identifier is rowIdentifierPrefix followed by the normalised path (see pagePathKey(_:)). Characters that are not safe to use verbatim in a URL fragment are percent-encoded, so the identifier can be appended to a URL as a fragment exactly as it appears in the id attribute.