context_full_paths
context_full_paths (arr, tag[, depth[, maxpaths[, oid[, pos]]]])
This function fills the array arr with a list of possible context paths to make the target element tag in context at the point in the document given by oid, pos. If one of the paths returned is an empty string, tag can be inserted at the specified position without any elements being added.
|
|
If you have applied an alias map to the document, tag can be an alias or a real name. However, this function will return an element's real name, not its alias.
|
If oid is omitted, the cursor position in the current document is used.
Depth specifies the maximum tag nesting depth of the paths returned. If depth is omitted, a depth of 5 is used.
Maxpaths specifies the maximum number of paths at each depth to return. It defaults to 50. If depth is 5, and maxpaths is 50, as many as 250 total paths could be returned. If more paths than maxpaths exist at a given depth, only the first maxpaths paths are returned, with no indication that more paths exist.
context_full_paths returns the number of paths stored in the array. Each path returned is expressed as a context string as formatted by the
context_string function. The array is ordered by path depth, with the shallowest paths first.
This function adds required sibling elements to the paths returned. For example, if the content model for chapter is (title, para*) and the cursor is positioned just inside a chapter tag, then context_full_paths(arr,"para") will return "title()". On the other hand, if the content model for chapter is (title*, para*), where the title is not required, then context_full_paths will return an empty string, because para is valid within chapter without any elements being added.
The siblings that are included do not add to the depth. For example, the following paths both have a depth of two:
"abstract("
"title()subtitle()abstract("
