XMetaL Author for SharePoint, Part 3 of n – Cross Referencing

[nhu1]

Cross Referencing

Xml documents and markdown documents on SharePoint server can reference each other.

[reference.mode] decides the format of the link value during link creation.

[reference.mode] can be configured via [Repositories -> XMSP–Configure Settings -> Linking].

• [reference.mode] value is saved in [%appdata%\SoftQuad\XMetaL Cms\SharePoint2\dat\xmetal_spo.json].

[reference.mode] can have one of the following four type values.  serverpathmode is the default value if value is not set.

• serverpathmode
  • /root_web/sub_web/doc_lib/folder/file.txt
  • When using serverpathmode, as long as [txt] does not move, any files that reference [file.txt] can be moved or copied independently without breaking the links.
  • The value is similar to local file path.
  • This mode does not apply to markdown document where a link has to be an URL. [relativemode] is automatically used instead.
• relativemode
  • txt
  • ./{…}/file.txt
  • ../{…}/file.txt
  • When using relativemode, both referencing and referenced documents can be moved or copied together (e.g., move a folder) without breaking the links.
  • The value is similar to local file path.
• idmode
  • https://server/root_web/sub_web/doc_lib/folder/file.txt
  • Similar to serverpathmode with server information recorded in the link value.
  • The value is in URL format.
• nixmode
  • /doc_lib/folder/file.txt
  • Similar to serverpathmode without web path part.
  • This type is for maintaining backward compatibility with previous versions of XMetaL-SharePoint integration.
  • This mode does not apply to markdown document where a link has to be an url. [relativemode] is automatically used instead.

A link can be inserted via drag-n-drop from Resource Manager or search results to an xml file or a markdown file.

• For example, DITA (xref-conref-topicref), Journalist(FileRef), docbook(xinclude).

A document can contain links with mixed formats.  However, this is not a recommended practice.

A document can reference another document in a different sub-web, document library or folder, as long as both documents belong to the same root-web/site-collection.

• A document cannot reference documents in a different root-web/site-collection.

Reply

[Author]

Posts