Skip to content

docs: per-page scoped labels to fix cross-page :ref: resolution #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
petrkalina wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: per-page scoped labels to fix cross-page :ref: resolution #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9e7468
docs: per-page scoped labels for shared attributes (#cn, #dcmRulePrio…
petrkalina May 16, 2026
efaeb00
tools: add rewrite_labels.py used to apply the per-page label scoping
petrkalina May 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@

numfig = True

# Suppress duplicate-label warnings produced by stacked legacy labels
# (kept to preserve external URL anchors during the per-page label migration)
suppress_warnings = ['ref.label']

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down
4 changes: 4 additions & 0 deletions docs/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Introduction
************

.. _revision:
.. _introduction-revision:

Revision History
================
Expand All @@ -14,6 +15,7 @@ Revision History
5.29.2, "Jan 2, 2023", gz, Update Supported Storage SOP Classes and Transfer Syntaxes

.. _audience:
.. _introduction-audience:

Audience
========
Expand All @@ -26,6 +28,7 @@ in this document relate to the product's functionality, and how that functionali
that support compatible DICOM features.

.. _remarks:
.. _introduction-remarks:

Remarks
=======
Expand All @@ -48,6 +51,7 @@ of intended information. In fact, the user should be aware of the following impo
may facilitate the process of validation testing.

.. _terms:
.. _introduction-terms:

Terms and Definitions
=====================
Expand Down
78 changes: 52 additions & 26 deletions docs/networking/config/archiveAttributeCoercion.rst
View file
Open in desktop

Large diffs are not rendered by default.

42 changes: 28 additions & 14 deletions docs/networking/config/archiveAttributeCoercion2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,37 @@ Archive Attribute Coercion of received/sent DIMSE

"
.. _cn:
.. _archiveAttributeCoercion2-cn:

:ref:`Name <cn>`",string,"Arbitrary/Meaningful name of the Archive Attribute Coercion
:ref:`Name <archiveAttributeCoercion2-cn>`",string,"Arbitrary/Meaningful name of the Archive Attribute Coercion

(cn)"
"
.. _dicomDescription:
.. _archiveAttributeCoercion2-dicomDescription:

:ref:`Attribute Coercion Description <dicomDescription>`",string,"Unconstrained text description of the Attribute Coercion
:ref:`Attribute Coercion Description <archiveAttributeCoercion2-dicomDescription>`",string,"Unconstrained text description of the Attribute Coercion

(dicomDescription)"
"
.. _dcmURI:
.. _archiveAttributeCoercion2-dcmURI:

:ref:`Attribute Coercion URI <dcmURI>`",string,"Identifies Attribute Coercion by Uniform Resource Identifier. Refer values you can set for `Attribute Coercion URI <https://github.com/dcm4che/dcm4chee-arc-light/wiki/New-Archive-Attribute-Coercion---Application-of-multiple-coercions-for-one-use-case-using-multiple-rules#attribute-coercion-uri>`_ field depending on the coercion type.
:ref:`Attribute Coercion URI <archiveAttributeCoercion2-dcmURI>`",string,"Identifies Attribute Coercion by Uniform Resource Identifier. Refer values you can set for `Attribute Coercion URI <https://github.com/dcm4che/dcm4chee-arc-light/wiki/New-Archive-Attribute-Coercion---Application-of-multiple-coercions-for-one-use-case-using-multiple-rules#attribute-coercion-uri>`_ field depending on the coercion type.

(dcmURI)"
"
.. _dcmCoercionSufficient:
.. _archiveAttributeCoercion2-dcmCoercionSufficient:

:ref:`Attribute Coercion Sufficient <dcmCoercionSufficient>`",boolean,"Do not apply other matching Attribute Coercions of lesser priority, if this Attribute Coercion was applied effectively.
:ref:`Attribute Coercion Sufficient <archiveAttributeCoercion2-dcmCoercionSufficient>`",boolean,"Do not apply other matching Attribute Coercions of lesser priority, if this Attribute Coercion was applied effectively.

(dcmCoercionSufficient)"
"
.. _dcmCoercionOnFailure:
.. _archiveAttributeCoercion2-dcmCoercionOnFailure:

:ref:`Attribute Coercion on Failure <dcmCoercionOnFailure>`",string,"Behavior on failure applying this Attribute Coercion. Refer `Attribute Coercion on Failure meanings. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/New-Archive-Attribute-Coercion---Application-of-multiple-coercions-for-one-use-case-using-multiple-rules#attribute-coercion-on-failure>`_
:ref:`Attribute Coercion on Failure <archiveAttributeCoercion2-dcmCoercionOnFailure>`",string,"Behavior on failure applying this Attribute Coercion. Refer `Attribute Coercion on Failure meanings. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/New-Archive-Attribute-Coercion---Application-of-multiple-coercions-for-one-use-case-using-multiple-rules#attribute-coercion-on-failure>`_

Enumerated values:

Expand All @@ -47,14 +52,16 @@ Archive Attribute Coercion of received/sent DIMSE
(dcmCoercionOnFailure)"
"
.. _dcmRulePriority:
.. _archiveAttributeCoercion2-dcmRulePriority:

:ref:`Attribute Coercion Priority <dcmRulePriority>`",integer,"If the condition of several archive attribute coercion (new) matches for a received image, higher priority coercion takes precedence. If there are several matching coercions with equal priority, it is undefined which coercion takes precedence.
:ref:`Attribute Coercion Priority <archiveAttributeCoercion2-dcmRulePriority>`",integer,"If the condition of several archive attribute coercion (new) matches for a received image, higher priority coercion takes precedence. If there are several matching coercions with equal priority, it is undefined which coercion takes precedence.

(dcmRulePriority)"
"
.. _dcmDIMSE:
.. _archiveAttributeCoercion2-dcmDIMSE:

:ref:`DIMSE <dcmDIMSE>`",string,"DICOM Message Element on which this Attribute Coercion shall be applied. Also `applicable if the requests are received over web. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/New-Archive-Attribute-Coercion---Application-of-multiple-coercions-for-one-use-case-using-multiple-rules#dimse>`_
:ref:`DIMSE <archiveAttributeCoercion2-dcmDIMSE>`",string,"DICOM Message Element on which this Attribute Coercion shall be applied. Also `applicable if the requests are received over web. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/New-Archive-Attribute-Coercion---Application-of-multiple-coercions-for-one-use-case-using-multiple-rules#dimse>`_

Enumerated values:

Expand All @@ -69,8 +76,9 @@ Archive Attribute Coercion of received/sent DIMSE
(dcmDIMSE)"
"
.. _dicomTransferRole:
.. _archiveAttributeCoercion2-dicomTransferRole:

:ref:`DICOM Transfer Role <dicomTransferRole>`",string,"DICOM Transfer Role of peer DICOM AE.
:ref:`DICOM Transfer Role <archiveAttributeCoercion2-dicomTransferRole>`",string,"DICOM Transfer Role of peer DICOM AE.

Enumerated values:

Expand All @@ -81,20 +89,23 @@ Archive Attribute Coercion of received/sent DIMSE
(dicomTransferRole)"
"
.. _dcmSOPClass:
.. _archiveAttributeCoercion2-dcmSOPClass:

:ref:`SOP Class UID(s) <dcmSOPClass>`",string,"UID of SOP Class for which this Attribute Coercion shall be applied. Apply on any if absent.
:ref:`SOP Class UID(s) <archiveAttributeCoercion2-dcmSOPClass>`",string,"UID of SOP Class for which this Attribute Coercion shall be applied. Apply on any if absent.

(dcmSOPClass)"
"
.. _dcmProperty:
.. _archiveAttributeCoercion2-dcmProperty:

:ref:`Condition(s) <dcmProperty>`",string,"Conditions in format {key}[!]={value}. Refer `applicability, format and some examples. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/Conditions>`_
:ref:`Condition(s) <archiveAttributeCoercion2-dcmProperty>`",string,"Conditions in format {key}[!]={value}. Refer `applicability, format and some examples. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/Conditions>`_

(dcmProperty)"
"
.. _dcmAttributeUpdatePolicy:
.. _archiveAttributeCoercion2-dcmAttributeUpdatePolicy:

:ref:`Attribute Update Policy <dcmAttributeUpdatePolicy>`",string,"Applied Attribute Update Policy. Only effective for coerce from Leading C-FIND SCP coercion type. Refer `Attribute Update Policies' meanings. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/Attribute-Update-Policy>`_
:ref:`Attribute Update Policy <archiveAttributeCoercion2-dcmAttributeUpdatePolicy>`",string,"Applied Attribute Update Policy. Only effective for coerce from Leading C-FIND SCP coercion type. Refer `Attribute Update Policies' meanings. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/Attribute-Update-Policy>`_

Enumerated values:

Expand All @@ -109,19 +120,22 @@ Archive Attribute Coercion of received/sent DIMSE
(dcmAttributeUpdatePolicy)"
"
.. _dcmSupplementFromDeviceReference:
.. _archiveAttributeCoercion2-dcmSupplementFromDeviceReference:

:ref:`Device Name Coercion Parameter <dcmSupplementFromDeviceReference>`",string,"Device Name Coercion Parameter. Only effective for supplementing from device coercion type.
:ref:`Device Name Coercion Parameter <archiveAttributeCoercion2-dcmSupplementFromDeviceReference>`",string,"Device Name Coercion Parameter. Only effective for supplementing from device coercion type.

(dcmSupplementFromDeviceReference)"
"
.. _dcmMergeAttribute:
.. _archiveAttributeCoercion2-dcmMergeAttribute:

:ref:`DICOM Attribute Coercion Parameters(s) <dcmMergeAttribute>`",string,"DICOM Attribute Coercion Parameters in format {attributeID}={value}. {attributeID} inside of {value} may be replaced by the value of that attribute in the original dataset. Only effective for merging attributes coercion type. Refer `DICOM Attribute Coercion Parameters <https://github.com/dcm4che/dcm4chee-arc-light/wiki/DICOM-Attribute-Coercion-Parameters>`_ for formatting options and examples.
:ref:`DICOM Attribute Coercion Parameters(s) <archiveAttributeCoercion2-dcmMergeAttribute>`",string,"DICOM Attribute Coercion Parameters in format {attributeID}={value}. {attributeID} inside of {value} may be replaced by the value of that attribute in the original dataset. Only effective for merging attributes coercion type. Refer `DICOM Attribute Coercion Parameters <https://github.com/dcm4che/dcm4chee-arc-light/wiki/DICOM-Attribute-Coercion-Parameters>`_ for formatting options and examples.

(dcmMergeAttribute)"
"
.. _dcmCoercionParam:
.. _archiveAttributeCoercion2-dcmCoercionParam:

:ref:`Other Coercion Parameters(s) <dcmCoercionParam>`",string,"Refer applicability to coercion types and examples in `Other Attribute Coercion specific Parameters <https://github.com/dcm4che/dcm4chee-arc-light/wiki/New-Archive-Attribute-Coercion---Application-of-multiple-coercions-for-one-use-case-using-multiple-rules#other-coercion-parameters>`_
:ref:`Other Coercion Parameters(s) <archiveAttributeCoercion2-dcmCoercionParam>`",string,"Refer applicability to coercion types and examples in `Other Attribute Coercion specific Parameters <https://github.com/dcm4che/dcm4chee-arc-light/wiki/New-Archive-Attribute-Coercion---Application-of-multiple-coercions-for-one-use-case-using-multiple-rules#other-coercion-parameters>`_

(dcmCoercionParam)"
18 changes: 12 additions & 6 deletions docs/networking/config/archiveCompressionRule.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,43 @@ Archive Compression rule

"
.. _cn:
.. _archiveCompressionRule-cn:

:ref:`Name <cn>`",string,"Arbitrary/Meaningful name of the Archive Compression Rule
:ref:`Name <archiveCompressionRule-cn>`",string,"Arbitrary/Meaningful name of the Archive Compression Rule

(cn)"
"
.. _dicomTransferSyntax:
.. _archiveCompressionRule-dicomTransferSyntax:

:ref:`DICOM Transfer Syntax UID <dicomTransferSyntax>`",string,"Transfer Syntax to which received images shall be compressed
:ref:`DICOM Transfer Syntax UID <archiveCompressionRule-dicomTransferSyntax>`",string,"Transfer Syntax to which received images shall be compressed

(dicomTransferSyntax)"
"
.. _dcmRulePriority:
.. _archiveCompressionRule-dcmRulePriority:

:ref:`Rule Priority <dcmRulePriority>`",integer,"If the condition of several Compression rules matches for a received image, the rule with the highest priority will get applied. If there are several matching rules with equal priority it is undefined which rule get applied.
:ref:`Rule Priority <archiveCompressionRule-dcmRulePriority>`",integer,"If the condition of several Compression rules matches for a received image, the rule with the highest priority will get applied. If there are several matching rules with equal priority it is undefined which rule get applied.

(dcmRulePriority)"
"
.. _dcmProperty:
.. _archiveCompressionRule-dcmProperty:

:ref:`Conditions(s) <dcmProperty>`",string,"Conditions in format {key}[!]={value}. Refer `applicability, format and some examples. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/Conditions>`_
:ref:`Conditions(s) <archiveCompressionRule-dcmProperty>`",string,"Conditions in format {key}[!]={value}. Refer `applicability, format and some examples. <https://github.com/dcm4che/dcm4chee-arc-light/wiki/Conditions>`_

(dcmProperty)"
"
.. _dcmImageWriteParam:
.. _archiveCompressionRule-dcmImageWriteParam:

:ref:`Image Write Param(s) <dcmImageWriteParam>`",string,"Image Write Parameter(s) (name=value) set at on Image Writer before compression
:ref:`Image Write Param(s) <archiveCompressionRule-dcmImageWriteParam>`",string,"Image Write Parameter(s) (name=value) set at on Image Writer before compression

(dcmImageWriteParam)"
"
.. _dcmCompressionDelay:
.. _archiveCompressionRule-dcmCompressionDelay:

:ref:`Compression Delay <dcmCompressionDelay>`",string,"Compression delay in ISO-8601 duration format PnDTnHnMn.nS. Compress on receive if absent.
:ref:`Compression Delay <archiveCompressionRule-dcmCompressionDelay>`",string,"Compression delay in ISO-8601 duration format PnDTnHnMn.nS. Compress on receive if absent.

(dcmCompressionDelay)"
Loading