"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _reactBootstrap = require("react-bootstrap");
var _react = _interopRequireDefault(require("react"));
var _entity = require("../../helpers/entity");
/*
* Copyright (C) 2015 Ben Ockmore
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/* eslint-disable max-len */
/**
* Renders the document and displays the 'Help' page.
* @returns {ReactElement} a HTML document to display the Develop page
*/
function HelpPage() {
var IRCLink = 'https://kiwiirc.com/nextclient/irc.libera.chat/?#bookbrainz';
var userGuideLink = 'https://bookbrainz-user-guide.readthedocs.io/';
return /*#__PURE__*/_react.default.createElement("div", null, /*#__PURE__*/_react.default.createElement("div", {
className: "page-header"
}, /*#__PURE__*/_react.default.createElement("h1", null, "Help page")), /*#__PURE__*/_react.default.createElement("p", {
className: "lead"
}, "Feeling lost? On this page you will find explanations of the basic concepts used across BookBrainz, as well as an F.A.Q and a glossary.", /*#__PURE__*/_react.default.createElement("br", null), "Still having some trouble with something? You can refer to the ", /*#__PURE__*/_react.default.createElement("a", {
href: userGuideLink
}, "user guide and documentation"), ", or come ask us directly on our ", /*#__PURE__*/_react.default.createElement("a", {
href: IRCLink
}, "IRC channel"), "."), /*#__PURE__*/_react.default.createElement("hr", null), /*#__PURE__*/_react.default.createElement("h2", null, "Entities"), /*#__PURE__*/_react.default.createElement("p", null, "Entities are the main concepts used to describe a bibliographic record through their relationships"), /*#__PURE__*/_react.default.createElement(_reactBootstrap.Row, null, /*#__PURE__*/_react.default.createElement(_reactBootstrap.Col, {
lg: 6
}, /*#__PURE__*/_react.default.createElement("img", {
alt: "Entity relationships",
className: "img-fluid center-block",
src: "/images/entity_relationships.svg"
})), /*#__PURE__*/_react.default.createElement(_reactBootstrap.Col, {
className: "margin-top-2",
lg: 6
}, /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup, null, /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, (0, _entity.genEntityIconHTMLElement)('Author'), "Author"), " \u2013 an individual, group or collective that participates in the creative process of an artistic work. It also includes translators, illustrators, editors, etc."), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, (0, _entity.genEntityIconHTMLElement)('Work'), "Work"), " \u2013 a distinct intellectual or artistic creation expressed in words and/or images. Here we are not talking, for example, about a physical book, but the introduction, story, illustrations, etc. it contains.", /*#__PURE__*/_react.default.createElement("ul", null, /*#__PURE__*/_react.default.createElement("li", null, "Examples: novel, poem, translation, introduction & foreword, article, research paper, etc."))), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, (0, _entity.genEntityIconHTMLElement)('Series'), "Series"), " \u2013 a set or sequence of related works, editions, authors, publishers or edition-groups.", /*#__PURE__*/_react.default.createElement("ul", null, /*#__PURE__*/_react.default.createElement("li", null, "Examples: a series of novels, a series of comics, etc."))), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, (0, _entity.genEntityIconHTMLElement)('Edition'), "Edition"), " \u2013 a published physical or digital version of one or more Works.", /*#__PURE__*/_react.default.createElement("ul", null, /*#__PURE__*/_react.default.createElement("li", null, "Examples: book, anthology, comic book, magazine, leaflet"), /*#__PURE__*/_react.default.createElement("li", null, "Note: An Author can self-publish an Edition"))), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, (0, _entity.genEntityIconHTMLElement)('EditionGroup'), "Edition Group"), " \u2013 a logical grouping of different Editions of the same book.", /*#__PURE__*/_react.default.createElement("ul", null, /*#__PURE__*/_react.default.createElement("li", null, "Example: paperback, hardcover and e-book editions of a novel"))), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, (0, _entity.genEntityIconHTMLElement)('Publisher'), "Publisher"), " \u2013 publishing company or imprint"))), /*#__PURE__*/_react.default.createElement(_reactBootstrap.Col, {
lg: 12
}, /*#__PURE__*/_react.default.createElement("h4", null, "Examples"), /*#__PURE__*/_react.default.createElement("p", null, "The following examples should help you understand the different entities and how they relate to each other:", /*#__PURE__*/_react.default.createElement("br", null), "The relationship between ", /*#__PURE__*/_react.default.createElement("a", {
href: "/author/ac59097e-7f86-436d-9308-f6e63871ceff"
}, "H.P Lovecraft"), " , his short story ", /*#__PURE__*/_react.default.createElement("a", {
href: "/work/97eafaf5-377a-4703-a12e-d66a30fcfda1"
}, "At the Mountains of Madness"), " and an Edition ", /*#__PURE__*/_react.default.createElement("a", {
href: "/edition/b3ed75ea-9f74-44fa-833e-fa2c895c6b12"
}, "The Classic Horror Stories"), " which contain it and several more works.", /*#__PURE__*/_react.default.createElement("br", null), /*#__PURE__*/_react.default.createElement("a", {
href: "/edition/54331325-d11b-47f4-bb74-0485e582c52e"
}, "Paperback"), " and ", /*#__PURE__*/_react.default.createElement("a", {
href: "/edition/3fa9fdcd-098d-4ec1-82e4-f5fdfb92c41f"
}, "E-book"), " editions of the novel Ancillary Mercy by the publisher ", /*#__PURE__*/_react.default.createElement("a", {
href: "publisher/b065b24d-136f-45e3-badc-48aea4728c73"
}, "Orbit Books"), " making them part of the same ", /*#__PURE__*/_react.default.createElement("a", {
href: "/edition-group/540e9c4a-f9fa-427b-a41f-bb12c48f902b"
}, "Edition Group")), /*#__PURE__*/_react.default.createElement("hr", null))), /*#__PURE__*/_react.default.createElement(_reactBootstrap.Row, null, /*#__PURE__*/_react.default.createElement(_reactBootstrap.Col, {
lg: 12
}, /*#__PURE__*/_react.default.createElement("hr", {
className: "d-lg-none"
}), /*#__PURE__*/_react.default.createElement("h2", null, "Glossary"), /*#__PURE__*/_react.default.createElement("p", null, "Here is a short description of some of the main terms you will encounter. Some terms are borrowed from MusicBrainz; click on the term to be redirected to the MusicBrainz guidelines or a definition."), /*#__PURE__*/_react.default.createElement("br", null), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup, null, /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, /*#__PURE__*/_react.default.createElement("a", {
href: "https://musicbrainz.org/doc/Aliases"
}, "Aliases")), " \u2013 Variant names for an entity such as alternate spelling, different script, stylistic representation, acronyms, etc.", /*#__PURE__*/_react.default.createElement("br", null), "Example:", /*#__PURE__*/_react.default.createElement("ul", null, /*#__PURE__*/_react.default.createElement("li", null, "Name: \u6751\u4E0A \u6625\u6A39 \u2013 Alias (english): Haruki Murakami"), /*#__PURE__*/_react.default.createElement("li", null, "Name: J.K. Rowling \u2013 Alias (full name): Joanne Kathleen Rowling \u2013 Alias (pseudonym): Robert Galbraith"))), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, /*#__PURE__*/_react.default.createElement("a", {
href: "https://musicbrainz.org/doc/Style/Artist_Credits"
}, "Author Credits")), " \u2013 As appearing on the publication cover. For example, if the author is using a pseudonym, the credits should reflect that."), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, /*#__PURE__*/_react.default.createElement("a", {
href: "https://musicbrainz.org/doc/Disambiguation_Comment"
}, "Disambiguation")), " \u2013 Short comment added to differentiate between similarly-named entities.", /*#__PURE__*/_react.default.createElement("br", null), "Example:", /*#__PURE__*/_react.default.createElement("ul", null, /*#__PURE__*/_react.default.createElement("li", null, "The Alchemist (philosophical novel) by Paulo Coelho"), /*#__PURE__*/_react.default.createElement("li", null, "The Alchemyst (YA novel featuring Nicolas Flamel) by Michael Scott"))), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, "Entities"), " \u2013 Conceptual items representing the various authors and parts of a publication. See the previous Entities section for details."), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, /*#__PURE__*/_react.default.createElement("a", {
href: "https://en.wikipedia.org/wiki/Category:Book_formats"
}, "Format")), " \u2013 Refers to different printing and/or binding methods, or digital distribution.", /*#__PURE__*/_react.default.createElement("br", null), "For example: paperback, mass-market, hardcover and e-book are all book formats"), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, "Identifiers"), " \u2013 identity of an entity in other databases and services, such as ISBN, barcode, MusicBrainz ID, WikiData ID, etc.", /*#__PURE__*/_react.default.createElement("br", null), "When adding identifiers to an entity, you can enter either the identifier only (Q2517049) or a full link (https://www.wikidata.org/wiki/Q2517049)."), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, /*#__PURE__*/_react.default.createElement("a", {
href: "https://en.wikipedia.org/wiki/Edition_(book)#Printing,_print_run,_impression,_et_cetera"
}, "Printing, print run, impression")), " \u2013 A batch of identical copies of an edition of a work that is printed in a same, single production set-up.", /*#__PURE__*/_react.default.createElement("br", null), "One edition of a work may have any number of printings, e. g. a same Edition can have a first impression and a second impression."), /*#__PURE__*/_react.default.createElement(_reactBootstrap.ListGroup.Item, null, /*#__PURE__*/_react.default.createElement("b", null, /*#__PURE__*/_react.default.createElement("a", {
href: "https://musicbrainz.org/doc/Style/Artist/Sort_Name"
}, "Sort name")), " \u2013 Modified name to help sorting alphabetically", /*#__PURE__*/_react.default.createElement("br", null), "Example:", /*#__PURE__*/_react.default.createElement("ul", null, /*#__PURE__*/_react.default.createElement("li", null, "Charles Dickens -> Dickens, Charles"), /*#__PURE__*/_react.default.createElement("li", null, "A Tale of Two Cities -> Tale of Two Cities, A"), /*#__PURE__*/_react.default.createElement("li", null, "Benito P\xE9rez Gald\xF3s -> P\xE9rez Gald\xF3s, Benito")))))));
}
HelpPage.displayName = 'HelpPage';
var _default = HelpPage;
exports.default = _default;
//# sourceMappingURL=help.js.map