Summary
References enclosed in curly (or square) brackets can be added as text to documents, allowing the creation of autolink hyperlinks so that users can select the hyperlink and be taken to the relevant target document or Opus 2 Transcript.
When running the Autolink tool, a Hyperlink Report would be created, listing all of the references found enclosed in the relevant bracket type, confirming if the hyperlink was successfully created or not.
The Autolink tool scans the OCR'd data of a document, finds text within the relevant bracket type and then attempts to match the references to metadata assigned to documents.
We've set out the formatting requirements and best practices for linking to both documents and transcripts, alongside information on our Hyperlink Overlay tool and the wider hyperlinking process.
We strongly recommend the parties provide an example document which should contain a few hyperlink formatted references. The Solution Operations team can then check the formatting and test the links, before the parties undertake the wider referencing exercise.
Contents
- Hyperlinking to Documents
- Hyperlinking to Transcripts
- Important Points to Note
- Hyperlink Overlay Feature
- Overall Hyperlinking Process
General Formatting Requirements
In order for our Autolink tool to successfully detect and link a hyperlink ready reference, it must be:
- OCR'd (text searchable);
- enclosed in curly (or square) brackets; and
- contain a reference value that matches metadata assigned to the target document or transcript exactly.
If the reference is not OCR'd or is not enclosed in a relevant bracket type, the Autolink tool will not be able to detect the need for a hyperlink and therefore a link will not be created, as well as the reference being omitted from the Hyperlink Report.
If the reference is OCR'd and is enclosed in a relevant bracket type, but the reference value does not match metadata assigned to the target document or transcript, the link will not be created but will be included in the Hyperlink Report, albeit detailed as 'Not Found'.
Hyperlinking to Documents
Hyperlinks can be made either to the general document or a specified page or page range:
- Referencing the General Document - When referencing the general document (rather than specifying a page), the hyperlink will open at page 1 by default and needs to be in one of the following formats:
- Opus 2 Pagination {Bundle/Tab} - {A/1} for Bundle A, Tab 1
- Document ID {Document ID} or Exhibit ID {Exhibit ID} - {C-001} for Document ID C-001
- Magnum ID {Magnum ID} - {M_000123} for Magnum ID M_000123
- Referencing a Specific Page or Page Range - Hyperlinks can be made to a page or page range so that when the link is selected, the specified page opens:
- Referencing a Page - Link to a specific individual page by including a forward slash and page value before the closing bracket.
- For example, {A/1/5} for Bundle A, Tab 1, Page 5 or {C-001/8} for Document ID C-001,Page 8.
- Referencing a Page Range - Link to a specific page range by including a forward slash and page range separated by a hyphen (-) before the closing bracket. When selecting the link, the first page in the range would open and the end of the range simply shows the end of the intended range.
- For example, {A/1/2-10} for Bundle A, Tab 1, Page 2-10 or {C-001/3-5} for Document ID C-001, pages 3-5.
- Referencing a Page - Link to a specific individual page by including a forward slash and page value before the closing bracket.
When viewing a document on the platform, users can quickly copy the pagination value (and other document stamps) in curly brackets to the clipboard by selecting the Link icon on the right of the purple toolbar and pressing the relevant value.
Hyperlinking to Transcripts
Hyperlinks can be made to either the general transcript or a specified page or page range:
- Referencing the General Transcript - When referencing the general transcript, the full reference needs to be populated and the Day reference must include the full value assigned on the platform i.e. {Day 3CMC3/14:7} or {Day 1LH1/120:15}.
- Day X, Page and Line {DayX/Page:Line} - {Day5/1:1} for Day 5, Page 1, Line 1.
- Day X and Page {DayX/Page:} - Whilst we recommend including a line value for clarity, the line value does not need to be included however the colon character (:) must.
- Day X, Page and Line {DayX/Page:Line} - {Day5/1:1} for Day 5, Page 1, Line 1.
- Referencing a Page Range - When referencing a page range, the range must be split out into two separate hyperlink ready references, being a reference for the first page in the range and another reference for the last page in a range. The references should be separated by a hyphen and with a space on either side of the character
- For example, {Day4/33:15} - {Day4/34:6} for
- Referencing a Line Range -
The format for cross-referencing to evidence given in the hearing and recorded in the transcript is {DayX/Page:Line} e.g. {Day4/33:15} for Day 4, Page 33, Line 15. Please note that the Day reference must include the full value assigned on the platform e.g. {Day 3CMC3/14:7} or {Day 1LH1/120:15};
- Referencing a Page Range - If you wish to refer to a page range within a transcript you need to include the first and last page of the range in separate curly brackets, separated by a hyphen and ensuring there is a space on either side of the character e.g. {Day4/33:15} - {Day4/34:6}.
- Referencing a Line Range - It is possible to refer to a line range by adding a hyphen (-) between the first and last lines e.g. {Day4/33:15-19}.
Transcript references must always contain a colon character (:) even if no line is specified.
References to transcripts on the platform should only be added to documents when all outstanding transcript amendments, if any, have been finalised as the references will be subject to change until all amendments have been actioned.
Important Points to Note
Please ensure that:
- There are no spaces within the curly bracket reference;
- Hyphens (-) are used when referring to page ranges and/or separating two references.
- En dashes (–) and em dashes (—) will not be identified by our tool. As such any references containing the characters will not be created and will subsequently be listed a broken links report provided by a member of the Solution Operations team.
- There is a space between references if you are listing them so that the tool can detect each individual reference e.g. {Day4/33:15} {B/2/22} {C/3/33}.
- Where punctuation is used to separate the references, the space also remains e.g. {Day4/33:15}, {B/2/22}, {C/3/33}.
- Any links to websites will be lost upon upload and need to be activated manually. The request to activate web links will need to be included in an instructional email to the team alongside their Bundle/Tab/Page locations for them to be identified and created with ease.
Hyperlink Overlay Feature
If your cross-references have been created based on a Document ID, Exhibit No. or Magnum ID, we are able to activate the “Hyperlink Overlay Feature”. In doing so, the right-hand margin of your hyperlinked documents will be automatically populated with the final hearing bundle references (Bundle/Tab/Page), meaning that it will not be necessary to update this information in the lead up to your hearing.
Overall Hyperlinking Process
We are happy to initially receive documents that do not have hyperlink ready references within them as these can then be replaced with updated copies at a later date. Once we have received the updated documents with the cross-references, we will replace them and run automated hyperlinking tool over them. Any hyperlinks enclosed within curly (or square) brackets that cannot be made will be listed in a broken links report. Please note, any user annotations made on the original document should be automatically transferred to the updated version during the replacement exercise, on the basis that the content of the new file is not substantially different from the existing file on the platform.
The broken hyperlinks can be addressed in two ways:
- The parties can amend the broken links in offline copies of the documents (please ensure this is carried out on the original copy of the document which does not have the Opus 2 pagination already on it). Once amended, we will then replace the documents on Opus 2 with the updated copy and re-run the hyperlinking tool. This will create any new hyperlinks identified. Please note that you will not be charged again for any pre-existing hyperlinks on the document.
- The parties can provide the correct reference and instruct us to create the hyperlink(s) manually. Please note that although the hyperlink will be directed to the correct document, the reference will not change on the face of the document.
Should the parties provide a replacement document where references already linked on the platform have been amended, the hyperlinking tool will not identify these as hyperlinks that need to be recreated. We will therefore need to be notified of any instances where this occurs in order for the outdated hyperlink to be removed and the newly updated hyperlink to be created.