diff --git a/README.md b/README.md index d2a93bd1c4ecda2ef2dfa8ba185d2a3dfa633505..d4549003bc656b5061462e47133d85e4e5f89303 100644 --- a/README.md +++ b/README.md @@ -157,7 +157,23 @@ can use them. ``` ## Documentation -Project documentation can be found in `docs` and can be rendered using +All project documentation is gathered from `.rst` files and code-embedded docstrings. +The documentation itself can be found in `docs`. + +### Sphinxdoc +The documentation is saved in the local database as a Project with name `SciPost` +(this project should be manually created in the admin under the `Sphinxdoc` app). + +To update the docs, simply run +```shell +(scipostenv) $ python3 ../manage.py updatedoc -b scipost +``` + +The documentation is then viewable by navigating to `docs/`. + + +### Locally-served +The documentation can be rendered using [Sphinx](http://www.sphinx-doc.org/). Note that rendering documentation is only available from the virtual environment - and only when the host settings have been configured. diff --git a/docs/contributors/contributors.rst b/docs/contributors/contributors.rst deleted file mode 100644 index a8de5a00fe9861ad6ba1ed60d219b6d1eebba549..0000000000000000000000000000000000000000 --- a/docs/contributors/contributors.rst +++ /dev/null @@ -1,9 +0,0 @@ -For Contributors -================ - - -.. toctree:: - :maxdepth: 2 - - editorial_fellows/editorial_fellows - editorial_administrators/editorial_administrators diff --git a/docs/contributors/editorial_fellows/editorial_fellows.rst b/docs/contributors/editorial_fellows/editorial_fellows.rst deleted file mode 100644 index 506d4173785b2206f943563ecafa68f4b0ae1a6c..0000000000000000000000000000000000000000 --- a/docs/contributors/editorial_fellows/editorial_fellows.rst +++ /dev/null @@ -1,2 +0,0 @@ -For Editorial Fellows -===================== diff --git a/docs/guides/guides.rst b/docs/guides/guides.rst new file mode 100644 index 0000000000000000000000000000000000000000..fcb34041d6e101fc71e625ecd489cc46bafc71bd --- /dev/null +++ b/docs/guides/guides.rst @@ -0,0 +1,10 @@ +Guides +====== + + +.. toctree:: + :maxdepth: 2 + + submissions_processing/submissions_processing + production/production + maintenance/maintenance diff --git a/docs/guides/maintenance/maintenance.rst b/docs/guides/maintenance/maintenance.rst new file mode 100644 index 0000000000000000000000000000000000000000..82ab83716d571b416716ac03deafe5d6eaa82247 --- /dev/null +++ b/docs/guides/maintenance/maintenance.rst @@ -0,0 +1,8 @@ +Maintenance +=========== + + +.. toctree:: + :maxdepth: 2 + + maintenance/maintenance diff --git a/docs/contributors/editorial_administrators/maintenance.rst b/docs/guides/maintenance/maintenance/maintenance.rst similarity index 72% rename from docs/contributors/editorial_administrators/maintenance.rst rename to docs/guides/maintenance/maintenance/maintenance.rst index ee7dc9e6f594a447dd3e25c5a95a5e3634fab86b..02a6140f0dc143bba0638cacbad7c719a592c86a 100644 --- a/docs/contributors/editorial_administrators/maintenance.rst +++ b/docs/guides/maintenance/maintenance/maintenance.rst @@ -1,5 +1,5 @@ -Maintenance of published material -================================= +Maintenance of SciPost Publications +=================================== This guide is meant for **Editorial Administrators**. It describes the post-publication maintenance of the published material. diff --git a/docs/contributors/editorial_administrators/production.rst b/docs/guides/production/initial_production/initial_production.rst similarity index 70% rename from docs/contributors/editorial_administrators/production.rst rename to docs/guides/production/initial_production/initial_production.rst index bc2dbcd3779b3f16d286e6fe81947e22d3424935..937068f30fb0171264f45ed703b16aaca525c3b9 100644 --- a/docs/contributors/editorial_administrators/production.rst +++ b/docs/guides/production/initial_production/initial_production.rst @@ -3,7 +3,7 @@ Production of SciPost Publications ================================== -This guide is meant for **Editorial Administrators** and **Production Officers**. It describes the post-acceptance workflow from paper acceptance to publication. +This guide is meant for **Editorial Administrators**, **Production Supervisors** and **Production Officers**. It describes the post-acceptance workflow from paper acceptance to publication. Version: 2017-05-11. @@ -423,163 +423,3 @@ Layout verification In particular, the punctuation of equations should be checked and corrected if necessary. - - -Proofs ------- - - * Once the paper has been properly formatted, the ``.tex`` and ``.pdf`` files - should be copied into new files carrying the ``_proofs_v[nr]`` suffix, - for example ``SciPost_Phys_1699_9999v9_Bee_proofs_v1.tex``. - - * The ``.pdf`` proofs should be emailed to the authors for verification. - Authors should return either an annotated pdf or a list of corrections - by plain text email. - - * Any modifications should be implemented directly in the main ``.tex`` file. - - * If any further check by the authors are required, start this proofs - todo-list again, increasing the proofs version number. - - * Once the authors have approved the proofs, the paper can be put forward - to online publication. - - -Online publication ------------------- - - These tasks must be performed by an **Editorial Administrator**. - - -Preparation of final version of record -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - #. Copy the whole paper folder from folder [journal name]/IN\_PRODUCTION \\to [journal name]/Volume\_[volume nr]. - - #. Check online to see which paper number is next available. - - #. Rename this folder using the convention [journal name]\_[volume number]([issue number])\_[paper nr]. - - #. Within this folder, take the author-accepted version tex file and rename it using the convention [journal name abbrev]\_[volume nr]\_[issue nr]\_[paper nr].tex. - - #. In this tex source, replace the ??? with the 3-digit paper number (3 places: 2 in preamble, 1 in copyright statement). - - #. Ensure that the author names are in format Abe Bee, Cee Dee and Elle Fine. - - #. Insert the correct Received, Accepted and Published dates in copyright statement. - - #. Make sure linenumbers are deactivated. - - #. Does the table of contents (if present) look OK? (Beware of hanging closing - line pushed to top of second page). If needed, adjust the ``\vspace`` spacings - defined around the table of contents, and/or insert an additional ``vspace`` - with negative spacing before the abstract. - - #. If the author-accepted proofs version used BiBTeX, copy the contents of the bbl - file into the .tex file, so that BiBTeX is not needed anymore. - - #. Verify each reference: authors, title, journal reference, doi link. - Manually correct any incorrect references. - - #. Recompile the LaTeX, and CAREFULLY CHECK EVERYTHING. - - -Uploading to ``scipost.org`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - - #. From the Submissions Pool, click on the link to initiate the publication process. - - #. Fill in the initiate publication form (using the dates in format YYYY-MM-DD). Submit. You are now on the validate publication page. - - #. Check that the paper number is correct. If not, modify the final tex source to account for this (see previous subsection). - - #. Select who the first author is (if registered as a Contributor; if not, inform the EdAdmin, and choose another author who is registered). - - #. Select the final version's pdf file. - - #. Submit. The paper is now published online. - - -Metadata preparation and DOI registration with Crossref -------------------------------------------------------- - - These tasks must be performed by **Editorial Administrators**, - who have access to the Publication's editorial tools - by navigating to the Publication's page. - - -Author listing -~~~~~~~~~~~~~~ - - If not all authors appear in the list presented at the top of the EdAdmin tools, - these should be added by following the ``Add a missing author`` link. - - The search form can be used to find missing authors who might be - Registered Contributors. If found, a one-click process adds them. - - You can otherwise create an UnregisteredAuthor object instance and link - it to the publication, by simply filling in the first and last name fields - and clicking on ``Add``. - - -Preparation of the citations list -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Follow the ``Create/update citation list metadata`` link. - - In the text area, paste the entire list of bibitems from the paper's - final ``.tex`` file. Upon clicking on ``Submit``, all DOI entires - are extracted and formatted into XML metadata which is saved in the - database. - - Citations with no valid DOI (*e.g.* arXiv preprints, books, etc) - do not appear in the metadata. - - -Funding info -~~~~~~~~~~~~ - - Following the ``Create/update funding info metadata`` link leads to a - page where the funding statement of the Publication's ``.tex`` file - (found either as a separate subsection or in the Acknowledgements) - can be pasted. - - -Preparation of the metadata XML -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Following the ``Create/update metadata XML`` link auto-generates a - full XML text field containing all the provided information, - properly formatted for the upcoming submission to Crossref. - - Verify that the first author is indeed enclosed in a - ``<person_name sequence='first' contributor_role='author'>`` tag, - and that subsequent authors (enclosed in - ``<person_name sequence='additional' contributor_role='author'>`` tags) - appear in the order of the Publication's author list. - - Once the metadata is set, clicking on ``Accept the metadata`` - saves the metadata to the database and returns one to the Publication's - page. - - -Metadata testing and deposit -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - At this stage, the metadata is ready for uploading to Crossref. - This occurs via a POST query to either the test or live Crossref server. - - Clicking on ``Test metadata deposit`` immediately posts the metadata - to the test server, and takes you to a page where the server's - response headers are displayed. The server also sends a more detailed - response via email - (to ``admin@scipost.org``; if you do not have access to this mailbox, - ask SciPost Administration) with the success status. - - Similarly, the actual deposit is immediately performed upon clicking on the - ``Deposit the metadata to Crossref``. The response headers are displayed, - and a detailed email response is sent by Crossref to ``admin@scipost.org``. - - - **This completes the publication process.** diff --git a/docs/guides/production/online_publication/online_publication.rst b/docs/guides/production/online_publication/online_publication.rst new file mode 100644 index 0000000000000000000000000000000000000000..92c29b6ef4609e75843f1ed61bd4ddfa9ae5be91 --- /dev/null +++ b/docs/guides/production/online_publication/online_publication.rst @@ -0,0 +1,148 @@ +.. Howto for publication production + +Online Publication +================== + +This guide is meant for **Editorial Administrators**. It describes the final publication of manuscripts, after final author proofs approval. + +Version: 2017-05-11. + + +Finalization of manuscript production +------------------------------------- + +The steps described here follow up on the :doc:`production` instructions used by production officers. + + +Preparation of final version of record +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + #. Copy the whole paper folder from folder [journal name]/IN\_PRODUCTION \\to [journal name]/Volume\_[volume nr]. + + #. Check online to see which paper number is next available. + + #. Rename this folder using the convention [journal name]\_[volume number]([issue number])\_[paper nr]. + + #. Within this folder, take the author-accepted version tex file and rename it using the convention [journal name abbrev]\_[volume nr]\_[issue nr]\_[paper nr].tex. + + #. In this tex source, replace the ??? with the 3-digit paper number (3 places: 2 in preamble, 1 in copyright statement). + + #. Ensure that the author names are in format Abe Bee, Cee Dee and Elle Fine. + + #. Insert the correct Received, Accepted and Published dates in copyright statement. + + #. Make sure linenumbers are deactivated. + + #. Does the table of contents (if present) look OK? (Beware of hanging closing + line pushed to top of second page). If needed, adjust the ``\vspace`` spacings + defined around the table of contents, and/or insert an additional ``vspace`` + with negative spacing before the abstract. + + #. If the author-accepted proofs version used BiBTeX, copy the contents of the bbl + file into the .tex file, so that BiBTeX is not needed anymore. + + #. Verify each reference: authors, title, journal reference, doi link. + Manually correct any incorrect references. + + #. Recompile the LaTeX, and CAREFULLY CHECK EVERYTHING. + + +Uploading to ``scipost.org`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + + #. From the Submissions Pool, click on the link to initiate the publication process. + + #. Fill in the initiate publication form (using the dates in format YYYY-MM-DD). Submit. You are now on the validate publication page. + + #. Check that the paper number is correct. If not, modify the final tex source to account for this (see previous subsection). + + #. Select who the first author is (if registered as a Contributor; if not, inform the EdAdmin, and choose another author who is registered). + + #. Select the final version's pdf file. + + #. Submit. The paper is now published online. + + +Metadata preparation and DOI registration with Crossref +------------------------------------------------------- + + These tasks must be performed by **Editorial Administrators**, + who have access to the Publication's editorial tools + by navigating to the Publication's page. + + +Author listing +~~~~~~~~~~~~~~ + + If not all authors appear in the list presented at the top of the EdAdmin tools, + these should be added by following the ``Add a missing author`` link. + + The search form can be used to find missing authors who might be + Registered Contributors. If found, a one-click process adds them. + + You can otherwise create an UnregisteredAuthor object instance and link + it to the publication, by simply filling in the first and last name fields + and clicking on ``Add``. + + +Preparation of the citations list +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Follow the ``Create/update citation list metadata`` link. + + In the text area, paste the entire list of bibitems from the paper's + final ``.tex`` file. Upon clicking on ``Submit``, all DOI entires + are extracted and formatted into XML metadata which is saved in the + database. + + Citations with no valid DOI (*e.g.* arXiv preprints, books, etc) + do not appear in the metadata. + + +Funding info +~~~~~~~~~~~~ + + Following the ``Create/update funding info metadata`` link leads to a + page where the funding statement of the Publication's ``.tex`` file + (found either as a separate subsection or in the Acknowledgements) + can be pasted. + + +Preparation of the metadata XML +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Following the ``Create/update metadata XML`` link auto-generates a + full XML text field containing all the provided information, + properly formatted for the upcoming submission to Crossref. + + Verify that the first author is indeed enclosed in a + ``<person_name sequence='first' contributor_role='author'>`` tag, + and that subsequent authors (enclosed in + ``<person_name sequence='additional' contributor_role='author'>`` tags) + appear in the order of the Publication's author list. + + Once the metadata is set, clicking on ``Accept the metadata`` + saves the metadata to the database and returns one to the Publication's + page. + + +Metadata testing and deposit +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + At this stage, the metadata is ready for uploading to Crossref. + This occurs via a POST query to either the test or live Crossref server. + + Clicking on ``Test metadata deposit`` immediately posts the metadata + to the test server, and takes you to a page where the server's + response headers are displayed. The server also sends a more detailed + response via email + (to ``admin@scipost.org``; if you do not have access to this mailbox, + ask SciPost Administration) with the success status. + + Similarly, the actual deposit is immediately performed upon clicking on the + ``Deposit the metadata to Crossref``. The response headers are displayed, + and a detailed email response is sent by Crossref to ``admin@scipost.org``. + + + **This completes the publication process.** diff --git a/docs/guides/production/production.rst b/docs/guides/production/production.rst new file mode 100644 index 0000000000000000000000000000000000000000..0d2e6d139bae69d46084939bf8c28a61e0e51369 --- /dev/null +++ b/docs/guides/production/production.rst @@ -0,0 +1,10 @@ +Production +========== + + +.. toctree:: + :maxdepth: 2 + + initial_production/initial_production + proofs/proofs + online_publication/online_publication diff --git a/docs/guides/production/proofs/proofs.rst b/docs/guides/production/proofs/proofs.rst new file mode 100644 index 0000000000000000000000000000000000000000..eb50aee6c46c9efee9501d5b8d840453564dabc4 --- /dev/null +++ b/docs/guides/production/proofs/proofs.rst @@ -0,0 +1,26 @@ +.. Howto for proofs + +Proofs +====== + +This guide is meant for **Production supervisors**. It describes the proofs cycle between production team and manuscript authors. + + +Proofs version production +------------------------- + + * Once the paper has been properly formatted, the ``.tex`` and ``.pdf`` files + should be copied into new files carrying the ``_proofs_v[nr]`` suffix, + for example ``SciPost_Phys_1699_9999v9_Bee_proofs_v1.tex``. + + * The ``.pdf`` proofs should be emailed to the authors for verification. + Authors should return either an annotated pdf or a list of corrections + by plain text email. + + * Any modifications should be implemented directly in the main ``.tex`` file. + + * If any further check by the authors are required, start this proofs + todo-list again, increasing the proofs version number. + + * Once the authors have approved the proofs, the paper can be put forward + to online publication. diff --git a/docs/contributors/editorial_administrators/submission_processing.rst b/docs/guides/submissions_processing/submissions_processing.rst similarity index 100% rename from docs/contributors/editorial_administrators/submission_processing.rst rename to docs/guides/submissions_processing/submissions_processing.rst diff --git a/docs/index.rst b/docs/index.rst index 5b4a14377165a55f0ee5a0355ad9ec4095e357c9..a7922f3d586c4b8d1aa354b6ea660c1f1564ae5c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,9 +9,10 @@ Welcome to SciPost's documentation! Contents: .. toctree:: - :maxdepth: 3 + :maxdepth: 2 - contributors/contributors + roles/roles + guides/guides developers/developers diff --git a/docs/contributors/editorial_administrators/editorial_administrators.rst b/docs/roles/editorial/editorial_administrators.rst similarity index 59% rename from docs/contributors/editorial_administrators/editorial_administrators.rst rename to docs/roles/editorial/editorial_administrators.rst index 33e054b533e1a4951058019a0f2644e8622f11cd..d6747f7d357c5799fb77d8450dac71a258523b3d 100644 --- a/docs/contributors/editorial_administrators/editorial_administrators.rst +++ b/docs/roles/editorial/editorial_administrators.rst @@ -4,7 +4,3 @@ Editorial Administrators .. toctree:: :maxdepth: 2 - - submission_processing - production - maintenance diff --git a/docs/roles/editorial/editorial_fellows.rst b/docs/roles/editorial/editorial_fellows.rst new file mode 100644 index 0000000000000000000000000000000000000000..00973f28a2fff53aa8726ed59a63da0bc3fd0122 --- /dev/null +++ b/docs/roles/editorial/editorial_fellows.rst @@ -0,0 +1,6 @@ +Editorial Fellows +================= + + +.. toctree:: + :maxdepth: 2 diff --git a/docs/roles/production/production_officers.rst b/docs/roles/production/production_officers.rst new file mode 100644 index 0000000000000000000000000000000000000000..b9b79da1740c33ef7a2ca3c382e9a29a512985d6 --- /dev/null +++ b/docs/roles/production/production_officers.rst @@ -0,0 +1,6 @@ +Production Officers +=================== + + +.. toctree:: + :maxdepth: 2 diff --git a/docs/roles/roles.rst b/docs/roles/roles.rst new file mode 100644 index 0000000000000000000000000000000000000000..3df3c2c3eda344d4ddf876bb4e6072a053f6321e --- /dev/null +++ b/docs/roles/roles.rst @@ -0,0 +1,10 @@ +Roles: responsibilities and task lists +====================================== + + +.. toctree:: + :maxdepth: 2 + + editorial/editorial_administrators + editorial/editorial_fellows + production/production_officers