WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

TaggingRules
Copy to clipboard.
✖
TaggingRules

Copy to clipboard.
✖

is an option for selections that specifies a list of strings to be associated with a selection.

Details

  • TaggingRules provides a way of storing additional information with a selection, for example, to be used by other programs in processing a notebook. It can be set to a list of one or more strings.
  • With the default setting TaggingRules<||>, no additional information is associated with the selection.
  • Typically, structured metadata is broken up into pieces that can be identified using keys in the form "key"value. The key can then be individually queried using AbsoluteCurrentValue[obj,{TaggingRules,"key"}].
  • Another typical method for storing highly structured data is to use subkeys inside of keys. For example, "key"<|"key1"data1,"key2"data2,…|>. The subkeys can then be queried using AbsoluteCurrentValue[obj,{TaggingRules,"key","subkey"}]. Subkeys can have their own subkeys to an arbitrary depth.
  • TaggingRules can be set at the cell, notebook, and global level.
  • TaggingRules<|key1val1,…|> effectively merges the keyi with any keys inherited from a more general scope. The fully merged set of keys and values can be read using AbsoluteCurrentValue. Specifying keys and values as a list instead of an association will cause inherited keys to be ignored.

Examples

open allclose all

Basic Examples  (2)Summary of the most common use cases

Apply TaggingRules at the cell level:

Copy to clipboard.
In[1]:=1
✖
https://wolfram.com/xid/0n4l1iklrv2-yw7iot
Direct link to example
Out[1]=1

Use nested rules as TaggingRules:

Copy to clipboard.
In[2]:=2
✖
https://wolfram.com/xid/0n4l1iklrv2-i919l5
Direct link to example
Out[2]=2

Reference specific TaggingRules values using CurrentValue:

Copy to clipboard.
In[1]:=1
✖
https://wolfram.com/xid/0n4l1iklrv2-idkm39
Direct link to example
Out[1]=1

Reference nested values directly by using subselectors in CurrentValue:

Copy to clipboard.
In[2]:=2
✖
https://wolfram.com/xid/0n4l1iklrv2-fmij1u
Direct link to example
Out[2]=2

Scope  (5)Survey of the scope of standard use cases

Basic Uses  (3)

Apply TaggingRules at the notebook level:

Copy to clipboard.
In[1]:=1
✖
https://wolfram.com/xid/0n4l1iklrv2-uyuvmz
Direct link to example
Out[1]=1

Apply TaggingRules at the global level:

Copy to clipboard.
In[1]:=1
✖
https://wolfram.com/xid/0n4l1iklrv2-hjdufu
Direct link to example

Restore TaggingRules to its default value:

Copy to clipboard.
In[2]:=2
✖
https://wolfram.com/xid/0n4l1iklrv2-hjk4gc
Direct link to example

If a tagging rule key does not exist, CurrentValue returns Inherited for its value:

Copy to clipboard.
In[1]:=1
✖
https://wolfram.com/xid/0n4l1iklrv2-ead0md
Direct link to example
Out[1]=1

Inheritance  (2)

TaggingRules{} clears all rules at the scope at which it is set:

Copy to clipboard.
In[3]:=3
✖
https://wolfram.com/xid/0n4l1iklrv2-jlx2k
Direct link to example
Out[3]=3

TaggingRules specified as an Association will be merged with inherited rules:

Copy to clipboard.
In[1]:=1
✖
https://wolfram.com/xid/0n4l1iklrv2-fam92x
Direct link to example
Out[1]=1

Specifying the inner value as a list will ignore inherited rules:

Copy to clipboard.
In[2]:=2
✖
https://wolfram.com/xid/0n4l1iklrv2-dax7rz
Direct link to example
Out[2]=2

Rules with the same name but differing values will be overwritten upon inheritance:

Copy to clipboard.
In[1]:=1
✖
https://wolfram.com/xid/0n4l1iklrv2-csqa8
Direct link to example
Out[1]=1

If the value is an Association, then the associations are instead merged:

Copy to clipboard.
In[2]:=2
✖
https://wolfram.com/xid/0n4l1iklrv2-fd2dhi
Direct link to example
Out[2]=2

Applications  (1)Sample problems that can be solved with this function

TaggingRules can be used like a DynamicModule variable that spans cells:

Copy to clipboard.
In[1]:=1
✖
https://wolfram.com/xid/0n4l1iklrv2-npopao
Direct link to example
Copy to clipboard.
In[2]:=2
✖
https://wolfram.com/xid/0n4l1iklrv2-4z9ewu
Direct link to example
Out[2]=2
Copy to clipboard.
In[3]:=3
✖
https://wolfram.com/xid/0n4l1iklrv2-xvl25j
Direct link to example
Out[3]=3
Wolfram Research (1999), TaggingRules, Wolfram Language function, https://reference.wolfram.com/language/ref/TaggingRules.html (updated 2021).
Copy to clipboard.
✖
Wolfram Research (1999), TaggingRules, Wolfram Language function, https://reference.wolfram.com/language/ref/TaggingRules.html (updated 2021).

Text

Wolfram Research (1999), TaggingRules, Wolfram Language function, https://reference.wolfram.com/language/ref/TaggingRules.html (updated 2021).

Copy to clipboard.
✖
Wolfram Research (1999), TaggingRules, Wolfram Language function, https://reference.wolfram.com/language/ref/TaggingRules.html (updated 2021).

CMS

Wolfram Language. 1999. "TaggingRules." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2021. https://reference.wolfram.com/language/ref/TaggingRules.html.

Copy to clipboard.
✖
Wolfram Language. 1999. "TaggingRules." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2021. https://reference.wolfram.com/language/ref/TaggingRules.html.

APA

Wolfram Language. (1999). TaggingRules. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/TaggingRules.html

Copy to clipboard.
✖
Wolfram Language. (1999). TaggingRules. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/TaggingRules.html

BibTeX

@misc{reference.wolfram_2025_taggingrules, author="Wolfram Research", title="{TaggingRules}", year="2021", howpublished="\url{https://reference.wolfram.com/language/ref/TaggingRules.html}", note=[Accessed: 06-April-2025 ]}

Copy to clipboard.
✖
@misc{reference.wolfram_2025_taggingrules, author="Wolfram Research", title="{TaggingRules}", year="2021", howpublished="\url{https://reference.wolfram.com/language/ref/TaggingRules.html}", note=[Accessed: 06-April-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_taggingrules, organization={Wolfram Research}, title={TaggingRules}, year={2021}, url={https://reference.wolfram.com/language/ref/TaggingRules.html}, note=[Accessed: 06-April-2025 ]}

Copy to clipboard.
✖
@online{reference.wolfram_2025_taggingrules, organization={Wolfram Research}, title={TaggingRules}, year={2021}, url={https://reference.wolfram.com/language/ref/TaggingRules.html}, note=[Accessed: 06-April-2025 ]}