User:Eric/SourceAttributionGuidelines
From Motley Bytes Wiki
DRAFT DRAFT DRAFT
Contents
- 1 Source Attribution Guidelines and Recommendations
- 1.1 Tests
- 1.2 Tag Table
- 1.3 Inline References
- 1.4 Full Source Attribution
- 1.4.1 Full Source Attribution Design Principles
- 1.4.2 Full Source Attribution Hard Guidelines
- 1.4.3 Full Source Attribution Tags
- 1.4.3.1 Full Source Attribution Tag Overview
- 1.4.3.2 Full Source Attribution Tags for Things
- 1.4.3.3 Full Source Attribution Tags for Creators
- 1.4.3.4 Full Source Attribution Tags for Identifier Types
- 1.4.3.5 Full Source Attribution Tags for Comments
- 1.4.3.6 Full Source Attribution Tag Universal Qualifiers
- 1.4.4 Full Source Attribution Tag Chain Rules
- 1.4.5 Full Source Attribution Soft Recommendations
- 1.4.6 Full Source Attribution Examples
- 1.4.7 Full Source Attributions TBD
- 1.5 Reference and Full Source Examples
Source Attribution Guidelines and Recommendations
- Author: Eric Alan Christiansen.
- Version: 2.0 - 2024-12-12
Tests
- https://docs.google.com
/spreadsheets /d /1bDAyvUsLcUplj4I7dUl6 -zUMZ -Mbh6IQEjLQlvYUFrw /edit ?usp=sharing
Tag Table
| Tag | Lvl | Type | notes |
|---|---|---|---|
| sourceid | 00 | sourceid | |
| book | 10 | thing | |
| article | 10 | thing | |
| paper | 10 | thing | |
| essay | 10 | thing | |
| letter | 10 | thing | |
| notification | 10 | thing | |
| pressrelease | 10 | thing | |
| 10 | thing | ||
| textmessage | 10 | thing | |
| appmessage | 10 | thing | |
| fax | 10 | thing | |
| proverb | 10 | thing | |
| saying | 10 | thing | |
| note | 10 | thing | |
| memo | 10 | thing | |
| letter | 10 | thing | |
| sign | 10 | thing | |
| song | 10 | thing | |
| music | 10 | thing | |
| speech | 10 | thing | |
| conversation | 10 | thing | |
| interview | 10 | thing | |
| phonecall | 10 | thing | |
| phoneconf | 10 | thing | |
| videoconf | 10 | thing | |
| meeting | 10 | thing | |
| thought | 10 | thing | |
| script | 10 | thing | |
| play | 10 | thing | |
| dance | 10 | thing | |
| chant | 10 | thing | |
| video | 10 | thing | |
| movie | 10 | thing | |
| series | 10 | thing | |
| episode | 10 | thing | |
| newsreport | 10 | thing | |
| statement | 10 | thing | |
| podcast | 10 | thing | |
| youtube | 10 | thing | |
| engraving | 10 | thing | |
| ad | 10 | thing | |
| rally | 10 | thing | |
| conference | 10 | thing | |
| something | 12 | thing.other | Other thing. |
| anthology | 15 | thing.qual | |
| documentary | 15 | thing.qual | |
| fiction | 15 | thing.qual | |
| nonfiction | 15 | thing.qual | |
| author | 20 | creator | |
| speaker | 20 | creator | |
| writer | 20 | creator | |
| writer | 20 | creator | |
| composer | 20 | creator | |
| songwriter | 20 | creator | |
| lyricist | 20 | creator | |
| attendees | 20 | creator | |
| director | 20 | creator | |
| producer | 20 | creator | |
| investor | 20 | creator | |
| creator | 22 | creator.other | Other creator. |
| comment | 99 | comment |
Inline References
This section contains guidelines and recommendations for short embedded in-text reference pointers to a full source attribution somewhere else in the document. In this document we call these “inline references”.
Inline Reference Design Principles
- Inline references may be optionally used instead of footnote/endnote number or symbols. This might be useful if an authoring system does not support automatic renumbering or if minimal source information (such as authorship or date) is desirable to embed in primary text.
- Inline references should be relatively short and not distract unduly from the surrounding text.
- Inline references should be sufficiently complete so that cut-and-paste repositioning of text does not necessitate updates to the inline reference.
- Inline reference should be easily identified by human or computer parsing, including a logical link to a full attribution.
Inline Reference Hard Guidelines
Inline Reference Soft Recommendations
Inline Reference Examples
Inline Reference TBD
- TBD
- use of page numbers or chapter in inline references.
- use of italics, bold, etc.
Full Source Attribution
This section contains guidelines and recommendations for full source attributions. These are generally called “full attributions” or “full source attributions” or “full source” in this document.
Full Source Attribution Design Principles
- The text to which the full attribution applies should be clear either by position or by inline reference identifier.
- Meaning is not dependent on source decorations such as italics, bold, underline, or color, although these may optionally be used to enhance human intuitive understanding.
- Tags are used to annotate source attribution elements.
- Element order is significant, but flexible.
Full Source Attribution Hard Guidelines
- Core identifying inline reference, if used, should be the first element. Enclosing identifier brackets [ and ], if any, are optional.
- Elements are separated by semicolons.
- Tags are enclosed between square bracket, [ and ].
- Within a tag, supplemental information is separated by a forward slash / character.
- If a special character such as "[","]",";","/" is part of source information rather than an element parsing special character, it must be enclosed between squiggle brackets "{" and "}".
- Extended unicode double quotes “” and single quotes ‘’ should generally only be used by to enclose element information. Outermost quotes on each elements content should normally be stripped by parsing software. Enclosed subquotes remain. Standard ASCII double quotes " and single quotes/apostrophes ' remain.
Full Source Attribution Tags
Full Source Attribution Tag Overview
- thing ...
- creator ...
- reporter ... (interviewer)
- dist ...
- location
- date
Full Source Attribution Tags for Things
- [book]
- [article]
- [paper]
- [essay]
- [letter]
- [email]
- [notification]
- [proverb]
- [sign]
- [note]
- [song]
- [music]
- [speech]
- [conversation]
- [interview]
- [spoken]
- [audio]
- [video]
- [movie]
- [engraving]
- [other]
- Thing Qualifiers (optional):
- [<thing>.anthology]
- [<thing>.documentary]
- [<thing>.fiction]
- [<thing>.nonfiction]
- [<thing>.mythology]
- [<thing>.religious]
- [<thing>.youtube]
- [<thing>.podcast]
- [<thing>.ad]
- Thing Qualifiers (optional):
Full Source Attribution Tags for Creators
- [author]
- [speaker]
- [director]
- [actor]
- [performer]
- [singer]
- [dancer]
- [producer]
- [composer]
- [lyricist]
- [choreographer]
- [designer]
- [painter]
- [illustrator]
- [creator]
- Creator Qualifiers (optional):
- [<creator>.person] -- multiple people separated by commas.
- [<creator>.organization]
- [<creator>.group]
- [<creator>.gender]
- [<creator>.ai]
- Creator Qualifiers (optional):
Full Source Attribution Tags for Identifier Types
- [name]
- [title]
- [isbn]
- [doi]
- [amzid]
- [id]
Full Source Attribution Tags for Comments
- [comment]
Full Source Attribution Tag Universal Qualifiers
- Multiple qualifiers may be specified separated by "." period dots.
- [<tag>.comment=...]
Full Source Attribution Tag Chain Rules
- Within [ and ] multiple tags may be specified is separated by forward slashes /.
Full Source Attribution Soft Recommendations
Full Source Attribution Examples
- Info Type Keywords:
- All keywords case insensitive.
- WrittenBy: | AuthoredBy: | Author: | Writter: | Authors: | Writers:
- Composer: | ComposedBy: | Arranger: | ArrangedBy:
- AttributedTo:
- ReportedBy:
- EnscribedBy:
- SaidBy: | SpokenBy:
- PerformedBy: | Performer: | Actor:
- Role: | Character:
- Book: | BookTitle: | Article: | ArticleTitle: | Video: | Audio: | Artifact:
- Volume: | Chapter: | Section: | Page:
- PublishedBy: | PubBy: | Pub:
- PublishedDate: | PubDate: | PublishedDates: | PubDates:
- Date: | Dates
- PublisherLocation: | PubLoc:
- WrittenDate: | SpokenDate:
- Edition:
- EditedBy: | EdBy:
- RelatedTo:
- Media: | MediaName:
- Channel: | Provider:
- MediaType:
- Book,Video,Audio,SpokenWord,WebPage,WebVideo,WebDoc,WebPdf...
- All keywords case insensitive.
Full Source Attributions TBD
italics omit page/chapter references. clarity over brevity intuitive and easy to use computer parsing friendly adaptable to multiple languages
Reference and Full Source Examples
- [Smith,1910] | {Smith,1910}
- [Smith,1910]. Book: Fun Math. Author: Bob Smith. PubDate: 1910. PubName: {Fun Press, Inc.}. PubLoc: New York, NY.
[Smith,1910].
Bob Smith [author];
Fun Math [book];
1910 [pubdate]; Fun Press, Inc. [pub]; New York, NY [publoc];
<https://www.dummy.com/a_page> [url];
2024-12-24 [postdate]; 2025-01-02 [fetchdate];
- Patterns:
- who,bookname,pubdate,pub,publoc
- what,...
- <name>[author]