Configuration options
Permissions
Bases: Enum
Options of permissions for resources and values:
PROJECT_SPECIFIC_PERMISSIONS
: the permissions defined on project level will be appliedOPEN
: the resource/value is visible for everyoneRESTRICTED
: the resource/value is only visible for project membersRESTRICTED_VIEW
: the resource/value is visible for everyone, but images are blurred/watermarked for non-project members
Examples:
resource = xmllib.Resource.create_new(
res_id="ID",
restype=":ResourceType",
label="label",
permissions=xmllib.Permissions.RESTRICTED,
)
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/config_options.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
|
NewlineReplacement
Bases: Enum
Options how to deal with \n
inside rich text values.
NONE
: don't modify the rich text (\n
will be lost, because it is meaningless in an XML file)PARAGRAPH
: replaceStart\nEnd
with<p>Start</p><p>End</p>
LINEBREAK
: replaceStart\nEnd
withStart<br/>End
Examples:
# setting the replacement options for newlines
resource = resource.add_richtext(
prop_name=":propName",
value="Start\n\nEnd",
newline_replacement=xmllib.NewlineReplacement.PARAGRAPH
)
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/config_options.py
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
|
PreDefinedLicense
Bases: StrEnum
Pre-defined licenses for assets (bitstream
and iiif-uri
):
CC_BY
: Attribution 4.0CC_BY_SA
: Attribution-ShareAlike 4.0CC_BY_NC
: Attribution-NonCommercial 4.0CC_BY_NC_SA
: Attribution-NonCommercial-ShareAlike 4.0CC_BY_ND
: Attribution-NoDerivatives 4.0CC_BY_NC_ND
: Attribution-NonCommercial-NoDerivatives 4.0AI_GENERATED
: AI-Generated Content - Not Protected by CopyrightUNKNOWN
: Unknown License - Ask Copyright Holder for PermissionPUBLIC_DOMAIN
: Public Domain - Not Protected by Copyright
Examples:
# adding a pre-defined license to a file
resource = resource.add_file(
filename="images/dog.jpg",
license=xmllib.PreDefinedLicense.PUBLIC_DOMAIN,
copyright_holder="Bark University",
authorship=["Bark McDog"],
)
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/config_options.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
|