protocolos-tecnm-workshop
/
protocolo-example
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Example ready

Browse Source
main
Gerardo Marx 2 weeks ago
commit 973de2f395
3 changed files with 576 additions and 0 deletions
Show Stats Download Patch File Download Diff File

400
ieee.csl
Unescape Escape View File

@ -0,0 +1,400 @@
<?xml version="1.0" encoding="utf-8"?>
<style xmlns="http://purl.org/net/xbiblio/csl" class="in-text" version="1.0" demote-non-dropping-particle="sort-only">
<info>
<title>IEEE</title>
<id>http://www.zotero.org/styles/ieee</id>
<link href="http://www.zotero.org/styles/ieee" rel="self"/>
<link href="https://ieeeauthorcenter.ieee.org/wp-content/uploads/IEEE-Reference-Guide.pdf" rel="documentation"/>
<link href="https://journals.ieeeauthorcenter.ieee.org/your-role-in-article-production/ieee-editorial-style-manual/" rel="documentation"/>
<author>
<name>Michael Berkowitz</name>
<email>mberkowi@gmu.edu</email>
</author>
<contributor>
<name>Julian Onions</name>
<email>julian.onions@gmail.com</email>
</contributor>
<contributor>
<name>Rintze Zelle</name>
<uri>http://twitter.com/rintzezelle</uri>
</contributor>
<contributor>
<name>Stephen Frank</name>
<uri>http://www.zotero.org/sfrank</uri>
</contributor>
<contributor>
<name>Sebastian Karcher</name>
</contributor>
<contributor>
<name>Giuseppe Silano</name>
<email>g.silano89@gmail.com</email>
<uri>http://giuseppesilano.net</uri>
</contributor>
<contributor>
<name>Patrick O'Brien</name>
</contributor>
<contributor>
<name>Brenton M. Wiernik</name>
</contributor>
<category citation-format="numeric"/>
<category field="engineering"/>
<category field="generic-base"/>
<summary>IEEE style as per the 2018 guidelines, V 11.12.2018.</summary>
<updated>2020-06-15T03:21:46+00:00</updated>
<rights license="http://creativecommons.org/licenses/by-sa/3.0/">This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License</rights>
</info>
<locale xml:lang="en">
<terms>
<term name="chapter" form="short">ch.</term>
<term name="presented at">presented at the</term>
<term name="available at">available</term>
</terms>
</locale>
<!-- Macros -->
<macro name="status">
<choose>
<if variable="page issue volume" match="none">
<text variable="status" text-case="capitalize-first" suffix="" font-weight="bold"/>
</if>
</choose>
</macro>
<macro name="edition">
<choose>
<if type="bill book chapter graphic legal_case legislation motion_picture paper-conference report song" match="any">
<choose>
<if is-numeric="edition">
<group delimiter=" ">
<number variable="edition" form="ordinal"/>
<text term="edition" form="short"/>
</group>
</if>
<else>
<text variable="edition" text-case="capitalize-first" suffix="."/>
</else>
</choose>
</if>
</choose>
</macro>
<macro name="issued">
<choose>
<if type="article-journal report" match="any">
<date variable="issued">
<date-part name="month" form="short" suffix=" "/>
<date-part name="year" form="long"/>
</date>
</if>
<else-if type="bill book chapter graphic legal_case legislation motion_picture song thesis" match="any">
<date variable="issued">
<date-part name="year" form="long"/>
</date>
</else-if>
<else-if type="paper-conference" match="any">
<date variable="issued">
<date-part name="month" form="short"/>
<date-part name="year" prefix=" "/>
</date>
</else-if>
<else>
<date variable="issued">
<date-part name="month" form="short" suffix=" "/>
<date-part name="day" form="numeric-leading-zeros" suffix=", "/>
<date-part name="year"/>
</date>
</else>
</choose>
</macro>
<macro name="author">
<names variable="author">
<name and="text" et-al-min="7" et-al-use-first="1" initialize-with=". "/>
<label form="short" prefix=", " text-case="capitalize-first"/>
<et-al font-style="italic"/>
<substitute>
<names variable="editor"/>
<names variable="translator"/>
</substitute>
</names>
</macro>
<macro name="editor">
<names variable="editor">
<name initialize-with=". " delimiter=", " and="text"/>
<label form="short" prefix=", " text-case="capitalize-first"/>
</names>
</macro>
<macro name="locators">
<group delimiter=", ">
<text macro="edition"/>
<group delimiter=" ">
<text term="volume" form="short"/>
<number variable="volume" form="numeric"/>
</group>
<group delimiter=" ">
<number variable="number-of-volumes" form="numeric"/>
<text term="volume" form="short" plural="true"/>
</group>
<group delimiter=" ">
<text term="issue" form="short"/>
<number variable="issue" form="numeric"/>
</group>
</group>
</macro>
<macro name="title">
<choose>
<if type="bill book graphic legal_case legislation motion_picture song" match="any">
<text variable="title" font-style="italic"/>
</if>
<else>
<text variable="title" quotes="true"/>
</else>
</choose>
</macro>
<macro name="publisher">
<choose>
<if type="bill book chapter graphic legal_case legislation motion_picture paper-conference song" match="any">
<group delimiter=": ">
<text variable="publisher-place"/>
<text variable="publisher"/>
</group>
</if>
<else>
<group delimiter=", ">
<text variable="publisher"/>
<text variable="publisher-place"/>
</group>
</else>
</choose>
</macro>
<macro name="event">
<choose>
<if type="paper-conference speech" match="any">
<choose>
<!-- Published Conference Paper -->
<if variable="collection-editor editor editorial-director issue page volume" match="any">
<group delimiter=", ">
<group delimiter=" ">
<text term="in"/>
<text variable="container-title" font-style="italic"/>
</group>
<text variable="event-place"/>
</group>
</if>
<!-- Unpublished Conference Paper -->
<else>
<group delimiter=", ">
<group delimiter=" ">
<text term="presented at"/>
<text variable="event"/>
</group>
<text variable="event-place"/>
</group>
</else>
</choose>
</if>
</choose>
</macro>
<macro name="access">
<choose>
<if type="webpage post post-weblog" match="any">
<choose>
<if variable="URL">
<group delimiter=" ">
<text variable="URL"/>
<group delimiter=" " prefix="(" suffix=")">
<text term="accessed"/>
<date variable="accessed">
<date-part name="month" form="short" strip-periods="false"/>
<date-part name="day" form="numeric-leading-zeros" prefix=" " suffix=", "/>
<date-part name="year" form="long"/>
</date>
</group>
</group>
</if>
</choose>
</if>
<else-if match="any" variable="DOI">
<text variable="DOI" prefix="doi: "/>
</else-if>
<else>
<group delimiter=". ">
<group delimiter=": ">
<text term="accessed" text-case="capitalize-first"/>
<date variable="accessed">
<date-part name="month" form="short" suffix=" "/>
<date-part name="day" form="numeric-leading-zeros" suffix=", "/>
<date-part name="year"/>
</date>
</group>
<text term="online" prefix="[" suffix="]" text-case="capitalize-first"/>
<group delimiter=": ">
<text term="available at" text-case="capitalize-first"/>
<text variable="URL"/>
</group>
</group>
</else>
</choose>
</macro>
<macro name="page">
<choose>
<if type="article-journal" variable="number" match="all">
<group delimiter=" ">
<text value="Art."/>
<text term="issue" form="short"/>
<text variable="number"/>
</group>
</if>
<else>
<group delimiter=" ">
<label variable="page" form="short"/>
<text variable="page"/>
</group>
</else>
</choose>
</macro>
<macro name="citation-locator">
<group delimiter=" ">
<choose>
<if locator="page">
<label variable="locator" form="short"/>
</if>
<else>
<label variable="locator" form="short" text-case="capitalize-first"/>
</else>
</choose>
<text variable="locator"/>
</group>
</macro>
<!-- Citation -->
<citation collapse="citation-number">
<sort>
<key variable="citation-number"/>
</sort>
<layout delimiter=", ">
<group prefix="[" suffix="]" delimiter=", ">
<text variable="citation-number"/>
<text macro="citation-locator"/>
</group>
</layout>
</citation>
<!-- Bibliography -->
<bibliography entry-spacing="0" second-field-align="flush">
<layout suffix=".">
<!-- Citation Number -->
<text variable="citation-number" prefix="[" suffix="]"/>
<!-- Author(s) -->
<text macro="author" suffix=", "/>
<!-- Rest of Citation -->
<choose>
<!-- Specific Formats -->
<if type="article-journal">
<group delimiter=", ">
<text macro="title"/>
<text variable="container-title" font-style="italic" form="short"/>
<text macro="locators"/>
<text macro="page"/>
<text macro="issued"/>
<text macro="status"/>
<text macro="access"/>
</group>
</if>
<else-if type="paper-conference speech" match="any">
<group delimiter=", ">
<text macro="title"/>
<text macro="event"/>
<text macro="issued"/>
<text macro="locators"/>
<text macro="page"/>
<text macro="status"/>
<text macro="access"/>
</group>
</else-if>
<else-if type="report">
<group delimiter=". ">
<group delimiter=", ">
<text macro="title"/>
<text macro="publisher"/>
<group delimiter=" ">
<text variable="genre"/>
<text variable="number"/>
</group>
<text macro="issued"/>
</group>
<text macro="access"/>
</group>
</else-if>
<else-if type="thesis">
<group delimiter=", ">
<text macro="title"/>
<text variable="genre"/>
<text macro="publisher"/>
<text macro="issued"/>
</group>
</else-if>
<else-if type="webpage post-weblog post" match="any">
<group delimiter=", " suffix=". ">
<text macro="title"/>
<text variable="container-title" font-style="italic"/>
<text macro="issued"/>
</group>
<text macro="access"/>
</else-if>
<else-if type="patent">
<group delimiter=", ">
<text macro="title"/>
<text variable="number"/>
<text macro="issued"/>
</group>
</else-if>
<!-- Generic/Fallback Formats -->
<else-if type="bill book graphic legal_case legislation motion_picture report song" match="any">
<group delimiter=", " suffix=". ">
<text macro="title"/>
<text macro="locators"/>
</group>
<group delimiter=", ">
<text macro="publisher"/>
<text macro="issued"/>
<text macro="page"/>
</group>
</else-if>
<else-if type="article-magazine article-newspaper broadcast interview manuscript map patent personal_communication song speech thesis webpage" match="any">
<group delimiter=", ">
<text macro="title"/>
<text variable="container-title" font-style="italic"/>
<text macro="locators"/>
<text macro="publisher"/>
<text macro="page"/>
<text macro="issued"/>
</group>
</else-if>
<else-if type="chapter paper-conference" match="any">
<group delimiter=", " suffix=", ">
<text macro="title"/>
<group delimiter=" ">
<text term="in"/>
<text variable="container-title" font-style="italic"/>
</group>
<text macro="locators"/>
</group>
<text macro="editor" suffix=" "/>
<group delimiter=", ">
<text macro="publisher"/>
<text macro="issued"/>
<text macro="page"/>
</group>
</else-if>
<else>
<group delimiter=", " suffix=". ">
<text macro="title"/>
<text variable="container-title" font-style="italic"/>
<text macro="locators"/>
</group>
<group delimiter=", ">
<text macro="publisher"/>
<text macro="page"/>
<text macro="issued"/>
<text macro="access"/>
</group>
</else>
</choose>
</layout>
</bibliography>
</style>

