Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section


Column


Document Properties Marker
overridefalse


Short DescriptionTools from the projectdoc Toolbox to allow users to browse for information.
Doctypetopichide
NameSupport Browsing
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Documentation Gardener, Template Author, Author
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
namesprojectdoc Toolbox, Confluence, browse, search, link, dynamic links
propertyTags

hide
Iteration

Iteration
valuefocused

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType


Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesAdvanced Beginner
propertyLevel of Experience


Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide



Section
show-titlefalse
titleDescription

Finding information includes searching and browsing (see Finding without Searching for more information on information architecture) .

This tip shows the different tools provided by the projectdoc Toolbox PDAC1 to support users finding information by browsing.


Section
titleSummary


Section
titlePrerequisites



Column
width25%


Panel
titleContents

Table of Contents
maxLevel2
indent15px
stylenone



...

Section
titleAt Macro Level

Many macros of the PDAC1 support rendering links. Links can be set created dynamically or set manually.

Section
titleDynamic Linking

There are a couple of macros to support dynamic linking. Dynamic linking allows authors to define queries to list links to related documents.

The Display Table Macro allows

  1. to select properties and sections from the result set (select)
  2. define a query to match document (where)
  3. and define an order of the documents of the result (sort by)


The elements of the result set are rendered as links to related documents.

Similar to the Display Table Macro are

Tour
render-as-definition-listtrue
replace-title-with-nametrue



The Wiki Link Macro allows to render a link only if the target document actually exists.


Section
titleManual Linking

Links to related documents can also be hand-crafted. Since projectdoc allows to define document properties that may be helpful for users readers to see be rendered with the link to the document, the projectdoc Toolbox provides a set of macros to do so.

Tour
render-as-definition-listtrue
replace-title-with-nametrue




Tip Box
titleOne List to list them all

If you need to render links from manual and dynamic links in one list, use the Table Merger Macro.



...

Section
titleAt Document Level

At document level the projectdoc toolbox Toolbox allows to render links to point to other documents.

Section
titleDocument Properties

Document property value may be links to other documents. These documents often list all documents that link to them.

Caution Box

The value of a property must not be a dynamic link!

This is due to the fact that the value of a property is stored in the Lucene index at the time the page is saved. Dynamic linking is resolved at request time.


Section
titleStandard Types

Standard types, like Tags, Categories, Subjects allow to categorize documents – see Finding without Searching - applied! for details.

Note Box

Since version 9.x of the Core Doctypes, Tags, Categories, and Subjects also allow to define types. This allows authors to group standard types.



Section
titleType-specific Types

Further categoization is provided by type specific type using the Type Property (for instance Resource Type , Role Type , or Topic Type ) – again, see Finding without Searching - applied! for details.

Note Box

Each type can be organized by the standard types. Therefore Resource Type , Role Type , or Topic Type, too.



Section
titleParent Property

The Parent Property is a reference to the semantic parent of the document. This navigation option is often redundant since the breadcrumbs allow users to find the parent page quickly. The parent property may be useful when accessed for link rendering purposes.


Section
titleOther Properties

Properties often link to documents of other types.

Here are some examples:

This allows authors to define a web of documents that are easily navigateable by readers.

Note Box

Note that instances of every doctype may be used as a value for a property and therefore provide a navigation path from one document to another.




Section
titleDocument Sections

Besides links at any location of a document there are sections dedicated to list sets of references to other documents.

Tour
render-as-definition-listtrue
replace-title-with-nametrue




Since these sections are standard to each document, it is easy for readers to locate links to related documents.

...