Skip to content

Commit

Permalink
Deployed 5b84d11 with MkDocs version: 1.4.2
Browse files Browse the repository at this point in the history
  • Loading branch information
mjordan committed Jan 14, 2024
1 parent 7ed2409 commit 325d28a
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 17 deletions.
3 changes: 2 additions & 1 deletion changelog/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -968,6 +968,7 @@ <h1>Change log</h1>
<h3 id="main-branch-no-tagrelease">main branch (no tag/release)</h3>
<ul>
<li>January 14, 2024 (commit 5dfd657): Resolved <a href="https://github.com/mjordan/islandora_workbench/issues/731">issue 731</a> and <a href="https://github.com/mjordan/islandora_workbench/issues/732">issue 732</a>.</li>
<li>January 10, 2024 (commit 7d9aa0): Resolved <a href="https://github.com/mjordan/islandora_workbench/issues/606">issue 606</a>.</li>
<li>January 5, 2024 (commit c36cc5d): Resolved issue <a href="https://github.com/mjordan/islandora_workbench/issues/723">issue 723</a>.</li>
<li>January 2, 2024 (commit 248560b): Resolved issue <a href="https://github.com/mjordan/islandora_workbench/issues/726">issue 726</a>.</li>
<li>December 12, 2023 (commit 864be45): Merged @ajstanley's work on <a href="https://github.com/mjordan/islandora_workbench/pull/722">PR 722</a>.</li>
Expand Down Expand Up @@ -1069,7 +1070,7 @@ <h3 id="main-branch-no-tagrelease">main branch (no tag/release)</h3>
</ul>
<h3 id="documentation">Documentation</h3>
<ul>
<li>January 14, 2024: Added <code>promote</code> to the "<a href="https://mjordan.github.io/islandora_workbench_docs/fields/#base-fields">Base fields</a>" docs.</li>
<li>January 14, 2024: Added <code>promote</code> to the "<a href="https://mjordan.github.io/islandora_workbench_docs/fields/#base-fields">Base fields</a>" docs; updated "<a href="https://mjordan.github.io/islandora_workbench_docs/updating_media/">Updating media</a>.</li>
<li>January 2, 2024: Updated the docs on <code>allow_missing_files</code> and <code>perform_soft_checks</code>.</li>
<li>December 1, 2023: Updated the "<a href="https://mjordan.github.io/islandora_workbench_docs/updating_media/">Updating media</a>" docs.</li>
<li>November 28, 2023: Addressed issue <a href="https://github.com/mjordan/islandora_workbench/issues/713">713</a>; merged in @rosiel's https://github.com/mjordan/islandora_workbench_docs/pull/12.</li>
Expand Down
2 changes: 1 addition & 1 deletion fields/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1513,7 +1513,7 @@ <h3 id="base-fields">Base fields</h3>
<li><code>published</code>: Whether or not the node (and all accompanying media) is published. If present in <code>add_media</code> tasks, will override parent node's <code>published</code> value. Values in this field are either <code>1</code> (for published) or <code>0</code> (for unpublished). The default value for this field is defined within each Drupal content type's (and media type's) configuration, and may be determined by contrib modules such as <a href="https://www.drupal.org/project/workflow">Workflow</a>.</li>
<li><code>promote</code>: Whether or not the node is promoted to the site's front page. <code>1</code> (for promoted) or <code>0</code> (for not promoted). The default vaue for this field is defined within each Drupal content type's (and media type's) configuration, and may be determined by contrib modules such as <a href="https://www.drupal.org/project/workflow">Workflow</a>.</li>
</ul>
<p>All base fields other than <code>uid</code> can be included in <code>create</code> and <code>update</code> tasks.</p>
<p>All base fields other than <code>uid</code> can be included in both <code>create</code> and <code>update</code> tasks.</p>
<h3 id="content-type-specific-fields">Content type-specific fields</h3>
<p>These fields correspond directly to fields configured in Drupal nodes, and data you provide in them populates their equivalent field in Drupal entities. The column headings in the CSV file must match machine names of fields that exist in the target node content type. Fields' machine names are visible within the "Manage fields" section of each content type's configuration, here circled in red:</p>
<p><img alt="Field machine names" src="../images/field_machine_names.png" /></p>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.
22 changes: 8 additions & 14 deletions updating_media/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -657,8 +657,8 @@
</li>

<li class="md-nav__item">
<a href="#updating-any-plain-text-fields-attached-to-media" class="md-nav__link">
Updating any plain text fields attached to media
<a href="#updating-custom-fields-attached-to-media" class="md-nav__link">
Updating custom fields attached to media
</a>

</li>
Expand Down Expand Up @@ -986,8 +986,8 @@
</li>

<li class="md-nav__item">
<a href="#updating-any-plain-text-fields-attached-to-media" class="md-nav__link">
Updating any plain text fields attached to media
<a href="#updating-custom-fields-attached-to-media" class="md-nav__link">
Updating custom fields attached to media
</a>

</li>
Expand Down Expand Up @@ -1039,11 +1039,11 @@ <h1>Updating media</h1>
<li>Updating the set of track files attached to media</li>
<li>Updating the Media Use TIDs associated with media</li>
<li>Updating the published status of media</li>
<li>Updating any plain text fields in media (currently, updating other field types is not possible, but there is an open <a href="https://github.com/mjordan/islandora_workbench/issues/606">Github issue</a> for doing so)</li>
<li>Updating custom fields of any supported field type</li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Currently, <code>update_media</code> replaces existing field values with those in the input CSV file, and replaces existing files with those named in the CSV.</p>
<p>Currently, <code>update_media</code> tasks replace existing files with those named in the CSV.</p>
</div>
<h2 id="updating-files-attached-to-media">Updating files attached to media</h2>
<div class="admonition note">
Expand Down Expand Up @@ -1109,14 +1109,8 @@ <h2 id="updating-the-published-status-of-media">Updating the published status of
100,tRuE
101,0
</code></pre>
<h2 id="updating-any-plain-text-fields-attached-to-media">Updating any plain text fields attached to media</h2>
<p>To update any plain text fields attached to media, you must provide a CSV file with, at minimum, a <code>media_id</code> column and columns with the machine names of the plain-text fields you wish to update. Note that a "plain text field" must have one of the following field types
- List (text)
- Text (formatted)
- Text (formatted, long)
- Text (formatted, long, with summary)
- Text (plain)
- Text (plain, long)</p>
<h2 id="updating-custom-fields-attached-to-media">Updating custom fields attached to media</h2>
<p>To update custom fields attached to media, you must provide a CSV file with, at minimum, a <code>media_id</code> column and columns with the machine names of the fields you wish to update.</p>
<p>The <code>media_id</code> column should contain the ID of the media you wish to update, and the other columns should contain the values you wish to set for the fields. Here is an example CSV that updates the published status of some media:</p>
<pre><code class="language-text">media_id,name,field_my_custom_field
100,My Media,My Custom Value
Expand Down

0 comments on commit 325d28a

Please sign in to comment.