About Writing Academic Paper
============================

.. figure:: https://gitlab.com/dr-guangtou/taotie/blob/master/doc/images/keep_calm_write_on.png
   :alt: Keep calm and write on

   Keep calm and write on

Basics
------

-  `Notes on writing papers by Prof. Alexie
   Leauthaud <https://github.com/alexieleauthaud/RedWoodTools/wiki/Writing-Papers>`__

Examples
~~~~~~~~

-  Good example of papers with good reproducibility:

   -  `STARRY: Analytic Occultation Light
      Curves <https://ui.adsabs.harvard.edu/#abs/arXiv:1810.06559>`__
   -  Format, equation, figure, open source code, and awesomefont links.

English
-------

-  `Grammarly <https://www.grammarly.com>`__
-  `Linguee - Good place to search for example usage of a
   word <https://en.linguee.com/english-chinese>`__
-  `Linggle 10^12 - Another place to search for real world usage of a
   word <https://linggle.com>`__

Useful Tools
------------

-  `adstex - manage your bibtex
   entries <https://github.com/yymao/adstex>`__

   -  By Yao-Yuan Mao; Automated generation of NASA ADS bibtex entries
      directly from citation keys in your TeX source files

-  `The Astronomy Acknowledgement
   Generator <http://astrofrog.github.io/acknowledgment-generator/>`__

   -  This is very useful! The data are kept
      `here <https://github.com/astrofrog/acknowledgment-generator>`__

-  `PDF Compressor <https://pdfcompressor.com>`__

   -  This is useful when you want to compress the quality of a figure.

-  `Tabula - Tool for liberating data tables locked inside PDF
   files <https://tabula.technology>`__

LaTeX
-----

Online LaTeX Editor
~~~~~~~~~~~~~~~~~~~

-  `Overleaf <https://www.overleaf.com>`__

   -  The most commonly used one. The free service is already very good.

-  `Authorea <https://www.authorea.com/>`__

   -  A powerful publishing platform for articles, data, figures,
      preprints. More than just a LaTeX editor.

LaTeX resources
~~~~~~~~~~~~~~~

-  `Complete list of LaTeX symbols
   (PDF) <https://math.uoregon.edu/wp-content/uploads/2014/12/compsymb-1qyb3zd.pdf>`__

-  `List of LaTeX mathematical
   symbols <https://oeis.org/wiki/List_of_LaTeX_mathematical_symbols>`__

-  `LaTeX open book on
   WikiBooks <https://en.wikibooks.org/wiki/LaTeX>`__

   -  Very good place to search for basic usage.

-  `List of color names in LaTeX along with other useful tips about
   color <https://en.wikibooks.org/wiki/LaTeX/Colors>`__

Useful LaTeX tips
~~~~~~~~~~~~~~~~~

-  `Link to aribitary part of
   text <https://tex.stackexchange.com/questions/280462/link-to-arbitrary-part-of-text>`__

   -  Using **\\hypertarget** and **\\hyperlink**

Figure
------

Flowchart
~~~~~~~~~

-  `mermaid - Generation of diagram and flowchart from text in a similar
   manner as markdown <https://github.com/knsv/mermaid>`__

   -  **mermaid**, a simple markdown-like script language for generating
      charts from text via javascript.