Initial Commit

Initial Commit

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contributors
+
+- **Aitor Corchero Rodriguez**- *Researcher at EURECAT/Phd Student/Assitant Teacher at Udl*
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Aitor Corchero Rodríguez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,25 @@
+# Makefile referring the generation of the pdf based on a markdown file.
+
+# Definition of the makefile variables
+
+OUT_FILE_NAME=paper
+INPUT_MARKDOWN_FILE=article.md
+CITES_BIB=cites.bib
+LATEX_TEMPLATE=template/mdpi-template.tex
+CSL_TEMPLATE=csl/ieee.csl
+
+all: 
+	make latex
+	make pdf
+
+latex: 
+	pandoc -s --template=$(LATEX_TEMPLATE) \
+	--to latex --filter pandoc-citeproc \
+	--bibliography=$(CITES_BIB) \
+	--csl=$(CSL_TEMPLATE) $(INPUT_MARKDOWN_FILE) >$(OUT_FILE_NAME).tex
+
+pdf: $(OUT_FILE_NAME).tex
+	pdflatex $(OUT_FILE_NAME).tex
+
+clean: 
+	rm paper.*

README.md

@@ -0,0 +1,51 @@
+# markdown-latex
+
+The markdown-latex repository is focused on providing a framework to convert markdown documents into scientific journals. 
+
+> For now, we have only implemented the template for the mdpi journal. 
+
+
+
+## Getting Started
+
+To copy the project only you need to fork the repository or download it into the local machine. If you prefer to download the releases, you nly need to download it for the *"releases"* tag. 
+
+## Installing
+
+For running the respository, we recommend to install [pandoc and pandoc-citeproc](http://pandoc.org/installing.html),comand line tools. 
+
+Once installed and downloaded the project, you shold be able to execute the make all command to test the example article: 
+
+```sh
+$ make all
+```
+
+After that, a PDF file and a latex document should be created into the folder. Moreover, you can also remove output file by eecuting the "make clean": 
+
+```sh
+$ make clean
+```
+
+## Contributing
+
+Please read [CONTRIBUTING.md](#) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://gitlab.com/aolite/phd-doc/tags).
+
+## Authors
+
+- **Aitor Corchero Rodriguez**- *Researcher at EURECAT/Phd Student/Assitant Teacher at Udl*
+
+## License
+
+This work is licensed under a [MIT License](https://gitlab.com/aolite/phd-doc/blob/master/LICENSE.md)
+
+## References
+
+For building this repository, we have followed and learn from the following web resources: 
+
+- [pandoc-scholar](https://pandoc-scholar.github.io)
+- [Academic Writing with Pandoc](http://dylanstorey.com/2015/12/Academic_Writing_With_Markdown.html)
+- [Pandoc Customizes Latex template for](https://los-pajaros-de-hogano.blogspot.com.es/2015/01/pandoc-customized-latex-templates-for.html)

article.md

@@ -0,0 +1,108 @@
+---
+article-type: sensors
+editor-name: editor name example
+title: My journal title
+author:
+- name: Author Name1
+  institute: {index: 1, affiliation: 'comp_2'}
+  email: [email protected]
+  equal-contribution: 'yes'
+  correspondence: {email: '[email protected]', phone: '+x-xxx-xxx-xxxx', address: 'addr1'}
+
+- name: Author 2
+  institute: {index: 2, affiliation: 'comp_1'}
+  email: [email protected]
+  equal-contribution: 'yes'
+abstract: "A single paragraph of about 200 words maximum. For research articles, abstracts should give a pertinent overview of the work. We strongly encourage authors to use the following style of structured abstracts, but without headings: 1) Background: Place the question addressed in a broad context and highlight the purpose of the study; 2) Methods: Describe briefly the main methods or treatments applied; 3) Results: Summarize the article's main findings; and 4) Conclusion: Indicate the main conclusions or interpretations. The abstract should be an objective representation of the article: it must not contain results which are not presented and substantiated in the main text and should not exaggerate the main conclusions."
+keywords: [keyword 1; keyword 2; keyword 3. List three to ten pertinent keywords specific to the article, yet reasonably common within the subject discipline.]
+---
+
+# How to Use this Template
+
+The template details the sections that can be used in a manuscript. Sections that are not mandatory are listed as such. The section titles given are for Articles. Review papers and other article types have a more flexible structure. For any questions, please contact the editorial office of the journal or [email protected]. For LaTeX related questions please contact Janine Daum at [email protected].
+
+# Introduction
+
+The introduction should briefly place the study in a broad context and highlight why it is important. It should define the purpose of the work and its significance. The current state of the research field should be reviewed carefully and key publications should be cited. Please highlight controversial and diverging hypotheses when necessary. Finally, briefly mention the main aim of the work and highlight the main conclusions. As far as possible, please keep the introduction comprehensible to scientists outside your particular field of research. Citing a journal paper [@Meier-Kolthoff2013]. And now citing a book reference [@Meier-Kolthoff2013]
+
+# Results
+
+This section may be divided by subheadings. It should provide a concise and precise description of the experimental results, their interpretation as well as the experimental conclusions that can be drawn.
+
+## Subsection
+
+### Subsubsection
+
+Bulleted lists look like this:
+
+- First bullet
+- Second bullet
+- Third bullet
+
+Numbered lists can be added as follows:
+
+1. First item
+2. Second item
+3. Third item
+
+The text continues here.
+
+## Figures, Tables and Schemes
+
+All figures and tables should be cited in the main text as Figure 1, Table 1, etc.
+
+![This is a figure, Schemes follow the same formatting. If there are multiple panels, they should be listed as: (\textbf{a}) Description of what is contained in the first panel. (\textbf{b}) Description of what is contained in the second panel. Figures should be placed in the main text near to the first time they are cited. A caption on a single line should be centered.](logo-mdpi.eps)
+
+\begin{table}[H]
+\caption{This is a table caption. Tables should be placed in the main text near to the first time they are cited.}
+\small % Font size can be changed to match table content. Recommend 10 pt.
+\centering
+\begin{tabular}{ccc}
+\toprule
+\textbf{Title 1}	& \textbf{Title 2}	& \textbf{Title 3}\\
+\midrule
+entry 1		& data			& data\\
+entry 2		& data			& data\\
+\bottomrule
+\end{tabular}
+\end{table}
+
+## Formatting of Mathematical Components
+
+This is an example of an equation:
+
+\begin{equation}
+\mathbb{S}
+\end{equation}
+
+Please punctuate equations as regular text. Theorem-type environments (including propositions, lemmas, corollaries etc.) can be formatted as follows:
+
+\begin{Theorem}
+Example text of a theorem.
+\end{Theorem}
+
+The text continues here. Proofs must be formatted as follows:
+
+\begin{proof}[Proof of Theorem 1]
+Text of the proof. Note that the phrase `of Theorem 1' is optional if it is clear which theorem is being referred to.
+\end{proof}
+The text continues here.
+
+# Discussion
+
+This section may be divided by subheadings. Authors should discuss the results and how they can be interpreted in perspective of previous studies and of the working hypotheses. The findings and their implications should be discussed in the broadest context possible. Future research directions may also be highlighted.
+
+# Materials and Methods
+
+This section should be divided by subheadings. Materials and Methods should be described with sufficient details to allow others to replicate and build on published results. Please note that publication of your manuscript implicates that you must make all materials, data, and protocols associated with the publication available to readers. Please disclose at the submission stage any restrictions on the availability of materials or information. New methods and protocols should be described in detail while well-established methods can be briefly described and appropriately cited.
+
+Research manuscripts reporting large datasets that are deposited in a publicly available database should specify where the data have been deposited and provide the relevant accession numbers. If the accession numbers have not yet been obtained at the time of submission, please state that they will be provided during review. They must be provided prior to publication.
+
+# Conclusions
+
+This section is not mandatory, but can be added to the manuscript if the discussion is unusually long or complex.
+
+
+
+
+# References