diff --git a/app/assets/scripts/components/about/index.js b/app/assets/scripts/components/about/index.js index 38d21087..c6ee9e7d 100644 --- a/app/assets/scripts/components/about/index.js +++ b/app/assets/scripts/components/about/index.js @@ -1,4 +1,5 @@ import React from 'react'; +import styled from 'styled-components'; import App from '../common/app'; import { @@ -12,6 +13,14 @@ import { ContentBlock } from '../../styles/content-block'; import Prose from '../../styles/typography/prose'; import { Link } from '../../styles/clean/link'; +const DisclosureHeader = styled.h3` + display: inline; +`; + +const DisclosureContent = styled.p` + padding: 1rem 0rem 0rem 0rem; +`; + function About() { return ( @@ -27,10 +36,10 @@ function About() {

The Algorithm Publication Tool (APT)

APT is a prototype environment for use in writing, submitting, - and discovering Algorithm Theoretical Basis Documents (ATBDs). - The tool has been designed to make it easier to create and edit - new ATBDs for which all content is searchable. We welcome your - feedback. + discovering and accessing Algorithm Theoretical Basis Documents + (ATBDs). The tool has been designed to make it easier to create + and edit new ATBDs and discover ATBDs from within APT's + centralized repository.

@@ -46,65 +55,113 @@ function About() { Development Seed . Please use the feedback form to - send us your questions, thoughts, and comments. + send us your questions, thoughts, and comments. We welcome + feedback from all users!

-

FAQs

-

What is the APT?

-

- APT is an authoring tool that streamlines the writing, - publishing and maintenance process of ATBDs for NASA’s Earth - Science Division. APT is also a centralized repository of - submitted ATBDs for Earth Science users. Researchers and - scientists are required to use the tool to standardize ATBD - content and make it searchable for all interested data users. -

-

Why should I use the APT?

-

- If you are looking for an algorithm description, this is where - you will find publicly available ATBDs. The general public can - view all completed ATBDs without a user account and download - PDFs of the ATBDs. Historical ATBDs are not available at this - time. -

-

- If you are a researcher responsible for producing an ATBD, this - tool is used to write and submit your algorithm description so - that it can be located by others. APT has been designed to aid - with submitting your ATBD to a journal. -

-

Can the public use the APT?

- The public can freely view and download any completed ATBD as - HTML or PDF. No user account is needed. Only users required to - author or review an ATBD can obtain an authorized user account. -

-

How does the APT work?

-

- APT uses a standardized ATBD template that sets content - expectations for ATBDs and improves communication. A review - process is used to ensure all content quality. ATBD content is - stored as metadata making it completely machine readable, - searchable, and useful in other tools and services. + The available processes for ATBD creation are described on the{' '} + + Create a new ATBD page + + . Authors and collaborators have a choice to construct an ATBD + either using the APT authoring environment or using Google Docs, + Microsoft Word, or LaTeX templates. The process is slightly + different for each method.

+

FAQs

+
+ + What is the APT? + + + APT is an authoring tool that streamlines the writing, + publishing and maintenance process of ATBDs for NASA's + Earth Science Division. APT is also a centralized repository + of completed and submitted ATBDs for Earth Science users. + Researchers and scientists are required to use the tool or + templates to ensure creation of standardized ATBD content and + to provide searchable documents for all interested data and + algorithm users. + +
+
+ + Why should I use the APT? + + + If you are looking for an algorithm description, this is where + you will find publicly available ATBDs for NASA's Earth + Science Division. The general public can view and download all + completed ATBDs without a user account. Historical ATBDs are + not available at this time but will be added over time once + the interface is adapted to receive the documents. All APT + ATBDs have a DOI that can be used as metadata in data products + pertaining to the algorithm. + + + If you are a researcher responsible for producing an ATBD, + this tool is used to write and submit your algorithm + description so that it can be located by others. The APT + environment has been designed to aid with creating and + submitting your ATBD to a journal, if you choose. Use of the + APT templates for document creation ensures content is + standardized to improve discoverability and automated document + use. + +
+
+ + + Can the public use the APT? + + + + The public can freely view and download any completed ATBD as + a PDF file. No user account is needed. Only users required to + author, submit or review an ATBD can obtain an authorized user + account. + +
+
+ + How does the APT work? + + + APT uses a standardized ATBD template that sets content + expectations for ATBDs and improves communication and + completed document discoverability. A review process is used + to ensure that all content meets quality requirements. Within + the APT authoring environment, all ATBD content is stored as + metadata making it completely machine readable, searchable, + and useful in other tools and services. + + + If an author chooses to use APT templates for ATBD creation, + only the completed and approved PDF is submitted to APT. From + the APT environment, authors will provide needed metadata + about the document to ensure discovery of the document. + +

- For more detailed information about APT, please visit the{' '} - - User Guide for Authoring ATBDs using the Algorithm Publication - Tool (APT) - - . + For more detailed information about APT, check out the{' '} + User Guide + with the Algorithm Publication Tool (APT) .

-

- If you have questions, please submit them through the{' '} - feedback form. + If you have questions, please use the{' '} + feedback form + to communicate with the APT Curator.

diff --git a/app/assets/scripts/components/documents/document-download-menu.js b/app/assets/scripts/components/documents/document-download-menu.js index 7c016830..71c1ebcf 100644 --- a/app/assets/scripts/components/documents/document-download-menu.js +++ b/app/assets/scripts/components/documents/document-download-menu.js @@ -153,7 +153,9 @@ export default function DocumentDownloadMenu(props) { const result = await response.json(); saveAs(result.pdf_url, pdfFileName); - processToast.success('PDF downloaded successfully!'); + processToast.success( + 'PDF downloaded successfully! If the PDF did not open automatically, your browser may have blocked the download. Please make sure that popups are allowed on this site.' + ); return; } diff --git a/app/assets/scripts/components/documents/single-edit/step-references/references-manager.js b/app/assets/scripts/components/documents/single-edit/step-references/references-manager.js index 60af0c02..7e07a704 100644 --- a/app/assets/scripts/components/documents/single-edit/step-references/references-manager.js +++ b/app/assets/scripts/components/documents/single-edit/step-references/references-manager.js @@ -101,7 +101,7 @@ export default function ReferencesManager(props) { { - const { remove, push, form, name } = arrayHelpers; + const { remove, push, form, name, move } = arrayHelpers; const values = get(form.values, name); // Update the refs list. See note above @@ -172,6 +172,9 @@ export default function ReferencesManager(props) { { meta: e.metaKey || e.ctrlKey, shift: e.shiftKey } ); setRefsEditing(newSelection); + + // This is a hack to force the field to re-render + move(index, index); }} onDeleteClick={async () => { // If the reference is in use prompt the user for @@ -205,6 +208,9 @@ export default function ReferencesManager(props) { { meta: true, shift: e.shiftKey } ); setRefsSelected(newSelection); + + // This is a hack to force the field to re-render + move(index, index); }} /> ))} diff --git a/app/assets/scripts/components/home/index.js b/app/assets/scripts/components/home/index.js index c673632d..cff7b2e7 100644 --- a/app/assets/scripts/components/home/index.js +++ b/app/assets/scripts/components/home/index.js @@ -232,9 +232,10 @@ function Home() {
Easily create compliant and complete ATBDs using a - standardized template. The APT's centralized - location makes it simple to collaborate with the writing - team. + standardized template. Choose whether to create ATBDs + within the APT user interface or use familiar software + and word processors to create ATBDs using one of + APT's provided standardized templates.
@@ -246,8 +247,8 @@ function Home() {
Easily format text and add equations, tables, figures - and references using the APT's rich text editor, - LaTex tools and Bibtex citation manager. + and references using APT's rich text editor, LaTeX + tools and BibTeX citation manager.
@@ -268,9 +269,9 @@ function Home() { Straightforward journal submission
- Use a streamlined ATBD journal submission process with - AGU's Earth and Space Science, a gold open access - journal. + APT has a partnership with AGU's Earth and Space + Science, a gold open access journal, to simplify the + journal submission process of ATBDs.
diff --git a/app/assets/scripts/utils/references.js b/app/assets/scripts/utils/references.js index a4c3569a..8d884f80 100644 --- a/app/assets/scripts/utils/references.js +++ b/app/assets/scripts/utils/references.js @@ -219,7 +219,7 @@ export const formatReference = (reference, type = 'jsx') => { if (type === 'jsx') { return ( - {authorsStr} {yearStr} {titleStr} {seriesStr} {' '} + {authorsStr} {yearStr} {titleStr} {seriesStr} {' '} {volIssueStr} {pagesStr} {doiStr} );