Edit online

Contributed by: Radu Coravu

I tried to compile below a set of best practices to follow when reusing content:

  • Keep all your reused content in special topics located in special folders. Technical writers need to know that they are editing content which potentially is used in multiple contexts.
  • Keep a description for each reused element. You can have topics which act like dictionaries of reused content. A table of reused content can have two columns. On the first column each cell contains the reused element and on the second one you can have a small description for each reused element. The description acts as metadata, it may give the technical writer more details about how that content should be reused.
  • Use conkeyrefs instead of conrefs. Really, because they use relative paths conrefs always break when you move topics around. But more about conkeyrefs in the next section.
  • When using conkeyrefs you should create a special map with key definitions. This keeps the reused content and the keys for it separate from the live content.
https://blog.oxygenxml.com/presentation-reuse/reuse_tipcs.html
blog.oxygenxml.com
crawl=CC-MAIN-2020-29
24839
application/http; msgtype=response
sha1:EAHQCJ3TLNWOETUANDUOXKOGEZWFDZV5
<urn:uuid:09587a5c-ea7a-4222-83ff-aa3bc7ec2404>
2020-07-03T10:27:23Z
89.36.26.124
application/xhtml+xml
sha1:C252Y6KWFU6OIP7DU5IH6UAGFGQDPWUX
<urn:uuid:5065d2f6-53b7-4c9a-9e00-ee650a1a3a2d>
https://blog.oxygenxml.com/presentation-reuse/reuse_tipcs.html
response
<urn:uuid:2be9ba60-1254-4d53-8bf4-70a6476e58e4>
isPartOf: CC-MAIN-2020-29
publisher: Common Crawl
description: Wide crawl of the web for July 2020
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-190.ec2.internal
software: Apache Nutch 1.17 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.2-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/