Configure Automatic Pretty URL Generation - Fluid Topics - 3.8

Fluid Topics Configuration and Administration Guide
Category
Reference Guides
Audience
public
Version
3.8

In the Pretty URL administration interface, users with either the ADMIN or KHUB_ADMIN user role who also have the BETA_USER role can configure a rule engine that automatically generates pretty URLs for structured documents and topics. Fluid Topics displays these pretty URLs whenever a user shares a document's or topic's link in order to provide an at-a-glance preview of what the content is about.

Fluid Topics v3.8.25 introduces an improvement where Pretty URLs are available in the browser's address bar when a user consults content in the Reader page.



- The Pretty URL administration interface is currently in beta mode.

- There are no restrictions as to which metadata administrators can include in a pretty URL.

- For generated pretty URLs (as opposed to those defined manually in a control file or a source document), spaces and special characters are allowed when adding static text and metadata values. However, with the exception of underscores, periods, tildes and forward slashes, all special characters (including spaces) are transformed into hyphens in the rendered pretty URL. Additionally, any characters with accents entered as static text or in a metadata value are transformed into characters without accents in the rendered pretty URL.

- The Fluid Topics pretty URL generator takes into account the first metadata value indicated for each metadata key. For hierarchical metadata, the generator takes into account the last value of the first branch of the hierarchy. It is currently not possible to enter multiple values for the same metadata.

Selecting the Pretty URL tab in the Knowledge Hub section of the Administration menu displays the Pretty URL administration interface, which is composed of two sections as follows:

  • A section to define pretty URL templates for documents.
  • A section to define pretty URL templates for topics.

Configuration involves entering metadata and, if desired, adding static text.



- To separate sections, valid characters include a dash (-), an underscore (_) or a slash (/).

- It is possible to concatenate the metadata of all parent topics and current topics by using {parents-and-self.metadata}. As a result, the pretty URL will contain a breadcrumb with all levels of a document's hierarchy.

- In order for Fluid Topics to propose a pretty URL when users select Share URL in the topic shortcut menu, it is necessary to define at least one template in the topics section.

- For all templates, it is necessary to place metadata inside brackets.

- For topic templates, it is possible to reference the document's metadata with the document. prefix.



- Only content with all of the metadata defined in one of the templates will have a pretty URL.

- If an administrator defines a template in the Pretty URL administration interface and then modifies this template at a later date, this is likely to break pretty URLs which were automatically generated prior to the modification.

- Defining rules to automatically generate pretty URLs does not override any existing pretty URLs that were previously defined by means of a control file, a source document, or a web service.

Selecting the Save button displays the following pop-up:

Pretty URL reprocessing popup

Reprocessing can take a considerable amount of time if a lot of content has been published to the portal. Any content a user uploads while a reprocess job is underway is queued and processed after the reprocess job is complete.