126
protocolo.md
Unescape Escape View File

@ -0,0 +1,126 @@
---
title: "Protocolo de Investigación: Uso de Markdown para la Redacción Científica"
author: Gerardo Marx Chávez-Campos
bibliography: referencias.bib
csl: ieee.csl
header-includes:
- \usepackage{graphicx}
- \usepackage{booktabs}
- \usepackage{amsmath}
output: pdf
---
## Introducción
La redacción científica es una competencia fundamental para investigadores y estudiantes de posgrado [@lopez2021tesis] . En la era digital, el uso de lenguajes de marcado como Markdown ha cobrado relevancia por su simplicidad [@garcia2023markdown], compatibilidad y capacidad de conversión a múltiples formatos mediante herramientas como Pandoc [@witting2019],[@pandoc_manual].
## Antecedentes
Diversos autores han explorado metodologías para facilitar la escritura académica con tecnologías abiertas. Por ejemplo, Nobis et al. (2022) discuten el uso de Markdown y Pandoc como herramientas efectivas para la producción científica reproducible [@nobis2022markdown]. Además, herramientas como Zettlr y Obsidian han sido adoptadas en contextos educativos para gestionar bibliografía y redactar textos con apoyo de BibTeX [@knuth1984texbook].
## Objetivo General
Explorar y ejemplificar el uso de Markdown y Pandoc como herramientas para la redacción estructurada de protocolos y artículos de investigación científica.
## Objetivos Específicos
- Redactar un protocolo completo en formato Markdown.
- Integrar referencias bibliográficas con BibTeX.
- Usar Pandoc para convertir el archivo a PDF, DOCX y otros formatos.
- Emplear plantillas de Word para estandarizar la salida.
## Metodología
### Herramientas
- Markdown (.md) como formato base.
- BibTeX (.bib) para gestión bibliográfica.
- Pandoc para conversión de formatos.
- Plantilla de Word para formato estándar de salida.
### Estructura del archivo Markdown
El archivo incluirá metadatos (YAML) al inicio del archivo `md` que debe tener una estructura similar a la siguiente:
```yaml
---
title: "Protocolo de Investigación"
author: "Tu Nombre"
date: \today
fontsize: 12pt
geometry: margin=2.5cm
documentclass: article
header-includes:
  - \usepackage{graphicx}
  - \usepackage{amsmath}
  - \usepackage{hyperref}
  - \usepackage{float}
  - \usepackage{booktabs}
  - \usepackage[spanish]{babel}
  - \usepackage[utf8]{inputenc}
  - \usepackage[T1]{fontenc}
  - \usepackage{lipsum}
---
```
Después de los metadatos, el contenido del archivo está estructurado en función de la convocatoria, formato de publicación o plantilla. Las citas bibliográficas se realizarán siguiendo la siguiente sintaxis `[@clave]`. Estas claves de cita son definidas en un archivo complementario, que en el caso de este repositorio es llamado `referencias.bib`.
### Archivos bibtex
El contenido del archivo `referencias.bib` sigue el formato tipo Bibtex y a continuación se indican las estructuras de las entradas más comunes como: artículos, libros, capítulos de libro, tesis, congresos, recursos en la web.
**Artículo de revista**
```bibtex
@article{apellido2024ejemplo,
author = {Apellido, Nombre},
title = {Título del artículo},
journal = {Nombre de la Revista},
year = {2024},
volume = {12},
number = {3},
pages = {123--134},
doi = {10.1234/ejemplo.doi}
}
```
**Libro**
```bibtex
@book{autor2022libro,
author = {Apellido, Nombre},
title = {Título del Libro},
publisher = {Editorial Ejemplo},
year = {2022},
edition = {2},
address = {Ciudad}
}
```
### Estilos de citas CSL
https://github.com/citation-style-language/styles-distribution/blob/master/ieee.csl?utm_source=chatgpt.com
### Ejemplos de comandos Pandoc
```bash
# Convertir a PDF usando cita bibliográfica y plantilla de CSL
pandoc protocolo.md --citeproc -o protocolo.pdf
# Convertir a DOCX con plantilla personalizada
pandoc protocolo.md --citeproc --reference-doc=plantilla.docx -o protocolo.docx
# Convertir a HTML
pandoc protocolo.md --citeproc -o protocolo.html
```
### Flujo de trabajo
1. Crear archivo `protocolo.md`.
2. Crear archivo `referencias.bib`.
3. Ejecutar comandos Pandoc desde terminal.
4. Validar formato de salida.
## Referencias
Las referencias se encuentran almacenadas en el archivo `referencias.bib` y se integran automáticamente mediante Pandoc.

