updateBacklinks

Class: slreq.LinkSet
Namespace: slreq

Synchronize external navigation links

Since R2022a

expand all in page

Syntax

[checked,added] = updateBacklinks(myLinkSet)
[checked,added,removed] = updateBacklinks(myLinkSet,removeUnmatched)

Description

[checked,added] = updateBacklinks(myLinkSet) synchronizes the backlinks in external documents to match the links in the link set myLinkSet. The method returns the number of links in the link set that the method checked and the number of backlinks it added to the external document.

[checked,added,removed] = updateBacklinks(myLinkSet,removeUnmatched) removes backlinks from the external document that do not have a corresponding link in the link set when removeUnmatched is true. The method returns the number of backlinks removed from the external document.

Input Arguments

expand all

Link set, specified as an slreq.LinkSet object.

Option to remove the unmatched backlinks from the external document, specified as a 1 or 0 of data type logical.

Output Arguments

expand all

Number of links in the link set that the method checked, returned as a double.

Number of backlinks the method added to the external document, returned as a double.

Number of backlinks the method removed from the external document, returned as a double.

Examples

expand all

Open Live Script

This example shows how to update backlinks for a Microsoft® Word document by using updateBacklinks.

Open the crs_req_func_spec requirement set. The requirement set has outgoing links to the crs_req.docx document.

rs = slreq.open("crs_req_func_spec");
myLinkSet = slreq.find(Type="LinkSet",Name="crs_req_func_spec");

Update the backlinks for the external documents associated with the link set. Remove the unmatched backlinks from the external documents.

[checked,added,removed] = updateBacklinks(myLinkSet,true)
checked = 14

added = 4

removed = 1

Tips

To remove all forward links and the corresponding backlinks programmatically:

  1. Delete all of the links in the link set except for one by using the remove method.

  2. Save the link set by using the save method.

  3. Remove the stale backlinks by updating the backlinks.

  4. Navigate to the external requirement that has the last remaining backlink and interactively delete the backlink.

  5. Delete the remaining link by using the remove method.

  6. Save the link set by using the save method.

You can remove stale backlinks only when the link set contains at least one link. If the link set does not contain links, create a temporary link to the requirements document from which you want to remove backlinks, then remove the backlinks.

For more information on how to interactively remove all forward links and the corresponding backlinks, see Manage Navigation Backlinks in External Requirements Documents.

Alternatives

App

You can also update backlinks by using the Requirements Editor. For more information, see Manage Navigation Backlinks in External Requirements Documents.

Version History

Introduced in R2022a

See Also

Classes

Topics