Typically, an xref is a two-way link between a source and target document. The options for xrefs depend on the media type of the source and target, and the xref configuration. For PSML documents, the target destination can either be the whole document or a fragment.
The xref dialog lets you add or edit xrefs when editing a document.
It displays three possible views:
The Search view is the default when creating an xref.
The Edit view is the default when editing an existing xref.
Use the keyboard shortcut Control+K (or Command+K on MacOS) to open an xref dialog and insert an xref while editing a fragment.
The Configuration field drop-down lets you select the xref configuration for your xref. It defaults to the Default configuration which lets you select any target document anywhere and doesn’t restrict the values of any of the xref attributes.
Other xref configurations might be defined by a developer. The xref configuration can constrain both the target document and the attributes for the xref.
The target document might be constrained by document type, folder or group. These constraints affect the search and browse views. Specific search queries can also be predefined to help you find the correct target document.
If the xref configuration constrains any of the xref attributes such as the labels, type, display, and level of the xref, these constraints affect the Edit view.
When the target document or fragment is not yet selected, you can choose between two methods to set the target of the xref.
You can search for the target document or browse the folder structure to locate it. Then, you preview the document before you can set the target of the xref, which can be either the document or a fragment within that document.
You can swap between these two methods by clicking the
The current group shows in the field at the right of the dialog. Change the group name to see a list of other available groups to search or browse. Click a group in the list to select it.
If you target a document in a different group, it might not be accessible to users unless it is shared or they are also members of that group.
Click the
Searching is the default method to find your document, the dialog automatically opens to this view when creating an xref.
When the Search documents field is empty, the search view lists the most recently modified or created PSML documents in the group. Type the term in that field to list the auto-suggested results.
If you have selected some content in the editor, that text is used to initialize the value of this field and suggest documents that match the term.
The auto-suggested results are the documents that have words in their title, Document ID, filename, heading or prefixed paragraph that start with the term you entered. The search term is not case sensitive.
For example, if you type ‘acc’, it returns all the documents which match terms such as ‘access’ or 'account'.
This field also supports suggested filters for document types and labels.
For example, if you type ‘de’, it suggests that you filter your results with the document type ‘default’.
The xref configuration might specify different fields to search and different suggested filters.
If the term you’re looking for is only available in the content, click the checkbox to the right of the search box to suggest results doing a full-text search.
If you want to search documents in a different group, use the group field on the top right of the dialog.
The suggested results show the title and location of every matching document. If the document has a description, it is also shown. The last modified date is only displayed when no document is selected.
The matching term is highlighted. If you opted for the full-text search, the results include an extract of the content that includes the matching term.
The xref config might specify different fields that are displayed in the results.
Click a result to preview the document.
Use the browse view if you know where your target document is located or if you want to create a new document as the target.
This view shows the folder tree structure for the current group. If you want to browse the folders from a different group, use the group field on the top right of the dialog.
This view is initially set to the folder of the current document.
Use the
If the xref configuration constrains the target document then you can not select documents in browse but you might be able to create them.
Click a document title to preview that document.
The form to create a new document is displayed by default. Select the location you
want to create your document in by clicking a folder title in the folder tree structure.
Select the Document type and enter the document title of the document to create. If you want to enter additional details, click the
Click the Create button to display the new document in the preview.
If you click the Cancel button at the bottom, the creation of the xref is abandoned, but the document you have already created is kept.
Once you preview a document on the right side of the panel, you can select the target
for the xref. If you don’t want to reference this document, click the
When you select a document or the fragment, the dialog returns to the form to edit the attributes of the xref.
You can add a fragment to the preview document.
Click the
Enter the content for your new fragment then click the Create button.
Once you click the Create button, the fragment has been created in the target document, regardless of whether you abandon creating the xref.
Click the new fragment to select it as the target; the dialog returns to the form to edit the attributes of the xref.
You cannot edit an unresolved xref, but you can use the Browse or Search button to set a new target.
When a target document or fragment is selected, you see the document title of the target document at the top middle. If you have selected a fragment, the fragment number in the target document shows to the right of the document title.
You can select a different target document or fragment using the Search or Browse method.
Under the document title, in the middle, you see a link preview. In your source document:
The following fields are available for editing:
The choice in the Link title field is what you see in the source document.
In the Link title field, select an option from the drop-down:
{document}, {filename}, {docid}, {fragment}, {prefix}, {parentnumber}, or {heading}. Start typing one of these, then press
The {prefix}, {parentnumber} and {heading} variables can be used with each other but are not in the same title with other tokens
and can no be used with Link types Embed or Transclude.
In the Link type field, select from these types of links available in the drop-down:
In the Link level field, select an option from the drop-down:
The reverse xref title is the name of the xref from the perspective of the target document. The Reverse title field is required if the xref is to be a two-way link.
The name you enter in this field is seen in the source document, by clicking the
Clear the checkbox if you don’t want the link to be a (two-way) reverse link.
A label can be added to the xref by clicking an existing label or click the
The xref configuration might define a different set of labels to select from or predefine the labels.
When the preceding fields are completed, click the Save button at the bottom of the edit xref dialog to create the xref.
For a PSML document, when in document view in edit mode:
Or when editing an xref fragment with the xref list editor:
Or for a PDF or image document:
The PageSeeder user manual
© Allette Systems (Australia)