LinkServices

Services available for links. See document examples.

• LinkServices
  • String.asBookmark(String) : org.obeonetwork.m2doc.element.MBookmark
    • Parameter
    • Example
  • String.asBookmarkRef(String) : org.obeonetwork.m2doc.element.MBookmark
    • Parameter
    • Example
  • String.asLink(String) : org.obeonetwork.m2doc.element.MHyperLink
    • Parameter
    • Example

String.asBookmark(String) : org.obeonetwork.m2doc.element.MBookmark

Converts a String to a bookmark declaration

Parameter

• text: The label of the bookmark declaration
• id: The ID of the bookmark declaration

Example

• ‘Definition of Artifact1’.asBookmark(‘Art1’)
  • a bookmark with the ID ‘Art1’ the label ‘Definition of Artifact1’

String.asBookmarkRef(String) : org.obeonetwork.m2doc.element.MBookmark

Converts a String to a bookmark reference

Parameter

• text: The label of the bookmark reference
• id: The ID of the bookmark reference

Example

• ‘Artifact1’.asBookmarkRef(‘Art1’)
  • a bookmark reference with the ID ‘Art1’ the label ‘Definition of Artifact1’

String.asLink(String) : org.obeonetwork.m2doc.element.MHyperLink

Converts a String to an hyperlink

Parameter

• text: The label of the link
• url: The destination of the link

Example

• ‘My website’.asLink(‘https://www.example.org’)
  • a link to https://www.example.org with the label My website