50
referencias.bib
Unescape Escape View File

@ -0,0 +1,50 @@
@article{witting2019,
title={The thermoelectric properties of bismuth telluride},
author={Witting, Ian T and Chasapis, Thomas C and Ricci, Francesco and Peters, Matthew and Heinz, Nicholas A and Hautier, Geoffroy and Snyder, G Jeffrey},
journal={Advanced Electronic Materials},
volume={5},
number={6},
pages={1800904},
year={2019},
publisher={Wiley Online Library}
}
@article{nobis2022markdown,
title={Scientific Writing with Markdown and Pandoc},
author={Nobis, Thomas and Meurer, Philipp},
journal={SoftwareX},
volume={17},
pages={100931},
year={2022},
publisher={Elsevier}
}
@book{knuth1984texbook,
title={The TeXbook},
author={Knuth, Donald E},
year={1984},
publisher={Addison-Wesley}
}
@misc{pandoc_manual,
title = {Pandoc User’s Guide},
author = {MacFarlane, John},
year = {2024},
note = {\url{https://pandoc.org/MANUAL.html}}
}
@inproceedings{garcia2023markdown,
title={Implementación de Markdown en cursos de redacción académica},
author={García, Luis and Pérez, Ana},
booktitle={Congreso Nacional de Docencia 2023},
pages={45--50},
year={2023},
organization={ANUIES}
}
@phdthesis{lopez2021tesis,
title={Integración de herramientas de texto plano en procesos editoriales académicos},
author={López, María},
school={UNAM},
year={2021}
}
Write Preview
Loading…
Cancel
Save