-
Notifications
You must be signed in to change notification settings - Fork 180
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DDF-2892 added template for appendix to docs (#2226)
- Loading branch information
Rick Larsen
authored
Aug 24, 2017
1 parent
7aed507
commit 450444c
Showing
35 changed files
with
2,866 additions
and
10 deletions.
There are no files selected for viewing
8 changes: 8 additions & 0 deletions
8
...ocs/src/main/jdocs/content/_appendix-intros/dependency-list-intro-contents.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
:title: Dependency List | ||
:type: appendixIntro | ||
:status: published | ||
:children: ${branding} Dependency List | ||
:order: 02 | ||
:summary: Introduction to dependency list appendix. | ||
|
||
This list of ${branding} dependencies is automatically generated: |
10 changes: 10 additions & 0 deletions
10
...src/main/jdocs/content/_appendix-intros/metadata-attributes-intro-contents.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
:title: Metadata Attributes | ||
:type: appendixIntro | ||
:status: published | ||
:children: Metadata Attributes, Catalog Taxonomy, All Formats Supported | ||
:order: 01 | ||
:summary: Introduction to metadata attributes. | ||
|
||
${branding} extracts basic metadata from the resources ingested. Many file types and contain additional <<_format_specific_attribute_mappings,format-specific metadata attributes>>. | ||
A neutral <<_catalog_taxonomy,Catalog Taxonomy>> enables transformation of metadata to other formats. | ||
See also a <<supported_file_types,list of all formats supported>> for ingest. |
8 changes: 8 additions & 0 deletions
8
...tion/docs/src/main/jdocs/content/_appendix-intros/whitelist-intro-contents.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
:title: Application Whitelists | ||
:type: appendixIntro | ||
:status: published | ||
:children: Application Whitelists | ||
:order: 00 | ||
:summary: Introduction to application whitelists. | ||
|
||
Within each ${branding} application, certain packages are exported for use by third parties. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 0 additions & 6 deletions
6
distribution/docs/src/main/jdocs/content/_data/mp4-attributes-contents.adoc
This file was deleted.
Oops, something went wrong.
36 changes: 36 additions & 0 deletions
36
.../jdocs/content/_metadata-attributes/associations-attributes-table-contents.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
:title: Associations | ||
:type: subappendix | ||
:parent: Catalog Taxonomy | ||
:status: published | ||
:summary: Attributes in this group represent associations between products. | ||
|
||
.[[_associations_attributes_table]]Associations: Attributes in this group represent associations between products. | ||
[cols="1,2,1,1,1" options="header"] | ||
|=== | ||
|
||
|Term | ||
|Definition | ||
|Datatype | ||
|Constraints | ||
|Example Value | ||
|
||
|metacard.associations.derived | ||
|ID of one or more metacards derived from this metacard. | ||
|List of Strings | ||
|A valid metacard ID (conventionally, a type 4 random UUID with hyphens removed). | ||
|70809f17782c42b8ba15747b86b50ebf | ||
|
||
|metacard.associations.related | ||
|ID of one or more metacards related to this metacard. | ||
|List of Strings | ||
|A valid metacard ID (conventionally, a type 4 random UUID with hyphens removed). | ||
|70809f17782c42b8ba15747b86b50ebf | ||
|
||
|associations.external | ||
|One or more URI's identifying external associated | ||
resources. | ||
|List of Strings | ||
|A valid URI. | ||
|https://infocorp.org/wikia/reference | ||
|
||
|=== |
14 changes: 14 additions & 0 deletions
14
...rc/main/jdocs/content/_metadata-attributes/catalog-taxonomy-intro-contents.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
:title: Catalog Taxonomy | ||
:type: appendix | ||
:status: published | ||
:parent: Metadata Attributes | ||
:children: Catalog Taxonomy | ||
:order: 02 | ||
:summary: Introduction to catalog taxonomy appendix. | ||
|
||
To facilitate data sharing while maximizing the usefulness of metadata, the attributes on resources are normalized into a common taxonomy that maps to attributes in the desired output format. | ||
|
||
[NOTE] | ||
==== | ||
The taxonomy is presented here for reference only. | ||
==== |
Oops, something went wrong.