Versions Compared

Key

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

...

Section
titleProperties


Section
titleDoctypes

Specify the type of the documents to select. If documents from more than one document type are to be selected, enumerate them in a comma-separated list. Leave blank to select documents from any doctypes.

If a property selected from a document is not supported by a doctype, a blank cell will be rendered.

Defaults to select Glossary Items.


Section
titleSelect


Section
titleWhere


Transclusion
documentTransclude Documents Macro
idsWhere




box-note
projectdoc-

Available since version 1.11.

projectdoc-section
titleHeader Translations



Section
titleCounter Column



Section
titleSpace Key


Section
titleSpace Keys


Section
titleRender Mode


Section
titleSeparator

The default separator for the index items specified in the body of this macro is the comma (','). The items may be specified on multiple lines, but each line is split by the commas in this line.

If your index entries have commas in their names, the separator may defined to something different than a comma. If you have one entry on each line, specify '\n' as a special separator. Note that a separator can only have one character. The special separator for newlines is an exception.

Note Box

Available since version 1.17.



Section
titleInsert Short Name Entries

If a value different to none is selected, an additional entry is added for each entry that has a short name or an abbreviation.

ValueDescription
noneNo additional values are added.
short-nameAdditional entry for the Short Name is added.
abbreviationAdditional entry for the Abbreviation is added.
allAdditional entry for Short Name and Abbreviation is added.

Additional entries render a link with a reference to the main entry (identified by the document name).


-boxversion
projectdoc
-
since1.15

Available since version 1.15.

Prior to version 4.5 the property value was a boolean supporting only short names.

projectdoc-section
titleRender Index

Render sections for index keys.

The elements associated with an index key are enclosed in an element and the index key is rendered.

CSS ClassDescription
div.projectdoc-indexThe block around the table of index entries.
span.projectdoc-indexThe text rendering the index key.

The default styles are:

Code Block
languagecss
div.projectdoc-index {
  margin-top: 2em;
}

span.projectdoc-index {
  font-size: larger;
  font-weight: bold;
}



Section
titleRender Index Access Panel

Render links to index keys above the index for quick access of the index key from the top of the page.

The value of this parameter is only taken into account, when Render Index is selected.

The default styles are:

Code Block
languagecss
div.projectdoc-index-access-panel {
    border-radius: 10px;
    border: 2px solid #036;
}

.projectdoc-index-access-panel ul {
    margin: 3px;
    padding: 3px;
    list-style-type: none;
    text-align: center;
}

.projectdoc-index-access-panel ul li {
    display: inline;
}

.projectdoc-index-access-panel ul li a {
    border-radius: 10px;
    text-decoration: none;
    padding: .2em 1em;
    color: white;
    font-weight: bold;
    background-color: #369;
}

.projectdoc-index-access-panel ul li a:visited {
    color: white;
    background-color: #369;
}

.projectdoc-index-access-panel ul li a:link {
    color: white;
    background-color: #369;
}

.projectdoc-index-access-panel ul li a:hover {
    color: white;
    background-color: #036;
}



Section
titleCaption



Section
titleNo Table Heading



Section
titleRestrict to immediate Children


Section
titleRender no hits as blank



Section
titleNo Hits Text



Section
titleIdentifier



Section
titleIdentifier Classes



Section
titleContext controlled



Section
titleRemote Controls



...

Section
titleDetails


Section
titleRemote Controlled Documents


Version Box

Remote Controlled Documents are available since version 2.0 of the projectdoc Toolbox.

Remote Controlled Documents allow to control the content at request time. A HTTP request may override parameters of the macro. A request parameter addresses a macro by its identifier. After the identifier the name of the parameter is appended, separated by a colon.

Example Box
titleOverride Parameters

Assume that the identifier of the macro is set to 'my', the following call will override the doctype parameter on the page 'MyPage' in space 'MYS'.

Code Block
confluence/display/MYS/MyPage?my:doctype=topic


The list of parameters allowed to override:

  • doctype
  • select
  • where
  • header-translations
  • render-counter-column
  • space-key
  • space-keys
  • separator
  • insert-short-names
  • render-index
  • render-index-access-panel
  • table-caption
  • suppress-table-heading
  • restrict-to-immediate-children
  • render-no-hits-as-blank
  • render-no-hits-as-blank-text


projectdoc-section
titleDebugging

If a term specified in the body of the macro does not exist, the term is simply dropped. This makes it difficult for long lists to identify missing term definitions.

If the space property 

Static Document Link
documentDebug Mode
is set to true, an error box is rendered that lists all undefined terms.

projectdoc-box-version
since34.112

This feature is available since version 4.12 of the projectdoc ToolboxSince version 3.1 these parameters can also be controlled by the context of the macro.




Section
indextrue
titleRelated macros

Display Table
doctypemacro
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
sort-bySort Key, Name
whereCategories = "Display / Query"
exclude-selftrue

...