From aefdcc7fe666f45a50be1cea682c982e7b7945b6 Mon Sep 17 00:00:00 2001 From: mariajoafana Date: Wed, 13 May 2020 17:39:58 -0500 Subject: [PATCH 1/9] Create guia-para-autores-en-proceso --- es/guia-para-autores-en-proceso | 344 ++++++++++++++++++++++++++++++++ 1 file changed, 344 insertions(+) create mode 100644 es/guia-para-autores-en-proceso diff --git a/es/guia-para-autores-en-proceso b/es/guia-para-autores-en-proceso new file mode 100644 index 0000000000..61b4b53364 --- /dev/null +++ b/es/guia-para-autores-en-proceso @@ -0,0 +1,344 @@ +--- +title: Guía para autores y traducotres +layout: blank +redirect_from: + - /new-lesson-workflow + - /author-guidelines +skip_validation: true +--- + +# Guía para autores + + +

Paso 1: Proponer o traducir un tutorial nuevo

+

Paso 2: Escribir y dar formato a un nuevo tutorial

+

Paso 3: Enviar un nuevo tutorial o traducción

+ + +Estas directrices han sido desarrolladas para ayudar a entender el proceso de creación de un tutorial para *Programming Historian*. Incluyen detalles prácticos y filosóficos sobre el proceso de redacción del tutorial, así como indicaciones sobre el flujo de trabajo y del proceso de revisión de pares. Si en algún momento no está claro, por favor envíe un correo electrónico al editor jefe {% include managing-editor.html lang=page.lang %}. + +## Paso 1: Proponer of traducir un nuevo tutorial + +
+Recibimos tutoriales pertinentes a las humanidades, que se centren en cualquier nivel de aptitud técnica y experiencia, que se centren en un problema o proceso, que puedan ser sostenibles a largo plazo y que estén dirigidos a una audiencia global. + +El alcance y la longitud del tutorial deben ser adecuados a la complejidad de la tarea. Los tutoriales no deben exceder las 8.000 palabras (incluido el código). Las lecciones más cortas son bienvenidas. Es posible que las lecciones más largas deban dividirse en múltiples tutoriales. + +
+ +Si tienes una idea para una nueva lección, completa una el [formato de propuestas](/assets/forms/Lesson.Query.Form.txt) y envíalo a {% include managing-editor.html lang=page.lang %}. + +Puedes darte una idea de lo que publicamos revisando nuestros [tutoriales publicados]({{site.baseurl}}/es/lecciones), leyendo nuestra [guía para revisores]({{site.baseurl}}/es/guia-para-revisores) u ojeando [los tutoriales en desarrollo](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/es/lecciones). + +Si su propuesta es aceptada, un editor creará una página de "Propuesta" en nuestro [sitio de envíos](https://github.com/programminghistorian/ph-submissions/issues) con el título de la lección y los resultados de aprendizaje propuestos. Esto sirve para señalar el trabajo en curso. Para asegurar la publicación oportuna, los autores deben presentar su proyecto de artículo en un plazo de 90 días. + +Durante este período de 90 días, su punto de contacto será el jefe de redacción o un editor delegado según pa prerrogativa del jefe de redacción. + +## Paso 2: Writing and Formatting a New Lesson +This style guide lays out a set of standards for authors to use when creating or translating English-language lessons for *Programming Historian*. By using it, you help us ensure content is consistent and accessible. + +It is presented in three sections which should be read before and after writing: + +* A. Style and Audience +* B. Specific Style Guidelines +* C. Formatting Guidelines + +## A. Style and Audience +This first section is concerned with big-picture matters of style which will help you make decisions that meet the needs of our audience and editors. They include basic information on style and tone, open access and open source values, information on writing for a global audience, writing sustainably, and making smart choices about data used in lessons. Read this section when planning your lesson. Read it again before submitting to make sure your lesson meets these requirements. + +### Language and Style +* Tutorials should not exceed 8,000 words (including code). +* Keep your tone formal but accessible. +* Talk to your reader in the second person (you). +* Adopt a widely-used version of English (British, Canadian, Indian, South African etc). +* The piece of writing is a "tutorial" or a "lesson" and not an "article". + +### Open Source, Open Access +*Programming Historian* is committed to open source values. All lessons must use open source programming languages and software whenever possible. This policy is meant to minimize costs for all parties, and to allow the greatest possible level of participation. + +Upon acceptance, you agree to publish your lesson under a Creative Commons "[CC-BY](https://creativecommons.org/licenses/by/4.0/deed.en)" license. + +### Write for a Global Audience +*Programming Historian* readers live all around the world. Authors can and should take steps to write their lesson accessibly for as many people as possible. Follow these global-facing guidelines: + +* Write for someone who doesn't live in your country or share your beliefs. + +* **Technical Terms:** should always be linked to [Wikipedia](https://www.wikipedia.org/) or a suitably reliable dictionary or sustainable website in the first instance. A technical term is any word that a person on the street may not know or understand. +* **Cultural References**: mentions of persons, organisations, or historical details should always come with contextual information. Assume no prior knowledge, even of widely known cultural references (eg, [the Beatles](https://en.wikipedia.org/wiki/The_Beatles)). Use generic terms rather than trademarks (tissue rather than Kleenex). Links to [Wikipedia](https://www.wikipedia.org/) should be used liberally. Be aware that historical events often have different names in different countries. +* **Idioms**: Avoid jokes, puns, plays on words, idiomatic expressions, sarcasm, emojis, jargon, terms unique to your dialect, or language that is more difficult than it needs to be. +* **Geography**: when referencing places, be specific. Does "south-west" mean Valencia? Canada? Africa? Always write out the full name of the area the first time you use it. +* **Multi-lingual**: when choosing methods or tools, make choices with multi-lingual readers in mind – especially for textual analysis methods, which may not support other character sets or may only provide intellectually robust results when used on English texts. Where possible, choose approaches that have multi-lingual documentation, or provide multi-lingual references for further reading. This will help our translators. +* **Racial and Ethnic Language**: use racial terminology carefully and with specificity. Historic terms no longer in use should be used only in their historical context and only when necessary. Use racial terms as adjectives and not nouns: white people rather than "whites", an Asian woman rather than "an Asian". Be aware that terms may be understood differently in different countries and what you have learned to be correct or sensitive may be culturally specific to your country (eg, not all people with African ancestry are "African Americans". Some of them are African, or black British, or Caribbean, etc). Likewise, readers in the UK will understand "Asian" (India, Pakistan, Bangladesh) differently than those in North America (eg China, Japan, Vietnam, Thailand). +* **Visual Representations**: choose primary sources, images, figures, and screen shots, considering how they will present themselves to a global audience. + +### Sustainable Writing +*Programming Historian* publishes lessons for the long-term. Please follow these sustainability guidelines when writing: + + * **As General as Possible, but No More**: focus on methodologies and generalities, not software/interface specifics (eg avoid telling users to "click the X button", which may be different in future versions). + * **Reduce Reliance on Unsustainable Elements**: use screenshots sparingly and with purpose. Interfaces change frequently and future readers may be confused. Chose external links with the future in mind. Does the site you are linking to change often? Will it exist in ten years? + * **Specify Versions if they are Important**: be clear about any version-specific details readers will need to know in order to follow your lesson. Eg, do you need Python v.2, or will any version be fine? + * **Point to Documentation**: direct readers to reliable documentation where possible. Provide general guidance on how to find the documentation if new versions are probable in future. + * **Copies of Data**: all data used in lessons must be published with the lesson on *Programming Historian* servers along with your lesson. You must ensure you have the legal right to publish a copy of any data that you use. Data files should use open formats. + +Authors should consult our [lesson retirement policy]({{site.baseurl}}/en/lesson-retirement-policy) for information on how the editorial team manages lessons that have become out-of-date. + +## B. Specific Writing Guidelines +This second section covers more specific matters of writing style, such as which words to use, or how we use punctuation, or what format to use for dates or numbers. Read this section before and after writing your draft. + +### Dates and Time + * For centuries, use eighteenth century not 18th century. Avoid national-centric phrases such as "long eighteenth century" which have specific meaning to British eighteenth century specialists, but not to anyone else. + * For decades, write the 1950s (not "the 1950s" or "the fifties"). + * Compress date sequences as follows; 1816-17, 1856-9, 1854-64. + * For dates written in numeric form, use the format YYYY-MM-DD, which conforms to the standard ISO 8601:2004. This avoids ambiguity. + * Use BCE/CE not BC/AD for dates (eg 325BCE). + * 1am, 6:30pm. Not 10 o’clock. + +### Numbers + * Spell out from one to nine; integers above 10. + * Use a consistent format if the boundary outlined above is crossed within a single sentence (five apples and one hundred oranges; 5 apples and 110 oranges). + * Use commas (not periods/full stops) between groups of three digits in large numbers (32,904 not 32904). Exceptions: page numbers, addresses, in quotation, etc. + * Use numerals for versions (version 5 or v.5) or actual values (eg, 5%, 7″, $6.00). + * Always use the symbol % with numerals rather than the spelled-out word (percent), and make sure it is closed up to number: 0.05%. + * Use [LaTeX formatting for mathematical formulae](https://davidhamann.de/2017/06/12/latex-cheat-sheet/). + * For units of measure, use metric or imperial but be consistent. + +### Headings +Headings should not contain inline code font or style formatting such as bold, italic, or code font. +Headings should always immediately precede body text. Do not follow a heading with an admonition or another heading without some form of introductory or descriptive text. + +### Lists +Typically, we use numbered lists and bulleted lists. List items are sentence-capped. List items should be treated as separate items and should not be strung together with punctuation or conjunctions. + +NOT style: + +* Here is an item, and +* here is another item; and +* here is the final item. + +Style: + +* Here is an item +* Here is another item +* Here is the final item + +Or: + +1. Here is an item +2. Here is another item +3. Here is the final item + +### Punctuation + * **Abbreviation**: spell out all words on first mention. European Union (EU) and then EU. Do not use full points / periods or spaces between initials: BBC, PhD, mph, 4am, etc. + * **Ampersand**: generally speaking, do not use an ampersand in place of the word "and" unless referring to a company or publication that uses it: P&O, *Past & Present*. + * **Apostrophe**: use the possessive 's after singular words or names that end in s – St James's, Jones's, mistress's; use it after plurals that do not end in s: children's, people’s, media's. + * **Brackets / Parentheses**: it is better to use commas or dashes. Use round brackets to introduce explanatory material into a direct quote, eg: He said: "When finished it (the tunnel) will revolutionise travel" or "She said adiós (goodbye)". Place a full stop / period outside a closing bracket if the material inside is not a sentence (like this). (But an independent sentence takes the full stop before the closing bracket.) + * **Colon**: use to introduce lists, tabulations, texts, as in: + * The committee recommends: extending licensing hours to midnight; allowing children on licensed premises; relaxing planning controls on new public houses. + * Use after the name of a speaker for a whole quoted sentence: Mr James Sherwood, chairman of Sealink, said: "We have..." + * Lowercase the first letter after a colon: this is how we do it. + * **Comma**: serial comma (this, that, and the other). + * **Dash**: a useful device to use instead of commas, but not more than one pair per sentence. + * **Ellipsis**: three periods separated from the preceding and following words by a space ( ... ). Use to condense a direct quote (thus the quote "the people sitting in this meeting room deserve a better deal" becomes "the people ... deserve a better deal"). + * **Exclamation Mark**: use only at the end of a direct quote when it is clear that the remark is exclamatory, eg "I hate intolerance!" + * **Full Stop / Period**: use frequently. Sentences should be short, crisp, straightforward. But do not put full stops between initials, after status title (Mx, Dr) or between abbreviations (EU). + * **Hyphen**: use to avoid ambiguity or to form a single idea from two or more words: + * Fractions: two-thirds. + * Most words that begin with anti, non and neo. + * A sum followed by the word worth - £10 million-worth of exports. + * Some titles (director-general, secretary-general, but Attorney General, general secretary etc). The rule is to adopt the usage of the authority which created it + * Avoiding ambiguity (little-used car ... little used car). + * Compass quarters (south-west, north-east). + * **Quotation Marks**: use straight (not curly) quotation marks for direct quotes. Use either single or double quotation marks but be consistent. + +### Capitalisation +The guideline is to use them sparingly in the running prose. Specific rules: + +* **Title Case**: headings and book titles should use title case: "Preparing the Data for Analysis"; *The Pride and the Passion*, etc. +* **Always Capitalized**: + * **Proper Names**: William J. Turkel – unless the person choses to spell their name otherwise (eg "bell hooks"). + * **Artistic, Cultural, Government Organizations, etc**: Museum of the Moving Image, Anne Frank House, Home Office, Agency for Global Media, United Nations. + * **Holidays and Festivals**: Diwali, Hanukkah, Eid-Ul-Adha, Ramadan. +* **Sometimes or Partially Capitalized**: + * **Places**: capitals for countries, regions, recognisable areas (eg, the Middle East, Senegal). Lower case for points of the compass, except where they are used as part of a place name (to reach the North Pole, head north). Further examples include: north-east Kenya, south Brazil, the west, western Canada, the far east, south-east Asia, Central America, Latin America. + * **Historic Events**: first world war, second world war; Crimean/Boer/Vietnam/Gulf war; hundred years war. + * **Religion**: Upper case for Anglican, Baptist, Buddhist, Catholic, Christian, Hindu, Methodist, Muslim, Protestant, Roman Catholic, Sikh, but lower for evangelicals, charismatics, atheists. + * **Holy Books (select)**: + * **Bible**: Capitalise if referring to Old or New Testament. + * **Buddhist**: sutras (sermons) and abhidhamma (analysis and interpretation). For Tibetan Buddhism there are also tantric texts and the Tibetan Book of the Dead. + * **Hindu**: the Śruti texts: Vedas, Samhitas, Brahmanas, Aranyakas, Upanishads; the Vedāngas, Hindu epics, Sutras, Shastras, philosophical texts, the Puranas, the Kāvya, the Bhasyas, many Nibandhas. + * **Judaism**: the Tanakh (Torah, Nevi'im, Ketuvim), Talmud (Mishnah, Gemara) + * **Qu'ran**: Capitalise. Texts include the Hadith, the Tawrat (Torah), Zabur (possibly Psalms), Injil (1.2 billion). + * **Sikh**: Adi Granth (commonly called the Guru Granth Sahib), the Dasam Granth, the Varan Bhai Gurdas, the texts of Bhai Nand Lal. + * **Jobs**: Capitalise the title when used with the name – President Macron but not as a description – Emmanuel Macron, president of France. The Pope and the Queen have capital letters. + * **Organisations and Institutions**: the Government (cap in all references), the Cabinet (cap in all references), the Church of Ireland ("the church"), the Department of Education and Science ("the department"), Western University ("the university"), the Court of Appeal ("the appeal court" or "the court"). + * **Universities and Colleges**: Capitals for institution, lower case for departments ("Australian National University department of medieval history"). + * **Religious Institutions, Hospitals and Schools**: cap up the proper or place name, lower case the rest eg Nurture Hillandale rehabilitation hospital, Vernon county primary school, Ali Pasha’s mosque. +* **Always Lowercase**: + * **Committees, Reports and Inquiries**: committee on climate change, trade and industry committee, royal commission on electoral reform + * **Agencies, Commissions, Public Bodies, Quangos**: benefits agency, crown prosecution service, customs and excise, parole board + * **Seasons**: spring, summer, autumn/fall, winter. + * **Currencies**: euro, franc, mark, sterling, dong etc + +### References +* Links rather than endnotes may be appropriate in most cases. +* Ensure linked phrases are semantically meaningful. Do not link terms that are meaningful only to sighted users such as "click here". +* All traditionally published and academic literature should be end-noted rather than linked. +* If you are writing an "analysis" tutorial, you must refer to published scholarly literature. +* Endnote superscripts should be outside the final punctuation like this.² Not inside like this². +* Use the "Notes and Bibliography" system found in the [*The Chicago Manual of Style*, 17th Edition](https://www.chicagomanualofstyle.org/tools_citationguide/citation-guide-1.html) for endnotes. +* On first mention of a published work, include author name (including first/given name). For example, "You can find more information in *The Elements of Typographic Style* by Robert Bringhurst," or "For more information, consult Robert Bringhurt’s *The Elements of Typographic Style*." On subsequent references, just use the book title. Author’s names can be shortened to surname only on subsequent use. +* Endnotes should not just contain a URL. + * (Correct): Grove, John. "Calhoun and Conservative Reform." *American Political Thought* 4, no. 2 (2015): 203–27. https://doi.org/10.1086/680389. + * (Incorrect): https://doi.org/10.1086/680389 + + +### Challenging Words Explained + + * **Collective Nouns** (group, family, cabinet, etc) take singular or plural verb according to meaning: the family was shocked, the family were sitting down, scratching their heads. + * **Less or Fewer?** Less means less in quantity, (less money); fewer means smaller in number, (fewer coins). + * **Over or More Than?** Over and under answer the question "how much?"; more than and fewer than answer the question "how many?": she is over 18, there were more than 20,000 at the game. + * **That or Which?** that defines, which informs: this is the house that Jack built, but this house, which Jack built, is now falling down. + +## C. Formatting Guidelines +This final section covers matters of formatting for submission. Read this section before and after writing your draft. If you get any of these elements wrong, you will be able to correct them when we post a live preview of your lesson at the start of the peer review process. + +### Write in Markdown +All lessons must be written in [Markdown](https://en.wikipedia.org/wiki/Markdown). A template for writing your lessons has been provided. + +* [Download the English Language Lesson template (.md)]({{site.baseurl}}/en/lesson-template.md). + +Markdown is a mark-up language that is best created with a text editor. MS Word and Open Office are NOT text editors and should be avoided. We recommend [Atom](https://atom.io/), [TextWrangler](https://www.barebones.com/products/textwrangler/), [TextEdit](https://en.wikipedia.org/wiki/TextEdit), [MacDown](https://macdown.uranusjr.com/) or [Notepad++](https://notepad-plus-plus.org/download). +For a gentle introduction to Markdown formatting see [Getting Started with Markdown]({{site.baseurl}}/en/lessons/getting-started-with-markdown), or the concise reference [GitHub Guide to Markdown](https://guides.github.com/features/mastering-markdown/). + +Your lesson should be saved in .md format. Your lesson filename becomes part of the lesson URL. Therefore, it should be named according to the following rules: + + * A short, lowercase, descriptive name that gives a clear indication of the lesson contents (eg. getting-started-with-markdown.md). + * Do not use spaces or underscores in the filename; use hyphens instead. + * Use a keyword-rich filename that includes key technologies or methods (eg, Python or Sentiment Analysis). + +### Bold, Italics, and Underline +To ensure consistency across lessons, adhere to the following text formatting guidelines: + +#### Bold + * Bold is not used except in exceptional circumstances. + * Bold is formatted using **\*\*double asterisks\*\***. + +#### Italics + * Use italics for book titles, films, TV programmes, paintings, songs, albums, and websites. + * Never use italics for business names (the *Facebook* website is owned by Facebook). + * Do not use italics in headlines, even if referring to a book title. + * Italics are formatted using *\*single asterisks\**. + +#### Underline + * Underline is not used. + + +### Alerts and Warnings +If you want to include an aside or a warning to readers, you can set it apart from the main text: + +``` +
+ Be sure that you follow directions carefully! +
+``` + +### Figures and Images +Images can help readers understand your lesson steps, but should not be used for decoration. If you wish to use images in your lesson, label them sequentially LESSON-NAME1.jpg, LESSON-NAME2.jpg, etc. Refer to them in the text as "Figure 1", "Figure 2", and so on. All figures must come with a concise figure caption and endnotes where appropriate. You must have the legal right to post any images. + +Use web-friendly file formats such as .png or .jpg and reduce large images to a maximum of 840px on the longest side. This is important for readers in countries with slower internet speeds. + +Images should be saved in a folder with the same name as your lesson .md file. The editor assigned to your lesson can assist you in uploading your images when you submit. + +To insert an image in your text, use the following format: + +{% raw %} +``` markdown +{% include figure.html filename="IMAGE-FILENAME" caption="YOUR CAPTION USING \"ESCAPED\" QUOTES" %} +``` +{% endraw %} + +Note that internal quotation marks in your caption must be escaped with a backslash, as in the example above. Images may not appear in previews of your lesson, but your editor will ensure they render properly when the lesson is published. + +### Code Examples +Lines of code should be formatted to distinguish them clearly from prose: + + * Lines of code should be maximum 80 characters + * Multi-line code blocks should be enclosed in three \`\`\`back-ticks\`\`\`. + * Inline code (rarely used) can be enclosed in single \`backticks\`. + + +``` +They will look like this +``` +` and this ` respectively. + +-- +Follow best practice in writing your code: + +* **Variable and Function Names**: variable names should be nouns (eg "counter") and function names should be verbs (eg "createFile"). Choose names that are concise and meaningful. You may use [snake_case](https://en.wikipedia.org/wiki/Snake_case) or [camelCase](https://en.wikipedia.org/wiki/Camel_case), but be consistent. +* **User Commands**: when writing about text you want the reader to replace with their own information, use FULL CAPS and enclose by ` backticks ` (eg, \`USERNAME HERE\`). +* **Filenames**: filenames that you ask your reader to create or use should be enclosed in `backticks` when mentioned in the text and should include their file extension. Choose names that are concise and meaningful. You may use [snake_case](https://en.wikipedia.org/wiki/Snake_case) or [camelCase](https://en.wikipedia.org/wiki/Camel_case), but be consistent (eg, `data.txt`, `cleanData.py` etc). +* **Reserved Words**: words that are part of a programming language should always be formatted as `code` using `back-ticks` in the running prose. A list of reserved words in common programming languages include: + +#### JavaScript: + +`abstract`, `arguments`, `await`, `Boolean`, `break`, `byte`, `case`, `catch`, `char`, `class`, `const`, `continue`, `debugger`, `default`, `delete`, `do`, `double`, `else`, `enum`, `eval`, `export`, `extends`, `false`, `final`, `finally`, `float`, `for`, `function`, `goto`, `if`, `implements`, `import`, `in`, `instanceof`, `int`, `interface`, `let`, `long`, `native`, `new`, `null`, `package`, `private`, `protected`, `public`, `return`, `short`, `static`, `super`, `switch`, `synchronized`, `this`, `throw`, `throws`, `transient`, `true`, `try`, `typeof`, `var`, `void`, `volatile`, `while`, `with`, `yield`. + +#### Python 2: +`and`, `as`, `assert`, `break`, `class`, `continue`, `def`, `del`, `elif`, `else`, `except`, `exec`, `finally`, `for`, `from`, `global`, `if`, `import`, `in`, `is`, `lambda`, `not`, `or`, `pass`, `print`, `raise`, `return`, `try`, `while`, `with`, `yield`. + +#### Python 3: +`and`, `as`, `assert`, `break`, `class`, `continue`, `def`, `del`, `elif`, `else`, `except`, `False`, `finally`, `for`, `from`, `global`, `if`, `import`, `in`, `is`, `lambda`, `nonlocal`, `None`, `not`, `or`, `pass`, `raise`, `return`, `True`, `try`, `while`, `with`, `yield`. + +#### R: +`break`, `else`, `for`, `FALSE`, `function`, `if`, `in`, `Inf`, `NA`, `NA_character_`, `NA_complex_`, `NA_integer_`, `NA_real_`, `NaN`, `next`, `NULL`, `repeat`, `TRUE`, `while`. + + +## Step 3: Submitting a New Lesson + +Double-check that your lesson file has been prepared to the above specifications. Once you are satisfied, we strongly recommend that you ask at least two people to try your tutorial and provide feedback. This will help you make improvements that mean our peer reviewers can focus on helping you produce the strongest possible lesson. + +You are ready to submit the lesson for peer review. Submissions are made to our peer review site on [Github](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/lessons). + +1. **Getting Access**: create a [free Github account](https://github.com/join). Email your Github username to your editor who will give you upload access to our submission site. Let the editor know the file name of your lesson and if you have any images or data files accompanying your tutorial. +3. **Uploading your Lesson**: once your editor confirms you have been granted access to the site, upload your lesson to the [lessons folder](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/lessons). If you need help, see [GitHub's instructions](https://help.github.com/articles/adding-a-file-to-a-repository/). +4. **Uploading Images**: if your lesson includes images, make sure all of the files are named according to the naming conventions specified above. Your editor will have created a folder for you to upload your images in the [images directory](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images). This folder should have the same name as your lesson filename. Upload your images to this folder. If you don't see it, please contact your editor and wait for instructions. +5. **Uploading Data**: if your lesson includes data files, they should similarly be uploaded to a similarly named folder in the [assets directory](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets). +6. **Email your editor** to let them know that you have uploaded your files. + + +## The Peer Review Process + +Your editor will check that your files have been uploaded and formatted properly. At this stage you will be sent a preview link where any formatting errors will be evident and you can fix them. + +The peer review will be recorded on a Github "[ticket](https://github.com/programminghistorian/ph-submissions/issues)", which acts like an open message board discussion. Be aware that our peer review happens in public and remains publicly available as a permanent record of peer review. If you have concerns or would like to request a closed review, contact your assigned editor. + +The peer review process normally happens in 3 stages: + +1) The editor assigned to your lesson will carefully read and try your lesson, providing a first round of feedback that you will be asked to respond to. The purpose of this first round of feedback is to ensure that your lesson addresses the needs of *Programming Historian* readers, and to make sure that the external peer reviewers receive a lesson that works. You will normally be given one month to respond to this first peer review. + +2) The editor will then open the lesson for formal peer review. This will include at least two reviewers invited by the editor, and may also include comments from the wider community, who are welcome to contribute views. We generally try to ask reviewers to provide their comments within one month, but sometimes unforeseen circumstances mean this is not possible. The editor should make it clear to you that you should not respond to reviews until after both reviews have been published and the editor has summarised and provided clear instructions for moving forward. In some cases this may be a suggestion to substantially revise or rethink the lesson. In other cases it will be a matter of making some changes. Depending on the peer review comments, and the nature of issues raised, you may need to revise the tutorial more than once, but the editor will endeavour to ensure that you are given a clear pathway towards publication. You always have the option of withdrawing from the review process if you so choose. + +3) Once your editor and peer reviewers are happy with the piece, the editor will recommend publication to the Managing Editor, who will read the piece to ensure that it meets our Author's Guidelines and standards. In some cases there may be additional revisions or copy editing at this stage to bring the piece in line with our publishing standards. If the Managing Editor is happy with the piece, it will be moved to the live site for publication. Your editor will inform you of any additional information required at this stage. + +You may find it helpful to read our [editor guidelines](/editor-guidelines), which detail our editorial process. + +If at any point you are unsure of your role or what to do next, post a question to the peer review issue. One of our editors will respond as soon as possible. We endeavour to respond to all queries within a few days. + +### Holding Us to Account + +Our team of volunteers works hard to provide a rigourous, collegial, and efficient peer review for authors. However, we recognize that there are times when we may fall short of expectations. We want authors to feel empowered to hold us to high standards. If, for whatever reason, you feel that you have been treated unfairly, that you are unhappy or confused by the process, that the review proess has been unnecessarily delayed, that a reviewer has been rude, that your editor has not been responsive enough, or have any other concern, please bring it to our attention so we can address it proactively. + +Raising a concern will NOT negatively affect the outcome of your peer review - even a peer review in progress. + +To raise a concern, please contact one of the following parties, chosing whomever you feel most comfortable approaching. + +* Your assigned editor +* The managing editor +* Our independent ombudsperson, [Amanda Visconti](/project-team) + +We hope you don't find yourself in a situation in which you are unhappy, but if you do, we thank you for helping us to improve. + +--- + +This style guide was created with support from the School of Humanities, University of Hertfordshire. From c828e10013b81722e63e322f24075f519a89b3d2 Mon Sep 17 00:00:00 2001 From: mariajoafana Date: Wed, 13 May 2020 18:07:59 -0500 Subject: [PATCH 2/9] Update guia-para-autores-en-proceso --- es/guia-para-autores-en-proceso | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/es/guia-para-autores-en-proceso b/es/guia-para-autores-en-proceso index 61b4b53364..3a97fc5aa9 100644 --- a/es/guia-para-autores-en-proceso +++ b/es/guia-para-autores-en-proceso @@ -34,27 +34,27 @@ Si su propuesta es aceptada, un editor creará una página de "Propuesta" en nue Durante este período de 90 días, su punto de contacto será el jefe de redacción o un editor delegado según pa prerrogativa del jefe de redacción. -## Paso 2: Writing and Formatting a New Lesson -This style guide lays out a set of standards for authors to use when creating or translating English-language lessons for *Programming Historian*. By using it, you help us ensure content is consistent and accessible. +## Paso 2: Escribir y formatear el tutorial +Esta guía de estilo establece un conjunto de normas para que los autores las utilicen al crear o traducir las lecciones en español para *Programming Historian*. Al usarla, nos ayudas a asegurar que el contenido sea consistente y accesible. -It is presented in three sections which should be read before and after writing: +Se presenta en tres secciones que deben ser leídas antes y después de la escritura: -* A. Style and Audience -* B. Specific Style Guidelines -* C. Formatting Guidelines +* A. Estilo y audiencia +* B. Directrices de estilo específicas +* C. Guía de formato -## A. Style and Audience -This first section is concerned with big-picture matters of style which will help you make decisions that meet the needs of our audience and editors. They include basic information on style and tone, open access and open source values, information on writing for a global audience, writing sustainably, and making smart choices about data used in lessons. Read this section when planning your lesson. Read it again before submitting to make sure your lesson meets these requirements. +## A. Estilo y audiencia +Esta primera sección se ocupa de cuestiones de estilo generales que te ayudarán a tomar decisiones que satisfagan las necesidades de nuestra audiencia y editores. Incluimos información básica sobre el estilo y el tono, el acceso abierto y los valores del código abierto, información sobre la escritura para una audiencia global, la escritura sostenible y la toma de decisiones inteligentes sobre los datos utilizados en las lecciones. Lea esta sección cuando planifique su lección. Léala de nuevo antes de enviarla para asegurarse de que el tutorial cumple con estos requisitos. -### Language and Style -* Tutorials should not exceed 8,000 words (including code). -* Keep your tone formal but accessible. -* Talk to your reader in the second person (you). -* Adopt a widely-used version of English (British, Canadian, Indian, South African etc). -* The piece of writing is a "tutorial" or a "lesson" and not an "article". +### Lenguaje y estilo +* Los tutoriales no deben exceder las 8.000 palabras (incluyendo el código). +* Mantén un tono formal pero accesible. +* Hable con su lector en segunda persona (usted). +* Adopte una versión ampliamente utilizado del español (REVISAR). +* El escrito es un "tutorial" o una "lección" y no un "artículo". -### Open Source, Open Access -*Programming Historian* is committed to open source values. All lessons must use open source programming languages and software whenever possible. This policy is meant to minimize costs for all parties, and to allow the greatest possible level of participation. +### Código abierto, acceso abierto +*Programming Historian* está comprometido con los valores del código abierto. Todas las lecciones deben usar lenguajes de programación y software de código abierto siempre que sea posible. Esta política tiene por objeto reducir al mínimo los costos para todas las partes y permitir el mayor nivel de participación posible. Upon acceptance, you agree to publish your lesson under a Creative Commons "[CC-BY](https://creativecommons.org/licenses/by/4.0/deed.en)" license. From 3e3494f24a68ada159a22807048e497301e88846 Mon Sep 17 00:00:00 2001 From: mariajoafana Date: Sun, 17 May 2020 07:41:21 -0500 Subject: [PATCH 3/9] Update guia-para-autores-en-proceso --- es/guia-para-autores-en-proceso | 50 ++++++++++++++++----------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/es/guia-para-autores-en-proceso b/es/guia-para-autores-en-proceso index 3a97fc5aa9..add24449a2 100644 --- a/es/guia-para-autores-en-proceso +++ b/es/guia-para-autores-en-proceso @@ -1,5 +1,5 @@ --- -title: Guía para autores y traducotres +title: Guía para autores y traductores layout: blank redirect_from: - /new-lesson-workflow @@ -56,38 +56,38 @@ Esta primera sección se ocupa de cuestiones de estilo generales que te ayudará ### Código abierto, acceso abierto *Programming Historian* está comprometido con los valores del código abierto. Todas las lecciones deben usar lenguajes de programación y software de código abierto siempre que sea posible. Esta política tiene por objeto reducir al mínimo los costos para todas las partes y permitir el mayor nivel de participación posible. -Upon acceptance, you agree to publish your lesson under a Creative Commons "[CC-BY](https://creativecommons.org/licenses/by/4.0/deed.en)" license. +Una vez aceptada la lección, usted acepta publicar su lección bajo una licenicia Creative Commons"[CC-BY](https://creativecommons.org/licenses/by/4.0/deed.es)". -### Write for a Global Audience -*Programming Historian* readers live all around the world. Authors can and should take steps to write their lesson accessibly for as many people as possible. Follow these global-facing guidelines: +### Escriba para una audiencia global +Los lectores de *Programming Historian* viven en todo el mundo. Los autores pueden y deben tomar medidas para escribir su lección de forma accesible para el mayor número de personas posible. Siga estas directrices de cara a una audiencia global: -* Write for someone who doesn't live in your country or share your beliefs. +* Escriba para alguien que no viva en su país o que no comparta sus creencias. -* **Technical Terms:** should always be linked to [Wikipedia](https://www.wikipedia.org/) or a suitably reliable dictionary or sustainable website in the first instance. A technical term is any word that a person on the street may not know or understand. -* **Cultural References**: mentions of persons, organisations, or historical details should always come with contextual information. Assume no prior knowledge, even of widely known cultural references (eg, [the Beatles](https://en.wikipedia.org/wiki/The_Beatles)). Use generic terms rather than trademarks (tissue rather than Kleenex). Links to [Wikipedia](https://www.wikipedia.org/) should be used liberally. Be aware that historical events often have different names in different countries. -* **Idioms**: Avoid jokes, puns, plays on words, idiomatic expressions, sarcasm, emojis, jargon, terms unique to your dialect, or language that is more difficult than it needs to be. -* **Geography**: when referencing places, be specific. Does "south-west" mean Valencia? Canada? Africa? Always write out the full name of the area the first time you use it. -* **Multi-lingual**: when choosing methods or tools, make choices with multi-lingual readers in mind – especially for textual analysis methods, which may not support other character sets or may only provide intellectually robust results when used on English texts. Where possible, choose approaches that have multi-lingual documentation, or provide multi-lingual references for further reading. This will help our translators. -* **Racial and Ethnic Language**: use racial terminology carefully and with specificity. Historic terms no longer in use should be used only in their historical context and only when necessary. Use racial terms as adjectives and not nouns: white people rather than "whites", an Asian woman rather than "an Asian". Be aware that terms may be understood differently in different countries and what you have learned to be correct or sensitive may be culturally specific to your country (eg, not all people with African ancestry are "African Americans". Some of them are African, or black British, or Caribbean, etc). Likewise, readers in the UK will understand "Asian" (India, Pakistan, Bangladesh) differently than those in North America (eg China, Japan, Vietnam, Thailand). -* **Visual Representations**: choose primary sources, images, figures, and screen shots, considering how they will present themselves to a global audience. +* **Términos técnicos:** siempre deben estar vinculados a [Wikipedia](https://es.wikipedia.org/) o a un diccionario fiable o a un sitio web sostenible en primera instancia. Un término técnico es cualquier palabra que una persona en la calle puede no conocer o entender. +* **Referencias culturales**: las menciones A personas, organizaciones o detalles históricos deben acompañarse siempre con información contextual. No hay que suponer ningún conocimiento previo, incluso de referencias culturales ampliamente conocidas (por ejemplo, [the Beatles](https://en.wikipedia.org/wiki/The_Beatles)). Use términos genéricos en lugar de marcas comerciales (pañuelo en lugar de Kleenex) Los enlaces a [Wikipedia](https://es.wikipedia.org/) deben ser usados libremente. +* **Modismos**: Evite bromas, juegos de palabras, expresiones idiomáticas, sarcasmo, emojis, jerga, términos exclusivos de su dialecto, o lenguaje que sea más difícil de lo necesario. +* **Geografía**: cuando haga referencia a los lugares, sea específico. ¿"Sudoeste" significa Valencia? ¿Canadá? ¿Africa? Escriba siempre el nombre completo del área la primera vez que la use. +* **Multi-idioma**: al elegir los métodos o instrumentos, haga sus elecciones teniendo en cuenta a los lectores multilingües, especialmente en el caso de los métodos de análisis textual, que pueden no ser compatibles con otros conjuntos de caracteres o que sólo pueden proporcionar resultados intelectualmente sólidos cuando se utilizan en textos en inglés. Cuando sea posible, elija enfoques que tengan documentación multilingüe, o proporcione referencias multilingües para su lectura posterior. Esto ayudará a nuestros traductores. +* **Lenguaje racial y étnico**: use la terminología racial cuidadosamente y con especificidad. Los términos históricos que ya no se utilizan deben usarse sólo en su contexto histórico y sólo cuando sea necesario. Usar los términos raciales como adjetivos y no como sustantivos: personas blancas en lugar de "blancos", una mujer asiática en lugar de "un asiático". Tenga en cuenta que los términos pueden entenderse de manera diferente en los distintos países y que lo que ha aprendido a ser correcto o sensible puede ser culturalmente específico de su país (por ejemplo, no todas las personas de ascendencia africana son "afroamericanos". Algunos de ellos son africanos, o negros británicos, o caribeños, etc.). Asimismo, los lectores del Reino Unido entenderán el término "asiático" (India, Pakistán, Bangladesh) de manera diferente a los de América del Norte (por ejemplo, China, Japón, Vietnam, Tailandia). +* **Representaciones visualess**: elija las fuentes primarias, imágenes, figuras y capturas de pantalla, teniendo en cuenta cómo se presentarán a una audiencia global. -### Sustainable Writing -*Programming Historian* publishes lessons for the long-term. Please follow these sustainability guidelines when writing: +### Escritura sostenible +*Programming Historian* publica lecciones para el largo plazo. Por favor, siga estas directrices de sostenibilidad cuando escriba: - * **As General as Possible, but No More**: focus on methodologies and generalities, not software/interface specifics (eg avoid telling users to "click the X button", which may be different in future versions). - * **Reduce Reliance on Unsustainable Elements**: use screenshots sparingly and with purpose. Interfaces change frequently and future readers may be confused. Chose external links with the future in mind. Does the site you are linking to change often? Will it exist in ten years? - * **Specify Versions if they are Important**: be clear about any version-specific details readers will need to know in order to follow your lesson. Eg, do you need Python v.2, or will any version be fine? - * **Point to Documentation**: direct readers to reliable documentation where possible. Provide general guidance on how to find the documentation if new versions are probable in future. - * **Copies of Data**: all data used in lessons must be published with the lesson on *Programming Historian* servers along with your lesson. You must ensure you have the legal right to publish a copy of any data that you use. Data files should use open formats. + * **Tan general como sea posible, pero no más**: concéntrese en las metodologías y generalidades, no en los programas informáticos/interfaces específicos (por ejemplo, evite decir a los usuarios que "hagan clic en el botón X", que puede ser diferente en versiones futuras). + * **Reducir la dependencia de elementos insostenibles**: utilice capturas de pantalla con moderación y con un propósito. Las interfaces cambian con frecuencia y los futuros lectores pueden confundirse. Elija los enlaces externos teniendo en cuenta el futuro. ¿Cambia a menudo el sitio al que se enlaza? ¿Existirá dentro de diez años? + * **Especifique las versiones si son importantes**: sea claro acerca de los detalles específicos de las versiones que los lectores necesitarán saber para poder seguir su lección. Por ejemplo, ¿necesita Python v.2, o cualquier versión estará bien? + * **Refiera a la documentación**: dirija a los lectores a una documentación fiable cuando sea posible. Proporcione una guía general sobre cómo encontrar la documentación si es probable que haya nuevas versiones en el futuro. + * **Copias de datos**: todos los datos utilizados en las lecciones deben ser publicados con la lección en los servidores de *Programming Historian* junto con su lección. Asegúrese de tener el derecho legal de publicar una copia de cualquier dato utilizado. Los archivos de datos deben utilizar formatos abiertos. -Authors should consult our [lesson retirement policy]({{site.baseurl}}/en/lesson-retirement-policy) for information on how the editorial team manages lessons that have become out-of-date. +Los autores deben consultar nuestra [política de retirada de lecciones]({{site.baseurl}}/es/politica-retirada-lecciones) para información sobre cómo el equipo editorial maneja las lecciones que se han vuelto obsoletas. -## B. Specific Writing Guidelines -This second section covers more specific matters of writing style, such as which words to use, or how we use punctuation, or what format to use for dates or numbers. Read this section before and after writing your draft. +## B. Pautas específicas de escritura +En esta segunda sección se tratan cuestiones más específicas del estilo de escritura, como qué palabras utilizar, o cómo usar la puntuación, o qué formato utilizar para las fechas o los números. Lea esta sección antes y después de escribir su borrador. -### Dates and Time - * For centuries, use eighteenth century not 18th century. Avoid national-centric phrases such as "long eighteenth century" which have specific meaning to British eighteenth century specialists, but not to anyone else. - * For decades, write the 1950s (not "the 1950s" or "the fifties"). +### Fechas y hora + * Para siglos utilice siglo dieciocho y no siglo XVIII. Evite frases centradas en lo nacional, como "largo siglo XVIII", que tienen un significado específico para los especialistas británicos del siglo XVIII, pero para nadie más. + * Para décadas escriba For decades, write the 1950s (not "the 1950s" or "the fifties"). * Compress date sequences as follows; 1816-17, 1856-9, 1854-64. * For dates written in numeric form, use the format YYYY-MM-DD, which conforms to the standard ISO 8601:2004. This avoids ambiguity. * Use BCE/CE not BC/AD for dates (eg 325BCE). From 4f25e23e19396377e5194b9845e3afa6a3018847 Mon Sep 17 00:00:00 2001 From: mariajoafana Date: Sun, 17 May 2020 12:29:54 -0500 Subject: [PATCH 4/9] Update guia-para-autores-en-proceso --- es/guia-para-autores-en-proceso | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/es/guia-para-autores-en-proceso b/es/guia-para-autores-en-proceso index add24449a2..7c3dafe5fb 100644 --- a/es/guia-para-autores-en-proceso +++ b/es/guia-para-autores-en-proceso @@ -87,9 +87,9 @@ En esta segunda sección se tratan cuestiones más específicas del estilo de es ### Fechas y hora * Para siglos utilice siglo dieciocho y no siglo XVIII. Evite frases centradas en lo nacional, como "largo siglo XVIII", que tienen un significado específico para los especialistas británicos del siglo XVIII, pero para nadie más. - * Para décadas escriba For decades, write the 1950s (not "the 1950s" or "the fifties"). - * Compress date sequences as follows; 1816-17, 1856-9, 1854-64. - * For dates written in numeric form, use the format YYYY-MM-DD, which conforms to the standard ISO 8601:2004. This avoids ambiguity. + * Para décadas escriba "los años cincuenta" o "los cincuenta" (no "los años 50's" o "la década de los 50s"). + * Comprima las secuencias de fecha así; 1816-17, 1856-9, 1854-64. + * Para fechas escritas en forma numérica utilice el formato DD-MM-AA, which conforms to the standard ISO 8601:2004. This avoids ambiguity. * Use BCE/CE not BC/AD for dates (eg 325BCE). * 1am, 6:30pm. Not 10 o’clock. From bc78a131d1795aad1e502320e608cfb2c13506a0 Mon Sep 17 00:00:00 2001 From: mariajoafana Date: Sun, 17 May 2020 13:18:13 -0500 Subject: [PATCH 5/9] Update guia-para-autores-en-proceso --- es/guia-para-autores-en-proceso | 43 +++++++++++++++++---------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/es/guia-para-autores-en-proceso b/es/guia-para-autores-en-proceso index 7c3dafe5fb..9cca85b928 100644 --- a/es/guia-para-autores-en-proceso +++ b/es/guia-para-autores-en-proceso @@ -77,7 +77,7 @@ Los lectores de *Programming Historian* viven en todo el mundo. Los autores pued * **Tan general como sea posible, pero no más**: concéntrese en las metodologías y generalidades, no en los programas informáticos/interfaces específicos (por ejemplo, evite decir a los usuarios que "hagan clic en el botón X", que puede ser diferente en versiones futuras). * **Reducir la dependencia de elementos insostenibles**: utilice capturas de pantalla con moderación y con un propósito. Las interfaces cambian con frecuencia y los futuros lectores pueden confundirse. Elija los enlaces externos teniendo en cuenta el futuro. ¿Cambia a menudo el sitio al que se enlaza? ¿Existirá dentro de diez años? * **Especifique las versiones si son importantes**: sea claro acerca de los detalles específicos de las versiones que los lectores necesitarán saber para poder seguir su lección. Por ejemplo, ¿necesita Python v.2, o cualquier versión estará bien? - * **Refiera a la documentación**: dirija a los lectores a una documentación fiable cuando sea posible. Proporcione una guía general sobre cómo encontrar la documentación si es probable que haya nuevas versiones en el futuro. + * **Refiérase a la documentación**: dirija a los lectores a una documentación fiable cuando sea posible. Proporcione una guía general sobre cómo encontrar la documentación si es probable que haya nuevas versiones en el futuro. * **Copias de datos**: todos los datos utilizados en las lecciones deben ser publicados con la lección en los servidores de *Programming Historian* junto con su lección. Asegúrese de tener el derecho legal de publicar una copia de cualquier dato utilizado. Los archivos de datos deben utilizar formatos abiertos. Los autores deben consultar nuestra [política de retirada de lecciones]({{site.baseurl}}/es/politica-retirada-lecciones) para información sobre cómo el equipo editorial maneja las lecciones que se han vuelto obsoletas. @@ -90,10 +90,10 @@ En esta segunda sección se tratan cuestiones más específicas del estilo de es * Para décadas escriba "los años cincuenta" o "los cincuenta" (no "los años 50's" o "la década de los 50s"). * Comprima las secuencias de fecha así; 1816-17, 1856-9, 1854-64. * Para fechas escritas en forma numérica utilice el formato DD-MM-AA, which conforms to the standard ISO 8601:2004. This avoids ambiguity. - * Use BCE/CE not BC/AD for dates (eg 325BCE). - * 1am, 6:30pm. Not 10 o’clock. + * Utilice BCE/CE not BC/AD for dates (eg 325BCE). [Asi aparece en la RAE: a. de J. C., a. de C., a. J. C. o a. C. (‘antes de (Jesu)Cristo’) y d. de J. C., d. de C., d. J. C. o d. C. (‘después de (Jesu)Cristo’): 211 a. C., 123 d. C. ] + * 1am, 6:30pm. Not 10 o’clock. [Algunos lineamientos de la RAE: La hora puede expresarse en letras o en números. El modelo de doce horas es el más utilizado cuando la hora se escribe con letras, y el más común en textos literarios y periodísticos. También puede usarse este sistema si se opta por escribir la hora con cifras; pero, en ese caso, : No es recomendable mezclar letras y números; así, es preferible escribir las diez de la noche que las 10 de la noche. para evitar ambigüedades, deben emplearse, tras los números, las abreviaturas a. m. y p.m.] -### Numbers +### Números [revisar lineamientos de la RAE y de autoridades de la lengua en Latinoamerica] * Spell out from one to nine; integers above 10. * Use a consistent format if the boundary outlined above is crossed within a single sentence (five apples and one hundred oranges; 5 apples and 110 oranges). * Use commas (not periods/full stops) between groups of three digits in large numbers (32,904 not 32904). Exceptions: page numbers, addresses, in quotation, etc. @@ -102,24 +102,25 @@ En esta segunda sección se tratan cuestiones más específicas del estilo de es * Use [LaTeX formatting for mathematical formulae](https://davidhamann.de/2017/06/12/latex-cheat-sheet/). * For units of measure, use metric or imperial but be consistent. -### Headings -Headings should not contain inline code font or style formatting such as bold, italic, or code font. -Headings should always immediately precede body text. Do not follow a heading with an admonition or another heading without some form of introductory or descriptive text. +### Encabezados +Los encabezados no deben contener un código de fuente o un formato de estilo como negrita, cursiva o código de fuente. +Los encabezados siempre deben preceder inmediatamente al texto del cuerpo. No ponga después de un encabezado ¿una amonestación? u otro encabezamiento sin alguna forma de texto introductorio o descriptivo. -### Lists -Typically, we use numbered lists and bulleted lists. List items are sentence-capped. List items should be treated as separate items and should not be strung together with punctuation or conjunctions. -NOT style: +### Listas +Típicamente, usamos listas numeradas y listas con viñetas. Los elementos de la lista comienzan con mayúscula. Los elementos de la lista deben ser tratados como elementos separados y no deben ser encadenados con puntuación o conjunciones. -* Here is an item, and -* here is another item; and -* here is the final item. +NO tiene estilo: -Style: +* Acá hay un ítem y +* acá hay otro ítem; y +* acá hay un ítem final. -* Here is an item -* Here is another item -* Here is the final item +Estilo: + +* Acá hay un ítem +* Acá hay otro ítem +* Acá está el último ítem Or: @@ -127,10 +128,10 @@ Or: 2. Here is another item 3. Here is the final item -### Punctuation - * **Abbreviation**: spell out all words on first mention. European Union (EU) and then EU. Do not use full points / periods or spaces between initials: BBC, PhD, mph, 4am, etc. - * **Ampersand**: generally speaking, do not use an ampersand in place of the word "and" unless referring to a company or publication that uses it: P&O, *Past & Present*. - * **Apostrophe**: use the possessive 's after singular words or names that end in s – St James's, Jones's, mistress's; use it after plurals that do not end in s: children's, people’s, media's. +### Puntuación + * **Abreviaturas**: [revisar lineamientos de la RAE: https://www.rae.es/dpd/abreviatura] spell out all words on first mention. European Union (EU) and then EU. Do not use full points / periods or spaces between initials: BBC, PhD, mph, 4am, etc. + * ??? **Ampersand**: generally speaking, do not use an ampersand in place of the word "and" unless referring to a company or publication that uses it: P&O, *Past & Present*. + * **Apóstrofe**: [No recuerdo que en español lo usemos--quitar] use the possessive 's after singular words or names that end in s – St James's, Jones's, mistress's; use it after plurals that do not end in s: children's, people’s, media's. * **Brackets / Parentheses**: it is better to use commas or dashes. Use round brackets to introduce explanatory material into a direct quote, eg: He said: "When finished it (the tunnel) will revolutionise travel" or "She said adiós (goodbye)". Place a full stop / period outside a closing bracket if the material inside is not a sentence (like this). (But an independent sentence takes the full stop before the closing bracket.) * **Colon**: use to introduce lists, tabulations, texts, as in: * The committee recommends: extending licensing hours to midnight; allowing children on licensed premises; relaxing planning controls on new public houses. From e8ed35b3d1ede1c9f94c8335d72a4b349e54a6b8 Mon Sep 17 00:00:00 2001 From: mariajoafana Date: Sun, 17 May 2020 13:26:56 -0500 Subject: [PATCH 6/9] Update guia-para-autores-en-proceso --- es/guia-para-autores-en-proceso | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/es/guia-para-autores-en-proceso b/es/guia-para-autores-en-proceso index 9cca85b928..77299bbac3 100644 --- a/es/guia-para-autores-en-proceso +++ b/es/guia-para-autores-en-proceso @@ -122,23 +122,18 @@ Estilo: * Acá hay otro ítem * Acá está el último ítem -Or: - -1. Here is an item -2. Here is another item -3. Here is the final item ### Puntuación * **Abreviaturas**: [revisar lineamientos de la RAE: https://www.rae.es/dpd/abreviatura] spell out all words on first mention. European Union (EU) and then EU. Do not use full points / periods or spaces between initials: BBC, PhD, mph, 4am, etc. * ??? **Ampersand**: generally speaking, do not use an ampersand in place of the word "and" unless referring to a company or publication that uses it: P&O, *Past & Present*. - * **Apóstrofe**: [No recuerdo que en español lo usemos--quitar] use the possessive 's after singular words or names that end in s – St James's, Jones's, mistress's; use it after plurals that do not end in s: children's, people’s, media's. - * **Brackets / Parentheses**: it is better to use commas or dashes. Use round brackets to introduce explanatory material into a direct quote, eg: He said: "When finished it (the tunnel) will revolutionise travel" or "She said adiós (goodbye)". Place a full stop / period outside a closing bracket if the material inside is not a sentence (like this). (But an independent sentence takes the full stop before the closing bracket.) - * **Colon**: use to introduce lists, tabulations, texts, as in: - * The committee recommends: extending licensing hours to midnight; allowing children on licensed premises; relaxing planning controls on new public houses. - * Use after the name of a speaker for a whole quoted sentence: Mr James Sherwood, chairman of Sealink, said: "We have..." - * Lowercase the first letter after a colon: this is how we do it. - * **Comma**: serial comma (this, that, and the other). - * **Dash**: a useful device to use instead of commas, but not more than one pair per sentence. + * **Apóstrofe**: [No recuerdo que en español lo usemos--quitar, ¿o reemplazar por algo sobre los acentos?] use the possessive 's after singular words or names that end in s – St James's, Jones's, mistress's; use it after plurals that do not end in s: children's, people’s, media's. + * **Corchetes / Paréntesis**: REVISAR LINEAMIENTOS EN ESPAÑOL it is better to use commas or dashes. Use round brackets to introduce explanatory material into a direct quote, eg: He said: "When finished it (the tunnel) will revolutionise travel" or "She said adiós (goodbye)". Place a full stop / period outside a closing bracket if the material inside is not a sentence (like this). (But an independent sentence takes the full stop before the closing bracket.) + * **Dos puntos**: se utilizan para introducir listas, tabulaciones, textos, como en:REVISAR LINEAMIENTOS EN ESPAÑOL + * El comité recomienda: ampliar las horas de licencia hasta la medianoche; permitir a los niños en los locales con licencia; relajar los controles de planificación en los nuevos establecimientos públicos. + * Usar después del nombre de un orador para una frase entera citada: El Sr. James Sherwood, presidente de Sealink, dijo: "Tenemos..." + * La primera letra en minúscula después de un colon: así es como lo hacemos. + * **Coma**: NO EXISTE LA SERIA COMMA EN ESPAÑOL, REVISAR LINEAMIENTOS (this, that, and the other). + * **Guión**: a useful device to use instead of commas, but not more than one pair per sentence. * **Ellipsis**: three periods separated from the preceding and following words by a space ( ... ). Use to condense a direct quote (thus the quote "the people sitting in this meeting room deserve a better deal" becomes "the people ... deserve a better deal"). * **Exclamation Mark**: use only at the end of a direct quote when it is clear that the remark is exclamatory, eg "I hate intolerance!" * **Full Stop / Period**: use frequently. Sentences should be short, crisp, straightforward. But do not put full stops between initials, after status title (Mx, Dr) or between abbreviations (EU). From 7f863293b56bcfb7ab22bb58b42797ecdefd4fa2 Mon Sep 17 00:00:00 2001 From: mariajoafana Date: Sun, 17 May 2020 18:15:25 -0500 Subject: [PATCH 7/9] Update guia-para-autores-en-proceso --- es/guia-para-autores-en-proceso | 210 ++++++++++++++++---------------- 1 file changed, 105 insertions(+), 105 deletions(-) diff --git a/es/guia-para-autores-en-proceso b/es/guia-para-autores-en-proceso index 77299bbac3..bcfd4257d4 100644 --- a/es/guia-para-autores-en-proceso +++ b/es/guia-para-autores-en-proceso @@ -127,7 +127,7 @@ Estilo: * **Abreviaturas**: [revisar lineamientos de la RAE: https://www.rae.es/dpd/abreviatura] spell out all words on first mention. European Union (EU) and then EU. Do not use full points / periods or spaces between initials: BBC, PhD, mph, 4am, etc. * ??? **Ampersand**: generally speaking, do not use an ampersand in place of the word "and" unless referring to a company or publication that uses it: P&O, *Past & Present*. * **Apóstrofe**: [No recuerdo que en español lo usemos--quitar, ¿o reemplazar por algo sobre los acentos?] use the possessive 's after singular words or names that end in s – St James's, Jones's, mistress's; use it after plurals that do not end in s: children's, people’s, media's. - * **Corchetes / Paréntesis**: REVISAR LINEAMIENTOS EN ESPAÑOL it is better to use commas or dashes. Use round brackets to introduce explanatory material into a direct quote, eg: He said: "When finished it (the tunnel) will revolutionise travel" or "She said adiós (goodbye)". Place a full stop / period outside a closing bracket if the material inside is not a sentence (like this). (But an independent sentence takes the full stop before the closing bracket.) + * **Corchetes / Paréntesis**: REVISAR LINEAMIENTOS PARA EL ESPAÑOL it is better to use commas or dashes. Use round brackets to introduce explanatory material into a direct quote, eg: He said: "When finished it (the tunnel) will revolutionise travel" or "She said adiós (goodbye)". Place a full stop / period outside a closing bracket if the material inside is not a sentence (like this). (But an independent sentence takes the full stop before the closing bracket.) * **Dos puntos**: se utilizan para introducir listas, tabulaciones, textos, como en:REVISAR LINEAMIENTOS EN ESPAÑOL * El comité recomienda: ampliar las horas de licencia hasta la medianoche; permitir a los niños en los locales con licencia; relajar los controles de planificación en los nuevos establecimientos públicos. * Usar después del nombre de un orador para una frase entera citada: El Sr. James Sherwood, presidente de Sealink, dijo: "Tenemos..." @@ -146,130 +146,130 @@ Estilo: * Compass quarters (south-west, north-east). * **Quotation Marks**: use straight (not curly) quotation marks for direct quotes. Use either single or double quotation marks but be consistent. -### Capitalisation -The guideline is to use them sparingly in the running prose. Specific rules: - -* **Title Case**: headings and book titles should use title case: "Preparing the Data for Analysis"; *The Pride and the Passion*, etc. -* **Always Capitalized**: - * **Proper Names**: William J. Turkel – unless the person choses to spell their name otherwise (eg "bell hooks"). - * **Artistic, Cultural, Government Organizations, etc**: Museum of the Moving Image, Anne Frank House, Home Office, Agency for Global Media, United Nations. - * **Holidays and Festivals**: Diwali, Hanukkah, Eid-Ul-Adha, Ramadan. -* **Sometimes or Partially Capitalized**: - * **Places**: capitals for countries, regions, recognisable areas (eg, the Middle East, Senegal). Lower case for points of the compass, except where they are used as part of a place name (to reach the North Pole, head north). Further examples include: north-east Kenya, south Brazil, the west, western Canada, the far east, south-east Asia, Central America, Latin America. - * **Historic Events**: first world war, second world war; Crimean/Boer/Vietnam/Gulf war; hundred years war. - * **Religion**: Upper case for Anglican, Baptist, Buddhist, Catholic, Christian, Hindu, Methodist, Muslim, Protestant, Roman Catholic, Sikh, but lower for evangelicals, charismatics, atheists. - * **Holy Books (select)**: - * **Bible**: Capitalise if referring to Old or New Testament. - * **Buddhist**: sutras (sermons) and abhidhamma (analysis and interpretation). For Tibetan Buddhism there are also tantric texts and the Tibetan Book of the Dead. - * **Hindu**: the Śruti texts: Vedas, Samhitas, Brahmanas, Aranyakas, Upanishads; the Vedāngas, Hindu epics, Sutras, Shastras, philosophical texts, the Puranas, the Kāvya, the Bhasyas, many Nibandhas. - * **Judaism**: the Tanakh (Torah, Nevi'im, Ketuvim), Talmud (Mishnah, Gemara) - * **Qu'ran**: Capitalise. Texts include the Hadith, the Tawrat (Torah), Zabur (possibly Psalms), Injil (1.2 billion). - * **Sikh**: Adi Granth (commonly called the Guru Granth Sahib), the Dasam Granth, the Varan Bhai Gurdas, the texts of Bhai Nand Lal. - * **Jobs**: Capitalise the title when used with the name – President Macron but not as a description – Emmanuel Macron, president of France. The Pope and the Queen have capital letters. - * **Organisations and Institutions**: the Government (cap in all references), the Cabinet (cap in all references), the Church of Ireland ("the church"), the Department of Education and Science ("the department"), Western University ("the university"), the Court of Appeal ("the appeal court" or "the court"). - * **Universities and Colleges**: Capitals for institution, lower case for departments ("Australian National University department of medieval history"). - * **Religious Institutions, Hospitals and Schools**: cap up the proper or place name, lower case the rest eg Nurture Hillandale rehabilitation hospital, Vernon county primary school, Ali Pasha’s mosque. +### Mayúsculas +La pauta es usarlos con moderación en la prosa corriente. Reglas específicas: + +* **Títulos**: los encabezados y títulos de libros deben mayúscula en la primera letra del título: "Preparando los datos para el análisis"; *El orgullo y la pasión*, +* **Siempre en mayúscula**: + * **Nombre propios**: William J. Turkel – a menos que la persona elija deletrear su nombre de otra manera (por ejemplo "bell hooks"). + * **Organizaciones artísticas, culturales y gubernamentales, etc**: Museo de Arte Moderno, Casa de Cervantes, Biblioteca Nacional, Agencia Nacional de Tierras, Naciones Unidades. + * **Días festivos y festivales**: Diwali, Hanukkah, Eid-Ul-Adha, Día de los Muertos. +* **A veces o parcialmente en mayúsculas**: + * **Lugares**: capitales de países, regiones, zonas reconocibles (por ejemplo, el Oriente Medio, Senegal). Minúsculas para los puntos cardinales, a excepción de cuando son utilizados como parte del nombre de un lugar (para llegar al Polo Norte, dirigirse al norte). Otros ejemplos son: el noreste de Kenya, el sur del Brasil, el oeste, el oeste del Canadá, el extremo oriental, el Asia sudoriental, América Central, América Latina. + * **Eventos históricos**: la primera letra en mayúscula para primera Guerra Mundial, Segunda Guerra Mundial; Guerra de Crimea/Boer/Vietnam/del Golfo; Guerra de los Cien Años. + * **Religión**: minúscula para anglicano, bautista, budista, católico, cristiano, hindú, metodista, musulmán, protestante, católico romano, sikh, y también para evangélicos, carismáticos, ateos. + * **Libros sagrados (selección)**: + * **Biblia**: mayúscula si se refiere al Antiguo o al Nuevo testamento. + * **Budismo**: sutras (sermones) y abhidhamma (análisis e interpretación). Para el budismo tibetaton tambien hay libros tántricos y Libro tibetano de los muertos. + * **Hinduismo**: los Śruti: Vedas, Samhitas, Brahmanas, Aranyakas, Upanishads; los Vedāngas, épica Hindú, sutras, shastras, textos filosóficos, los Puranas, literatura kāvya, los Bhasyas, muchos nibandhas. + * **Juadismo**: el Tanakh (Torá, Nevi'im, Ketuvim), el Talmud (Mishná, Guemará) + * **Corán**: textos que incluyen los hadiz, el Tawrat (Torá), Zabur (posiblemente salmos), Injil (1.2 billones). + * **Sikh**: Adi Granth (comonmente llamado el Sri Guru Granth Sahib Ji), el Dasam Granth, los Varan Bhai Gurdas, los textos del Bhai Nand Lal. + * **Trabajos**: en minúscula – president Macron, Emmanuel Macron, presidente de France. El ministro de Hacienda. El Papa se escribe con mayúscula y la reina en minúscula. [REVISAR] + * **Organizaciones e instituciones**: el gobierno (en minúscula en toda referencia), el gabinete (minúscula en toda referencia), la Iglesia de Jesucristo de los Santos de los Últimos Días ("la iglesia"), Ministerio de Educación ("el ministerio"), Universidad Católica ("la universidad"), el Tribunal de Apelación ("tribunal de apelación" o "el tribunal"). + * **Universidades e institutos**: mayúsculas para la institución y para departamentos ("Universidad Autónoma de México", Departamento de Historia"). + * **Instituciones religiosas, hospitales y escuelas**: cap up the proper or place name, lower case the rest eg Nurture Hillandale rehabilitation hospital, Vernon county primary school, Ali Pasha’s mosque. * **Always Lowercase**: * **Committees, Reports and Inquiries**: committee on climate change, trade and industry committee, royal commission on electoral reform * **Agencies, Commissions, Public Bodies, Quangos**: benefits agency, crown prosecution service, customs and excise, parole board * **Seasons**: spring, summer, autumn/fall, winter. * **Currencies**: euro, franc, mark, sterling, dong etc -### References -* Links rather than endnotes may be appropriate in most cases. -* Ensure linked phrases are semantically meaningful. Do not link terms that are meaningful only to sighted users such as "click here". -* All traditionally published and academic literature should be end-noted rather than linked. -* If you are writing an "analysis" tutorial, you must refer to published scholarly literature. -* Endnote superscripts should be outside the final punctuation like this.² Not inside like this². -* Use the "Notes and Bibliography" system found in the [*The Chicago Manual of Style*, 17th Edition](https://www.chicagomanualofstyle.org/tools_citationguide/citation-guide-1.html) for endnotes. -* On first mention of a published work, include author name (including first/given name). For example, "You can find more information in *The Elements of Typographic Style* by Robert Bringhurst," or "For more information, consult Robert Bringhurt’s *The Elements of Typographic Style*." On subsequent references, just use the book title. Author’s names can be shortened to surname only on subsequent use. -* Endnotes should not just contain a URL. - * (Correct): Grove, John. "Calhoun and Conservative Reform." *American Political Thought* 4, no. 2 (2015): 203–27. https://doi.org/10.1086/680389. - * (Incorrect): https://doi.org/10.1086/680389 +### Referencias +* Los enlaces en lugar de las notas finales pueden ser apropiados en la mayoría de los casos. +* Asegúrese de que las frases vinculadas tengan un significado semántico. No enlace términos que son significativos sólo para usuarios videntes como "haga clic aquí". +* Toda literatura publicada de manera tradicional y académica debe incluirse como notas al final en lugar de ser enlazada. +* Si está escribiendo un tutorial de "análisis", debe referirse a la literatura académica publicada. +* Los superíndices de las notas finales deben dentro de la puntuación final así². No afuera así.² +* Utilice el sistema de "Notas y Bibliografía" que se encuentra en el [*Manual Chicago Manual 17a edición](https://uc3m.libguides.com/guias_tematicas/citas_bibliograficas/chicago) para las notas al final endnotes. +* Cuando se mencione por primera vez una obra publicada, incluya el nombre del autor (incluyendo el primer nombre). Por ejemplo, "Puede encontrar más información en *The Elements of Typographic Style* de Robert Bringhurst" o "Para más información, consulte *The Elements of Typographic Style* de Robert Bringhurt". En las referencias posteriores, sólo use el título del libro. Los nombres de los autores pueden ser acortados a apellidos sólo en un uso posterior. +* Las notas finales no deberían contener sólo un URL. + * (Correcto): Grove, John. "Calhoun and Conservative Reform." *American Political Thought* 4, no. 2 (2015): 203–27. https://doi.org/10.1086/680389. + * (Incorrecto): https://doi.org/10.1086/680389 -### Challenging Words Explained +### Explicación de palabras difíciles [REVISAR CASOS ESPECÍFICOS PARA EL ESPAÑOL] * **Collective Nouns** (group, family, cabinet, etc) take singular or plural verb according to meaning: the family was shocked, the family were sitting down, scratching their heads. * **Less or Fewer?** Less means less in quantity, (less money); fewer means smaller in number, (fewer coins). * **Over or More Than?** Over and under answer the question "how much?"; more than and fewer than answer the question "how many?": she is over 18, there were more than 20,000 at the game. * **That or Which?** that defines, which informs: this is the house that Jack built, but this house, which Jack built, is now falling down. -## C. Formatting Guidelines -This final section covers matters of formatting for submission. Read this section before and after writing your draft. If you get any of these elements wrong, you will be able to correct them when we post a live preview of your lesson at the start of the peer review process. +## C. Guía de formato +Esta última sección abarca cuestiones de formato para la presentación. Lee esta sección antes y después de escribir tu borrador. Si te equivocas en alguno de estos elementos, podrás corregirlo cuando publiquemos un avance en directo de tu lección al comienzo del proceso de revisión de pares. -### Write in Markdown -All lessons must be written in [Markdown](https://en.wikipedia.org/wiki/Markdown). A template for writing your lessons has been provided. +### Escribe en Markdown +Todas las lecciones deben ser escritas en [Markdown](https://es.wikipedia.org/wiki/Markdown). Se ha proporcionado una plantilla para escribir las lecciones. -* [Download the English Language Lesson template (.md)]({{site.baseurl}}/en/lesson-template.md). +* [Descarga la plantilla para lecciones en español (.md)]({{site.baseurl}}/es/PLANTILLA-PROPUESTA-LECCION.md). -Markdown is a mark-up language that is best created with a text editor. MS Word and Open Office are NOT text editors and should be avoided. We recommend [Atom](https://atom.io/), [TextWrangler](https://www.barebones.com/products/textwrangler/), [TextEdit](https://en.wikipedia.org/wiki/TextEdit), [MacDown](https://macdown.uranusjr.com/) or [Notepad++](https://notepad-plus-plus.org/download). -For a gentle introduction to Markdown formatting see [Getting Started with Markdown]({{site.baseurl}}/en/lessons/getting-started-with-markdown), or the concise reference [GitHub Guide to Markdown](https://guides.github.com/features/mastering-markdown/). +Markdown es un lenguaje de marcado que se crea mejor con un editor de texto. MS Word y Open Office NO son editores de texto y deben ser evitados. Recomendamos [Atom](https://atom.io/), [TextWrangler](https://www.barebones.com/products/textwrangler/), [TextEdit](https://en.wikipedia.org/wiki/TextEdit), [MacDown](https://macdown.uranusjr.com/) o [Notepad++](https://notepad-plus-plus.org/download). +Para una introducción sencilla a Markdown ver [Introducción a Markdown]({{site.baseurl}}/es/lecciones/introduccion-a-markdown), o la referencia concisa [GitHub Guide to Markdown](https://guides.github.com/features/mastering-markdown/). [BUSCAR GUIA EN ESPAÑOL] -Your lesson should be saved in .md format. Your lesson filename becomes part of the lesson URL. Therefore, it should be named according to the following rules: +Tu lección debe ser guardada en formato .md. El nombre del archivo de tu lección se convierte en parte de la URL de la lección, por lo tanto, debe ser nombrado de acuerdo a las siguientes reglas: - * A short, lowercase, descriptive name that gives a clear indication of the lesson contents (eg. getting-started-with-markdown.md). - * Do not use spaces or underscores in the filename; use hyphens instead. - * Use a keyword-rich filename that includes key technologies or methods (eg, Python or Sentiment Analysis). + * Un nombre corto, en minúsculas, descriptivo que de una clara indicación del contenido de la lección (por ejemplo, introduccion-a-markdown.md). + * No utilice espacios ni guiones bajos en el nombre del archivo; utilice en su lugar guiones. + * Utilice un nombre de archivo rico en palabras clave que incluya tecnologías o métodos clave (por ejemplo, Python o Análisis de Sentimientos). + +### Negrita, cursiva y subrayado +Para asegurar la consistencia de las lecciones, sigue las siguientes directrices de formato de texto: -### Bold, Italics, and Underline -To ensure consistency across lessons, adhere to the following text formatting guidelines: +#### Negrita + * La negrita no se usa excepto en circunstancias excepcionales. + * La negrita se formatea utilizando **\*\*doble asterisco\*\***. -#### Bold - * Bold is not used except in exceptional circumstances. - * Bold is formatted using **\*\*double asterisks\*\***. +#### Cursiva +* Usa la cursiva para los títulos de libros, películas, programas de TV, pinturas, canciones, álbumes y sitios web. +* Nunca uses la cursiva para nombres de empresas (el sitio web *Facebook* es propiedad de Facebook). +* No uses la cursiva en los titulares, incluso si se refiere al título de un libro. +* La cursiva se formatea utilizando *\*un asterisco\**. -#### Italics - * Use italics for book titles, films, TV programmes, paintings, songs, albums, and websites. - * Never use italics for business names (the *Facebook* website is owned by Facebook). - * Do not use italics in headlines, even if referring to a book title. - * Italics are formatted using *\*single asterisks\**. +#### Subrayado + * No se utiliza. -#### Underline - * Underline is not used. - - -### Alerts and Warnings -If you want to include an aside or a warning to readers, you can set it apart from the main text: +### Alertas y advertencias +Si quieres incluir un aparte o una advertencia a los lectores, puedes apartarlo del texto principal: ```
- Be sure that you follow directions carefully! +¡Asegúrate se seguir cuidadosamente las instrucciones!
``` -### Figures and Images -Images can help readers understand your lesson steps, but should not be used for decoration. If you wish to use images in your lesson, label them sequentially LESSON-NAME1.jpg, LESSON-NAME2.jpg, etc. Refer to them in the text as "Figure 1", "Figure 2", and so on. All figures must come with a concise figure caption and endnotes where appropriate. You must have the legal right to post any images. +### Figuras e imágenes +Las imágenes pueden ayudar a los lectores a entender los pasos de la lección, pero no deben ser usadas como decoración. Si desea utilizar imágenes en su lección etiquételas secuencialmente LECCIÓN-NOMBRE1.jpg, LECCIÓN-NOMBRE2.jpg, etc. Refiérase a ellas en el texto como "Figura 1", "Figura 2", y así sucesivamente. Todas las figuras deben venir con una leyenda concisa de la figura y notas finales cuando sea apropiado. Debes tener el derecho legal de publicar cualquier imagen. -Use web-friendly file formats such as .png or .jpg and reduce large images to a maximum of 840px on the longest side. This is important for readers in countries with slower internet speeds. +Utilice formatos de archivos amigables para la web como .png o .jpg y reduzca las imágenes grandes a un máximo de 840px en el lado más largo. Esto es importante para los lectores en países con velocidades de Internet más lentas. -Images should be saved in a folder with the same name as your lesson .md file. The editor assigned to your lesson can assist you in uploading your images when you submit. +Las imágenes deben guardarse en una carpeta con el mismo nombre que el archivo .md de la lección. El editor asignado a su lección puede ayudarle a subir sus imágenes cuando las envíe. -To insert an image in your text, use the following format: +Para insertar una imagen en su texto, utilice el siguiente formato: {% raw %} ``` markdown -{% include figure.html filename="IMAGE-FILENAME" caption="YOUR CAPTION USING \"ESCAPED\" QUOTES" %} +{% include figure.html filename="NOMBRE-ARCHIVO-IMAGEN" caption="PIE DE FOTO UTILIZANDO \"ESCAPED\" QUOTES" %} ``` {% endraw %} -Note that internal quotation marks in your caption must be escaped with a backslash, as in the example above. Images may not appear in previews of your lesson, but your editor will ensure they render properly when the lesson is published. +Tenga en cuenta que las comillas internas en su pie de foto deben escaparse con una barra invertida, como en el ejemplo anterior. Es posible que las imágenes no aparezcan en las vistas previas de la lección, pero el editor se asegurará de que se reproduzcan correctamente cuando se publique la lección. -### Code Examples -Lines of code should be formatted to distinguish them clearly from prose: +### Ejemplos de código +Las líneas de código deben tener un formato que las distinga claramente de la prosa: - * Lines of code should be maximum 80 characters - * Multi-line code blocks should be enclosed in three \`\`\`back-ticks\`\`\`. - * Inline code (rarely used) can be enclosed in single \`backticks\`. + * Las líneas de código deben tener un máximo de 80 caracteres + * Los bloques de código multilínea deben estar encerrados en tres \`\`\`comillas-invertidas\`\`\`. + * Líneas de código (raramente usado) puede ser encerrado en una sola \`comilla invertida\`. ``` -They will look like this +Se verán así ``` -` and this ` respectively. +` y así ` respectivamente. + -- -Follow best practice in writing your code: +Sigue las mejores prácticas para escribir tu código: * **Variable and Function Names**: variable names should be nouns (eg "counter") and function names should be verbs (eg "createFile"). Choose names that are concise and meaningful. You may use [snake_case](https://en.wikipedia.org/wiki/Snake_case) or [camelCase](https://en.wikipedia.org/wiki/Camel_case), but be consistent. * **User Commands**: when writing about text you want the reader to replace with their own information, use FULL CAPS and enclose by ` backticks ` (eg, \`USERNAME HERE\`). @@ -290,51 +290,51 @@ Follow best practice in writing your code: `break`, `else`, `for`, `FALSE`, `function`, `if`, `in`, `Inf`, `NA`, `NA_character_`, `NA_complex_`, `NA_integer_`, `NA_real_`, `NaN`, `next`, `NULL`, `repeat`, `TRUE`, `while`. -## Step 3: Submitting a New Lesson +## Paso 3: Enviando una nueva lección -Double-check that your lesson file has been prepared to the above specifications. Once you are satisfied, we strongly recommend that you ask at least two people to try your tutorial and provide feedback. This will help you make improvements that mean our peer reviewers can focus on helping you produce the strongest possible lesson. +Comprueba que tu archivo con la lección ha sido preparado según las especificaciones anteriores. Una vez que estés satisfecho, te recomendamos encarecidamente que pidas al menos a dos personas que prueben tu tutorial y te den su opinión. Esto te ayudará a hacer mejoras que significan que nuestros compañeros de revisión pueden centrarse en ayudarte a producir la lección más sólida posible. -You are ready to submit the lesson for peer review. Submissions are made to our peer review site on [Github](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/lessons). +Estás listo para someter la lección a la revisión de pares. Los envíos se hacen en nuestro sitio de revisión de pares en [Github](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/es/lecciones). -1. **Getting Access**: create a [free Github account](https://github.com/join). Email your Github username to your editor who will give you upload access to our submission site. Let the editor know the file name of your lesson and if you have any images or data files accompanying your tutorial. -3. **Uploading your Lesson**: once your editor confirms you have been granted access to the site, upload your lesson to the [lessons folder](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/lessons). If you need help, see [GitHub's instructions](https://help.github.com/articles/adding-a-file-to-a-repository/). -4. **Uploading Images**: if your lesson includes images, make sure all of the files are named according to the naming conventions specified above. Your editor will have created a folder for you to upload your images in the [images directory](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images). This folder should have the same name as your lesson filename. Upload your images to this folder. If you don't see it, please contact your editor and wait for instructions. -5. **Uploading Data**: if your lesson includes data files, they should similarly be uploaded to a similarly named folder in the [assets directory](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets). -6. **Email your editor** to let them know that you have uploaded your files. +1. **Obtener acceso**: crea una [cuenta gratuita en Github](https://github.com/join). Envía tu usuario de Github a tu editor quien te dará acceso para subir el tutorial al sitio de envíos. Déjale saber al editor el nombre del archivo y si tienes imágenes o archivos de datos que acompañen la lección. +3. **Cargar la lección**: una vez que su editor confirme que te ha dado acceso al sitio, sube su lección a la [carpeta de lecciones](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/es/lecciones). Si necesitas ayuda revisa las [instrucciones de GitHub](https://help.github.com/articles/adding-a-file-to-a-repository/). +4. **Cargar las imágenes**: si tu lección incluye imágenes, asegúrate de que todos los archivos se nombren de acuerdo con las convenciones de nomenclatura especificadas anteriormente. Su editor habrá creado una carpeta para que pueda subir sus imágenes en el [directorio de imágenes](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images). Esta carpeta debe tener el mismo nombre que el archivo de su lección. Suba sus imágenes a esta carpeta. Si no la ves, por favor contacta con tu editor y espera instrucciones. +5. **Cargar los datos**: si su lección incluye archivos de datos éstos deberán cargarse en una carpeta con un nombre similar en el [directorio de "assets"](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets). +6. **Envía un correo electrónico a tu editor** para hacerle saber que has cargado tus archivos. -## The Peer Review Process +## El proceso de revisión de pares -Your editor will check that your files have been uploaded and formatted properly. At this stage you will be sent a preview link where any formatting errors will be evident and you can fix them. +Tu editor comprobará que tus archivos se hayan cargado y formateado correctamente. En esta etapa se te enviará un enlace de vista previa donde se evidenciarán los errores de formato y podrás corregirlos. -The peer review will be recorded on a Github "[ticket](https://github.com/programminghistorian/ph-submissions/issues)", which acts like an open message board discussion. Be aware that our peer review happens in public and remains publicly available as a permanent record of peer review. If you have concerns or would like to request a closed review, contact your assigned editor. +La revisión de pares se registrará en un "[ticket de Github](https://github.com/programminghistorian/ph-submissions/issues)", que actúa como una discusión abierta en el tablero de mensajes. Ten en cuenta que nuestra revisión de pares se realiza en público y se mantiene a disposición del público como un registro permanente de la revisión de pares. Si tienes alguna preocupación o deseas solicitar una revisión cerrada, póngase en contacto con el editor asignado. -The peer review process normally happens in 3 stages: +El proceso de revisión por pares normalmente se realiza en tres etapas: -1) The editor assigned to your lesson will carefully read and try your lesson, providing a first round of feedback that you will be asked to respond to. The purpose of this first round of feedback is to ensure that your lesson addresses the needs of *Programming Historian* readers, and to make sure that the external peer reviewers receive a lesson that works. You will normally be given one month to respond to this first peer review. +1) El editor asignado a tu lección leerá y probará cuidadosamente su lección, proporcionando una primera ronda de retroalimentación a la que se te pedirá que respondas. El propósito de esta primera ronda de retroalimentación es asegurarse de que tu lección responda a las necesidades de los lectores de *Programming Historian*, y asegurarse de que los revisores externos reciban una lección que funcione. Normalmente se te dará un mes para responder a esta primera revisión. -2) The editor will then open the lesson for formal peer review. This will include at least two reviewers invited by the editor, and may also include comments from the wider community, who are welcome to contribute views. We generally try to ask reviewers to provide their comments within one month, but sometimes unforeseen circumstances mean this is not possible. The editor should make it clear to you that you should not respond to reviews until after both reviews have been published and the editor has summarised and provided clear instructions for moving forward. In some cases this may be a suggestion to substantially revise or rethink the lesson. In other cases it will be a matter of making some changes. Depending on the peer review comments, and the nature of issues raised, you may need to revise the tutorial more than once, but the editor will endeavour to ensure that you are given a clear pathway towards publication. You always have the option of withdrawing from the review process if you so choose. +2) El editor abrirá la lección para una revisión formal de pares. Esto incluirá al menos dos revisores invitados por el editor, y también puede incluir comentarios de la comunidad más amplia, que son bienvenidos para contribuir con sus puntos de vista. Por lo general, tratamos de pedir a los revisores que aporten sus comentarios en el plazo de un mes, pero a veces circunstancias imprevistas hacen que esto no sea posible. El editor debe dejarte claro que no debes responder a las reseñas hasta después de que se hayan publicado ambas reseñas y el editor haya resumido y dado instrucciones claras para seguir adelante. En algunos casos esto puede ser una sugerencia para revisar sustancialmente o repensar la lección. En otros casos será cuestión de hacer algunos cambios. En función de los comentarios de la revisión de pares y de la naturaleza de las cuestiones planteadas puede ser necesario revisar el tutorial más de una vez, pero el editor se esforzará por garantizar que se le dé una vía clara para su publicación. Siempre tendrás la opción de retirarse del proceso de revisión si así lo deseas. -3) Once your editor and peer reviewers are happy with the piece, the editor will recommend publication to the Managing Editor, who will read the piece to ensure that it meets our Author's Guidelines and standards. In some cases there may be additional revisions or copy editing at this stage to bring the piece in line with our publishing standards. If the Managing Editor is happy with the piece, it will be moved to the live site for publication. Your editor will inform you of any additional information required at this stage. +3) Una vez que el editor y los revisores estén satisfechos con el artículo, el editor lrecomendará la publicación al Jefe de Redacción, quien leerá el tutorial para asegurarse de que cumpla con nuestras pautas y estándares de autor. En algunos casos puede haber revisiones adicionales o edición de textos en esta etapa para que el artículo se ajuste a nuestras normas de publicación. Si el Jefe de Redacción está satisfecho con el artículo será trasladado al sitio para su publicación. Tu editor te informará de cualquier información adicional que se requiera en esta etapa. -You may find it helpful to read our [editor guidelines](/editor-guidelines), which detail our editorial process. +Puede resultarte útil leer nuestras [guía para editores](es/guia-editor), donde se detalla nuestro proceso editorial. -If at any point you are unsure of your role or what to do next, post a question to the peer review issue. One of our editors will respond as soon as possible. We endeavour to respond to all queries within a few days. +Si en algún momento no estás seguro de tu papel o de lo que debes hacer a continuación, publica una pregunta en el número de revisión de pares. Uno de nuestros editores responderá lo antes posible. Nos esforzamos por responder a todas las preguntas en unos pocos días. -### Holding Us to Account +### Holding Us to Account [no sabría bien cómo traducir esto...] -Our team of volunteers works hard to provide a rigourous, collegial, and efficient peer review for authors. However, we recognize that there are times when we may fall short of expectations. We want authors to feel empowered to hold us to high standards. If, for whatever reason, you feel that you have been treated unfairly, that you are unhappy or confused by the process, that the review proess has been unnecessarily delayed, that a reviewer has been rude, that your editor has not been responsive enough, or have any other concern, please bring it to our attention so we can address it proactively. +Nuestro equipo de voluntarios trabaja duro para proporcionar una rigurosa, colegial y eficiente revisión de pares para autores. Sin embargo, reconocemos que hay momentos en que las expectativas pueden no cumplirse. Queremos que los autores se sientan con el poder de exigirnos altos estándares. Si, por cualquier razón, sientes que has sido tratado injustamente, que está descontento o confundido por el proceso, que el proceso de revisión se ha retrasado innecesariamente, que un revisor ha sido grosero, que tu editor no ha sido lo suficientemente receptivo, o tienes alguna otra inquietud, por favor, déjanos saberpara que podamos abordarlo de manera proactiva. -Raising a concern will NOT negatively affect the outcome of your peer review - even a peer review in progress. +Plantear una preocupación NO afectará negativamente el resultado de su revisión de pares - incluso una revisión de pares en curso. -To raise a concern, please contact one of the following parties, chosing whomever you feel most comfortable approaching. +Para plantear una preocupación, por favor contacta una de las siguientes partes, eligiendo a quien te resulte más cómodo para acercarse. -* Your assigned editor -* The managing editor -* Our independent ombudsperson, [Amanda Visconti](/project-team) +* Tu editor asignado +* El jefe de redacción +* Nuestra ombudsperson independiente, [Silvia Gutiérrez de la Torre](/equipo-de-proyecto) -We hope you don't find yourself in a situation in which you are unhappy, but if you do, we thank you for helping us to improve. +Esperamos que no se encuentre en una situación incómoda, pero si esto sucede te agradecemos que nos ayudes a mejorar. --- -This style guide was created with support from the School of Humanities, University of Hertfordshire. +Esta guía de estilo fue creada con el apoyo de la Escuela de Humanidades de la Universidad de Hertfordshire. La traducción y adaptación al español es producto del trabajo conjunto del equipo en español. From 36ab90c31cf72bf562af48a6836c096affc74b1d Mon Sep 17 00:00:00 2001 From: Riva Quiroga Date: Mon, 25 May 2020 21:53:03 -0400 Subject: [PATCH 8/9] =?UTF-8?q?revisi=C3=B3n=20parcial=20+=20traducci?= =?UTF-8?q?=C3=B3n=20de=20otras=20secciones?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- es/guia-para-autores-en-proceso | 155 ++++++++++++++++---------------- 1 file changed, 77 insertions(+), 78 deletions(-) diff --git a/es/guia-para-autores-en-proceso b/es/guia-para-autores-en-proceso index bcfd4257d4..977583a1f2 100644 --- a/es/guia-para-autores-en-proceso +++ b/es/guia-para-autores-en-proceso @@ -12,7 +12,7 @@ skip_validation: true

Paso 1: Proponer o traducir un tutorial nuevo

Paso 2: Escribir y dar formato a un nuevo tutorial

-

Paso 3: Enviar un nuevo tutorial o traducción

+

Paso 3: Enviar un nuevo tutorial o traducción

Estas directrices han sido desarrolladas para ayudar a entender el proceso de creación de un tutorial para *Programming Historian*. Incluyen detalles prácticos y filosóficos sobre el proceso de redacción del tutorial, así como indicaciones sobre el flujo de trabajo y del proceso de revisión de pares. Si en algún momento no está claro, por favor envíe un correo electrónico al editor jefe {% include managing-editor.html lang=page.lang %}. @@ -30,11 +30,11 @@ Si tienes una idea para una nueva lección, completa una el [formato de propuest Puedes darte una idea de lo que publicamos revisando nuestros [tutoriales publicados]({{site.baseurl}}/es/lecciones), leyendo nuestra [guía para revisores]({{site.baseurl}}/es/guia-para-revisores) u ojeando [los tutoriales en desarrollo](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/es/lecciones). -Si su propuesta es aceptada, un editor creará una página de "Propuesta" en nuestro [sitio de envíos](https://github.com/programminghistorian/ph-submissions/issues) con el título de la lección y los resultados de aprendizaje propuestos. Esto sirve para señalar el trabajo en curso. Para asegurar la publicación oportuna, los autores deben presentar su proyecto de artículo en un plazo de 90 días. +Si su propuesta es aceptada, un editor creará una página de "Propuesta" en nuestro [sitio de envíos](https://github.com/programminghistorian/ph-submissions/issues) con el título de la lección y los resultados de aprendizaje propuestos. Esto sirve para señalar el trabajo en curso. Para asegurar la publicación oportuna, los autores deben presentar su proyecto de artículo en un plazo de 90 días. Durante este período de 90 días, su punto de contacto será el jefe de redacción o un editor delegado según pa prerrogativa del jefe de redacción. -## Paso 2: Escribir y formatear el tutorial +## Paso 2: Escribir y formatear el tutorial Esta guía de estilo establece un conjunto de normas para que los autores las utilicen al crear o traducir las lecciones en español para *Programming Historian*. Al usarla, nos ayudas a asegurar que el contenido sea consistente y accesible. Se presenta en tres secciones que deben ser leídas antes y después de la escritura: @@ -44,50 +44,50 @@ Se presenta en tres secciones que deben ser leídas antes y después de la escri * C. Guía de formato ## A. Estilo y audiencia -Esta primera sección se ocupa de cuestiones de estilo generales que te ayudarán a tomar decisiones que satisfagan las necesidades de nuestra audiencia y editores. Incluimos información básica sobre el estilo y el tono, el acceso abierto y los valores del código abierto, información sobre la escritura para una audiencia global, la escritura sostenible y la toma de decisiones inteligentes sobre los datos utilizados en las lecciones. Lea esta sección cuando planifique su lección. Léala de nuevo antes de enviarla para asegurarse de que el tutorial cumple con estos requisitos. +Esta primera sección se ocupa de cuestiones de estilo generales que te ayudarán a tomar decisiones que satisfagan las necesidades de nuestra audiencia y editores. Incluimos información básica sobre el estilo y el tono, el acceso abierto y los valores del código abierto, información sobre la escritura para una audiencia global, la escritura sostenible y la toma de decisiones inteligentes sobre los datos utilizados en las lecciones. Lee esta sección cuando planifiques tu lección. Vuelve a leerla antes de enviarla para asegurarte de que el tutorial cumple con estos requisitos. ### Lenguaje y estilo * Los tutoriales no deben exceder las 8.000 palabras (incluyendo el código). -* Mantén un tono formal pero accesible. -* Hable con su lector en segunda persona (usted). -* Adopte una versión ampliamente utilizado del español (REVISAR). -* El escrito es un "tutorial" o una "lección" y no un "artículo". +* Mantén un tono formal, pero accesible. +* Habla con tu lector en segunda persona (tú). +* Procura escribir de un modo comprensible para hablantes de español de distintos lugares. +* Refiérete a tu escrito como "tutorial" o "lección", no como "artículo". ### Código abierto, acceso abierto *Programming Historian* está comprometido con los valores del código abierto. Todas las lecciones deben usar lenguajes de programación y software de código abierto siempre que sea posible. Esta política tiene por objeto reducir al mínimo los costos para todas las partes y permitir el mayor nivel de participación posible. -Una vez aceptada la lección, usted acepta publicar su lección bajo una licenicia Creative Commons"[CC-BY](https://creativecommons.org/licenses/by/4.0/deed.es)". +Una vez aceptada la lección, aceptas que se publique bajo licencia Creative Commons"[CC-BY](https://creativecommons.org/licenses/by/4.0/deed.es)". -### Escriba para una audiencia global +### Escribe para una audiencia global Los lectores de *Programming Historian* viven en todo el mundo. Los autores pueden y deben tomar medidas para escribir su lección de forma accesible para el mayor número de personas posible. Siga estas directrices de cara a una audiencia global: -* Escriba para alguien que no viva en su país o que no comparta sus creencias. +* Escribe para alguien que no viva en tu país o que no comparta tus creencias. -* **Términos técnicos:** siempre deben estar vinculados a [Wikipedia](https://es.wikipedia.org/) o a un diccionario fiable o a un sitio web sostenible en primera instancia. Un término técnico es cualquier palabra que una persona en la calle puede no conocer o entender. -* **Referencias culturales**: las menciones A personas, organizaciones o detalles históricos deben acompañarse siempre con información contextual. No hay que suponer ningún conocimiento previo, incluso de referencias culturales ampliamente conocidas (por ejemplo, [the Beatles](https://en.wikipedia.org/wiki/The_Beatles)). Use términos genéricos en lugar de marcas comerciales (pañuelo en lugar de Kleenex) Los enlaces a [Wikipedia](https://es.wikipedia.org/) deben ser usados libremente. -* **Modismos**: Evite bromas, juegos de palabras, expresiones idiomáticas, sarcasmo, emojis, jerga, términos exclusivos de su dialecto, o lenguaje que sea más difícil de lo necesario. -* **Geografía**: cuando haga referencia a los lugares, sea específico. ¿"Sudoeste" significa Valencia? ¿Canadá? ¿Africa? Escriba siempre el nombre completo del área la primera vez que la use. -* **Multi-idioma**: al elegir los métodos o instrumentos, haga sus elecciones teniendo en cuenta a los lectores multilingües, especialmente en el caso de los métodos de análisis textual, que pueden no ser compatibles con otros conjuntos de caracteres o que sólo pueden proporcionar resultados intelectualmente sólidos cuando se utilizan en textos en inglés. Cuando sea posible, elija enfoques que tengan documentación multilingüe, o proporcione referencias multilingües para su lectura posterior. Esto ayudará a nuestros traductores. -* **Lenguaje racial y étnico**: use la terminología racial cuidadosamente y con especificidad. Los términos históricos que ya no se utilizan deben usarse sólo en su contexto histórico y sólo cuando sea necesario. Usar los términos raciales como adjetivos y no como sustantivos: personas blancas en lugar de "blancos", una mujer asiática en lugar de "un asiático". Tenga en cuenta que los términos pueden entenderse de manera diferente en los distintos países y que lo que ha aprendido a ser correcto o sensible puede ser culturalmente específico de su país (por ejemplo, no todas las personas de ascendencia africana son "afroamericanos". Algunos de ellos son africanos, o negros británicos, o caribeños, etc.). Asimismo, los lectores del Reino Unido entenderán el término "asiático" (India, Pakistán, Bangladesh) de manera diferente a los de América del Norte (por ejemplo, China, Japón, Vietnam, Tailandia). -* **Representaciones visualess**: elija las fuentes primarias, imágenes, figuras y capturas de pantalla, teniendo en cuenta cómo se presentarán a una audiencia global. +* **Términos técnicos:** siempre deben estar vinculados a [Wikipedia](https://es.wikipedia.org/),a un diccionario fiable o a un sitio web sostenible, en primera instancia. Un término técnico es cualquier palabra que una persona en la calle puede no conocer o entender. +* **Referencias culturales**: las menciones a personas, organizaciones o detalles históricos deben acompañarse siempre con información contextual. No hay que suponer ningún conocimiento previo, incluso de referencias culturales ampliamente conocidas (por ejemplo, [The Beatles](https://es.wikipedia.org/wiki/The_Beatles)). Utiliza términos genéricos en lugar de marcas comerciales (pañuelo desechable en lugar de Kleenex). Los enlaces a [Wikipedia](https://es.wikipedia.org/) deben ser usados todo lo que sea necesario. Tén en cuenta que algunos eventos históricos a veces reciben diferentes nombres según el país. +* **Modismos**: Evita bromas, juegos de palabras, expresiones idiomáticas, sarcasmo, emojis, jerga, términos exclusivos de tu dialecto, o un lenguaje más difícil de lo necesario. +* **Geografía**: cuando hagas referencia a los lugares, sé específico. ¿"Noroeste" significa Brasil? ¿India? ¿África? Escribe siempre el nombre completo del área la primera vez que la utilices. +* **Multilingüísmo**: al elegir los métodos o instrumentos, tén en cuenta a los lectores multilingües, especialmente en el caso de los métodos de análisis textual, que pueden no ser compatibles con otros conjuntos de caracteres o que solo pueden proporcionar resultados intelectualmente sólidos cuando se utilizan en textos en inglés. Cuando sea posible, elije enfoques que tengan documentación multilingüe o proporciona referencias multilingües para su lectura posterior. Esto ayudará a nuestros traductores. +* **Lenguaje racial y étnico**: use la terminología racial cuidadosamente y con especificidad. Los términos históricos que ya no se utilizan deben usarse solo en su contexto histórico y solo cuando sea necesario. Usa los términos raciales como adjetivos y no como sustantivos: personas blancas en lugar de "blancos", una mujer asiática en lugar de "un asiático". Tén en cuenta que los términos pueden entenderse de manera diferente en los distintos países y que lo que haz aprendido como un uso correcto o sensible puede ser culturalmente específico de tu país (por ejemplo, no todas las personas de ascendencia africana son "afroamericanos". Algunos de ellos son africanos, o negros británicos, o caribeños, etc.). Asimismo, los lectores del Reino Unido entenderán el término "asiático" (India, Pakistán, Bangladesh) de manera diferente a los de América del Norte (por ejemplo, China, Japón, Vietnam, Tailandia). +* **Representaciones visuales**: elije las fuentes primarias, imágenes, figuras y capturas de pantalla, teniendo en cuenta cómo se presentarán a una audiencia global. ### Escritura sostenible -*Programming Historian* publica lecciones para el largo plazo. Por favor, siga estas directrices de sostenibilidad cuando escriba: +*Programming Historian* publica lecciones pensando en largo plazo. Por favor, sigue estas directrices sobre sostenibilidad cuando escribas: - * **Tan general como sea posible, pero no más**: concéntrese en las metodologías y generalidades, no en los programas informáticos/interfaces específicos (por ejemplo, evite decir a los usuarios que "hagan clic en el botón X", que puede ser diferente en versiones futuras). - * **Reducir la dependencia de elementos insostenibles**: utilice capturas de pantalla con moderación y con un propósito. Las interfaces cambian con frecuencia y los futuros lectores pueden confundirse. Elija los enlaces externos teniendo en cuenta el futuro. ¿Cambia a menudo el sitio al que se enlaza? ¿Existirá dentro de diez años? - * **Especifique las versiones si son importantes**: sea claro acerca de los detalles específicos de las versiones que los lectores necesitarán saber para poder seguir su lección. Por ejemplo, ¿necesita Python v.2, o cualquier versión estará bien? - * **Refiérase a la documentación**: dirija a los lectores a una documentación fiable cuando sea posible. Proporcione una guía general sobre cómo encontrar la documentación si es probable que haya nuevas versiones en el futuro. - * **Copias de datos**: todos los datos utilizados en las lecciones deben ser publicados con la lección en los servidores de *Programming Historian* junto con su lección. Asegúrese de tener el derecho legal de publicar una copia de cualquier dato utilizado. Los archivos de datos deben utilizar formatos abiertos. + * **Tan general como sea posible, pero no más**: concéntrate en las metodologías y generalidades, no en los programas informáticos/interfaces específicos (por ejemplo, evita decir a los usuarios que "hagan clic en el botón X", que podría ser diferente en versiones futuras). + * **Reducir la dependencia de elementos insostenibles**: utiliza capturas de pantalla con moderación y con un propósito. Las interfaces cambian con frecuencia y los futuros lectores pueden confundirse. Elije los enlaces externos teniendo en cuenta el futuro. ¿Cambia a menudo el sitio al que se enlaza? ¿Existirá dentro de diez años? + * **Especifica las versiones si son importantes**: sé claro acerca de los detalles específicos de las versiones utilizadas en caso de que sean necesarios para poder seguir la lección. Por ejemplo, ¿se necesita Python v.2, o cualquier versión estará bien? + * **Refiérete a la documentación**: indica a los lectores documentación fiable cuando sea posible. Proporciona una guía general sobre cómo encontrar la documentación si es probable que haya nuevas versiones en el futuro. + * **Copias de datos**: todos los datos utilizados en las lecciones deben ser publicados con la lección en los servidores de *Programming Historian* junto con tu lección. Asegúrete de tener el derecho legal de publicar una copia de cualquier dato utilizado. Los archivos de datos deben utilizar formatos abiertos. Los autores deben consultar nuestra [política de retirada de lecciones]({{site.baseurl}}/es/politica-retirada-lecciones) para información sobre cómo el equipo editorial maneja las lecciones que se han vuelto obsoletas. ## B. Pautas específicas de escritura -En esta segunda sección se tratan cuestiones más específicas del estilo de escritura, como qué palabras utilizar, o cómo usar la puntuación, o qué formato utilizar para las fechas o los números. Lea esta sección antes y después de escribir su borrador. +En esta segunda sección se tratan cuestiones más específicas del estilo de escritura, como qué palabras utilizar, cómo usar la puntuación o qué formato utilizar para las fechas o los números. Lee esta sección antes y después de escribir tu borrador. ### Fechas y hora - * Para siglos utilice siglo dieciocho y no siglo XVIII. Evite frases centradas en lo nacional, como "largo siglo XVIII", que tienen un significado específico para los especialistas británicos del siglo XVIII, pero para nadie más. - * Para décadas escriba "los años cincuenta" o "los cincuenta" (no "los años 50's" o "la década de los 50s"). + * Para siglos, utiliza números romanos. Evita frases centradas en lo nacional, como "largo siglo XVIII", que tienen un significado específico para los especialistas británicos del siglo XVIII, pero para nadie más. + * Para décadas escribe "los años cincuenta" o "los cincuenta" (no "los años 50's" o "la década de los 50s"). * Comprima las secuencias de fecha así; 1816-17, 1856-9, 1854-64. * Para fechas escritas en forma numérica utilice el formato DD-MM-AA, which conforms to the standard ISO 8601:2004. This avoids ambiguity. * Utilice BCE/CE not BC/AD for dates (eg 325BCE). [Asi aparece en la RAE: a. de J. C., a. de C., a. J. C. o a. C. (‘antes de (Jesu)Cristo’) y d. de J. C., d. de C., d. J. C. o d. C. (‘después de (Jesu)Cristo’): 211 a. C., 123 d. C. ] @@ -104,11 +104,11 @@ En esta segunda sección se tratan cuestiones más específicas del estilo de es ### Encabezados Los encabezados no deben contener un código de fuente o un formato de estilo como negrita, cursiva o código de fuente. -Los encabezados siempre deben preceder inmediatamente al texto del cuerpo. No ponga después de un encabezado ¿una amonestación? u otro encabezamiento sin alguna forma de texto introductorio o descriptivo. +Los encabezados siempre deben preceder inmediatamente al texto del cuerpo. No pongas después de un encabezado una advertencia u otro encabezamiento sin un texto introductorio o descriptivo. ### Listas -Típicamente, usamos listas numeradas y listas con viñetas. Los elementos de la lista comienzan con mayúscula. Los elementos de la lista deben ser tratados como elementos separados y no deben ser encadenados con puntuación o conjunciones. +Típicamente, usamos listas numeradas y listas con viñetas. Los elementos de la lista comienzan con mayúscula. Los elementos de la lista deben ser tratados como elementos separados y no deben ser encadenados con puntuación o conjunciones. NO tiene estilo: @@ -122,16 +122,15 @@ Estilo: * Acá hay otro ítem * Acá está el último ítem +[AGREGAR ALGO SOBRE CONSISTENCIA GRAMATICAL DE LOS ELEMENTOS ENUMERADOS] ### Puntuación * **Abreviaturas**: [revisar lineamientos de la RAE: https://www.rae.es/dpd/abreviatura] spell out all words on first mention. European Union (EU) and then EU. Do not use full points / periods or spaces between initials: BBC, PhD, mph, 4am, etc. - * ??? **Ampersand**: generally speaking, do not use an ampersand in place of the word "and" unless referring to a company or publication that uses it: P&O, *Past & Present*. - * **Apóstrofe**: [No recuerdo que en español lo usemos--quitar, ¿o reemplazar por algo sobre los acentos?] use the possessive 's after singular words or names that end in s – St James's, Jones's, mistress's; use it after plurals that do not end in s: children's, people’s, media's. * **Corchetes / Paréntesis**: REVISAR LINEAMIENTOS PARA EL ESPAÑOL it is better to use commas or dashes. Use round brackets to introduce explanatory material into a direct quote, eg: He said: "When finished it (the tunnel) will revolutionise travel" or "She said adiós (goodbye)". Place a full stop / period outside a closing bracket if the material inside is not a sentence (like this). (But an independent sentence takes the full stop before the closing bracket.) * **Dos puntos**: se utilizan para introducir listas, tabulaciones, textos, como en:REVISAR LINEAMIENTOS EN ESPAÑOL * El comité recomienda: ampliar las horas de licencia hasta la medianoche; permitir a los niños en los locales con licencia; relajar los controles de planificación en los nuevos establecimientos públicos. * Usar después del nombre de un orador para una frase entera citada: El Sr. James Sherwood, presidente de Sealink, dijo: "Tenemos..." - * La primera letra en minúscula después de un colon: así es como lo hacemos. + * La primera letra en minúscula después de dos puntos: así es como lo hacemos. * **Coma**: NO EXISTE LA SERIA COMMA EN ESPAÑOL, REVISAR LINEAMIENTOS (this, that, and the other). * **Guión**: a useful device to use instead of commas, but not more than one pair per sentence. * **Ellipsis**: three periods separated from the preceding and following words by a space ( ... ). Use to condense a direct quote (thus the quote "the people sitting in this meeting room deserve a better deal" becomes "the people ... deserve a better deal"). @@ -154,64 +153,63 @@ La pauta es usarlos con moderación en la prosa corriente. Reglas específicas: * **Nombre propios**: William J. Turkel – a menos que la persona elija deletrear su nombre de otra manera (por ejemplo "bell hooks"). * **Organizaciones artísticas, culturales y gubernamentales, etc**: Museo de Arte Moderno, Casa de Cervantes, Biblioteca Nacional, Agencia Nacional de Tierras, Naciones Unidades. * **Días festivos y festivales**: Diwali, Hanukkah, Eid-Ul-Adha, Día de los Muertos. -* **A veces o parcialmente en mayúsculas**: +* **A veces o solo parcialmente en mayúsculas**: * **Lugares**: capitales de países, regiones, zonas reconocibles (por ejemplo, el Oriente Medio, Senegal). Minúsculas para los puntos cardinales, a excepción de cuando son utilizados como parte del nombre de un lugar (para llegar al Polo Norte, dirigirse al norte). Otros ejemplos son: el noreste de Kenya, el sur del Brasil, el oeste, el oeste del Canadá, el extremo oriental, el Asia sudoriental, América Central, América Latina. * **Eventos históricos**: la primera letra en mayúscula para primera Guerra Mundial, Segunda Guerra Mundial; Guerra de Crimea/Boer/Vietnam/del Golfo; Guerra de los Cien Años. * **Religión**: minúscula para anglicano, bautista, budista, católico, cristiano, hindú, metodista, musulmán, protestante, católico romano, sikh, y también para evangélicos, carismáticos, ateos. * **Libros sagrados (selección)**: * **Biblia**: mayúscula si se refiere al Antiguo o al Nuevo testamento. - * **Budismo**: sutras (sermones) y abhidhamma (análisis e interpretación). Para el budismo tibetaton tambien hay libros tántricos y Libro tibetano de los muertos. + * **Budismo**: sutras (sermones) y abhidhamma (análisis e interpretación). Para el budismo tibetano tambien hay libros tántricos y Libro tibetano de los muertos. * **Hinduismo**: los Śruti: Vedas, Samhitas, Brahmanas, Aranyakas, Upanishads; los Vedāngas, épica Hindú, sutras, shastras, textos filosóficos, los Puranas, literatura kāvya, los Bhasyas, muchos nibandhas. - * **Juadismo**: el Tanakh (Torá, Nevi'im, Ketuvim), el Talmud (Mishná, Guemará) + * **Judaismo**: el Tanakh (Torá, Nevi'im, Ketuvim), el Talmud (Mishná, Guemará) * **Corán**: textos que incluyen los hadiz, el Tawrat (Torá), Zabur (posiblemente salmos), Injil (1.2 billones). * **Sikh**: Adi Granth (comonmente llamado el Sri Guru Granth Sahib Ji), el Dasam Granth, los Varan Bhai Gurdas, los textos del Bhai Nand Lal. - * **Trabajos**: en minúscula – president Macron, Emmanuel Macron, presidente de France. El ministro de Hacienda. El Papa se escribe con mayúscula y la reina en minúscula. [REVISAR] + * **Trabajos**: en minúscula – presidente Macron, Emmanuel Macron, presidente de France. El ministro de Hacienda. El Papa se escribe con mayúscula y la reina en minúscula. [REVISAR] * **Organizaciones e instituciones**: el gobierno (en minúscula en toda referencia), el gabinete (minúscula en toda referencia), la Iglesia de Jesucristo de los Santos de los Últimos Días ("la iglesia"), Ministerio de Educación ("el ministerio"), Universidad Católica ("la universidad"), el Tribunal de Apelación ("tribunal de apelación" o "el tribunal"). - * **Universidades e institutos**: mayúsculas para la institución y para departamentos ("Universidad Autónoma de México", Departamento de Historia"). - * **Instituciones religiosas, hospitales y escuelas**: cap up the proper or place name, lower case the rest eg Nurture Hillandale rehabilitation hospital, Vernon county primary school, Ali Pasha’s mosque. -* **Always Lowercase**: + * **Universidades e institutos**: mayúsculas para la institución y para departamentos ("Universidad Autónoma de México", "Departamento de Historia"). + * **Instituciones religiosas, hospitales y escuelas**: cap up the proper or place name, lower case the rest eg Nurture Hillandale rehabilitation hospital, Vernon county primary school, Ali Pasha’s mosque. [REVISAR] +* **Siempre en minúscula**: * **Committees, Reports and Inquiries**: committee on climate change, trade and industry committee, royal commission on electoral reform * **Agencies, Commissions, Public Bodies, Quangos**: benefits agency, crown prosecution service, customs and excise, parole board - * **Seasons**: spring, summer, autumn/fall, winter. - * **Currencies**: euro, franc, mark, sterling, dong etc + * **Estaciones**: spring, summer, autumn/fall, winter. + * **Tipos de cambio**: peso, sol, euro, franco, marco, dong, etc. ### Referencias * Los enlaces en lugar de las notas finales pueden ser apropiados en la mayoría de los casos. -* Asegúrese de que las frases vinculadas tengan un significado semántico. No enlace términos que son significativos sólo para usuarios videntes como "haga clic aquí". -* Toda literatura publicada de manera tradicional y académica debe incluirse como notas al final en lugar de ser enlazada. -* Si está escribiendo un tutorial de "análisis", debe referirse a la literatura académica publicada. -* Los superíndices de las notas finales deben dentro de la puntuación final así². No afuera así.² -* Utilice el sistema de "Notas y Bibliografía" que se encuentra en el [*Manual Chicago Manual 17a edición](https://uc3m.libguides.com/guias_tematicas/citas_bibliograficas/chicago) para las notas al final endnotes. -* Cuando se mencione por primera vez una obra publicada, incluya el nombre del autor (incluyendo el primer nombre). Por ejemplo, "Puede encontrar más información en *The Elements of Typographic Style* de Robert Bringhurst" o "Para más información, consulte *The Elements of Typographic Style* de Robert Bringhurt". En las referencias posteriores, sólo use el título del libro. Los nombres de los autores pueden ser acortados a apellidos sólo en un uso posterior. -* Las notas finales no deberían contener sólo un URL. +* Asegúrate de que las frases vinculadas tengan un significado semántico. No enlace términos que son significativos solo para usuarios videntes como "haga clic aquí". +* Toda literatura publicada de manera tradicional y académica debe incluirse como notas al final, en lugar de ser enlazada. +* Si estás escribiendo un tutorial de "análisis", debes referirte a la literatura académica publicada. +* Los superíndices de las notas finales deben ir dentro de la puntuación final así². No afuera, así.² +* Utiliza el sistema de "Notas y Bibliografía" que se encuentra en el [*Manual Chicago Manual 17a edición](https://uc3m.libguides.com/guias_tematicas/citas_bibliograficas/chicago) para las notas al final. +* Cuando se mencione por primera vez una obra publicada, incluye el nombre del autor (incluyendo el primer nombre). Por ejemplo, "Puedes encontrar más información en *The Elements of Typographic Style* de Robert Bringhurst" o "Para más información, consulta *The Elements of Typographic Style* de Robert Bringhurt". En las referencias posteriores, usa solo el título del libro. Los nombres de los autores pueden ser acortados a apellidos solo a partir de su segunda mención. +* Las notas finales no pueden contener solo una URL. * (Correcto): Grove, John. "Calhoun and Conservative Reform." *American Political Thought* 4, no. 2 (2015): 203–27. https://doi.org/10.1086/680389. * (Incorrecto): https://doi.org/10.1086/680389 ### Explicación de palabras difíciles [REVISAR CASOS ESPECÍFICOS PARA EL ESPAÑOL] - * **Collective Nouns** (group, family, cabinet, etc) take singular or plural verb according to meaning: the family was shocked, the family were sitting down, scratching their heads. - * **Less or Fewer?** Less means less in quantity, (less money); fewer means smaller in number, (fewer coins). - * **Over or More Than?** Over and under answer the question "how much?"; more than and fewer than answer the question "how many?": she is over 18, there were more than 20,000 at the game. - * **That or Which?** that defines, which informs: this is the house that Jack built, but this house, which Jack built, is now falling down. +[BORRÉ YA LOS QUE ESTABAN EN INGLÉS] + + ## C. Guía de formato -Esta última sección abarca cuestiones de formato para la presentación. Lee esta sección antes y después de escribir tu borrador. Si te equivocas en alguno de estos elementos, podrás corregirlo cuando publiquemos un avance en directo de tu lección al comienzo del proceso de revisión de pares. +Esta última sección abarca cuestiones de formato para el envío de tu lección. Lee esta sección antes y después de escribir tu borrador. Si te equivocas en alguno de estos elementos, podrás corregirlo cuando publiquemos un avance en directo de tu lección al comienzo del proceso de revisión de pares. ### Escribe en Markdown Todas las lecciones deben ser escritas en [Markdown](https://es.wikipedia.org/wiki/Markdown). Se ha proporcionado una plantilla para escribir las lecciones. -* [Descarga la plantilla para lecciones en español (.md)]({{site.baseurl}}/es/PLANTILLA-PROPUESTA-LECCION.md). +* [Descarga la plantilla para lecciones en español (.md)]({{site.baseurl}}/es/PLANTILLA-PROPUESTA-LECCION.md). HAY QUE ACTUALIZAR ESTA PLANTILLA PORQUE EN EL YAML FALTAN ALGUNOS CAMPOS Markdown es un lenguaje de marcado que se crea mejor con un editor de texto. MS Word y Open Office NO son editores de texto y deben ser evitados. Recomendamos [Atom](https://atom.io/), [TextWrangler](https://www.barebones.com/products/textwrangler/), [TextEdit](https://en.wikipedia.org/wiki/TextEdit), [MacDown](https://macdown.uranusjr.com/) o [Notepad++](https://notepad-plus-plus.org/download). -Para una introducción sencilla a Markdown ver [Introducción a Markdown]({{site.baseurl}}/es/lecciones/introduccion-a-markdown), o la referencia concisa [GitHub Guide to Markdown](https://guides.github.com/features/mastering-markdown/). [BUSCAR GUIA EN ESPAÑOL] +Para una introducción sencilla a Markdown puedes ver la lección [Introducción a Markdown]({{site.baseurl}}/es/lecciones/introduccion-a-markdown), o la referencia concisa [GitHub Guide to Markdown](https://help.github.com/es/github/writing-on-github/basic-writing-and-formatting-syntax). Tu lección debe ser guardada en formato .md. El nombre del archivo de tu lección se convierte en parte de la URL de la lección, por lo tanto, debe ser nombrado de acuerdo a las siguientes reglas: - * Un nombre corto, en minúsculas, descriptivo que de una clara indicación del contenido de la lección (por ejemplo, introduccion-a-markdown.md). - * No utilice espacios ni guiones bajos en el nombre del archivo; utilice en su lugar guiones. - * Utilice un nombre de archivo rico en palabras clave que incluya tecnologías o métodos clave (por ejemplo, Python o Análisis de Sentimientos). - + * Un nombre corto, en minúsculas, descriptivo y que dŕ una clara indicación del contenido de la lección (por ejemplo, introduccion-a-markdown.md). + * No utilices espacios ni guiones bajos en el nombre del archivo; utiliza guiones. + * Utiliza un nombre de archivo rico en palabras clave que incluyan las tecnologías o métodos usados en la lección (por ejemplo, Python o Análisis de Sentimientos). + ### Negrita, cursiva y subrayado Para asegurar la consistencia de las lecciones, sigue las siguientes directrices de formato de texto: @@ -222,7 +220,8 @@ Para asegurar la consistencia de las lecciones, sigue las siguientes directrices #### Cursiva * Usa la cursiva para los títulos de libros, películas, programas de TV, pinturas, canciones, álbumes y sitios web. * Nunca uses la cursiva para nombres de empresas (el sitio web *Facebook* es propiedad de Facebook). -* No uses la cursiva en los titulares, incluso si se refiere al título de un libro. +* No uses la cursiva en los títulos de secciones, incluso si te estás refiriendo título de un libro. +* AGREGAR NORMA RAE SOBRE USO DE CURSIVAS * La cursiva se formatea utilizando *\*un asterisco\**. #### Subrayado @@ -238,11 +237,11 @@ Si quieres incluir un aparte o una advertencia a los lectores, puedes apartarlo ``` ### Figuras e imágenes -Las imágenes pueden ayudar a los lectores a entender los pasos de la lección, pero no deben ser usadas como decoración. Si desea utilizar imágenes en su lección etiquételas secuencialmente LECCIÓN-NOMBRE1.jpg, LECCIÓN-NOMBRE2.jpg, etc. Refiérase a ellas en el texto como "Figura 1", "Figura 2", y así sucesivamente. Todas las figuras deben venir con una leyenda concisa de la figura y notas finales cuando sea apropiado. Debes tener el derecho legal de publicar cualquier imagen. +Las imágenes pueden ayudar a los lectores a entender los pasos de la lección, pero no deben ser usadas como decoración. Si deseas utilizar imágenes en tu lección, etiquétalas secuencialmente sigioendo el patrón: LECCIÓN-NOMBRE1.jpg, LECCIÓN-NOMBRE2.jpg, etc. Refiérete a ellas en el texto como "Figura 1", "Figura 2", y así sucesivamente. Todas las figuras deben venir con una leyenda concisa y notas finales cuando sea apropiado. Debes tener el derecho legal para publicar cualquier imagen. -Utilice formatos de archivos amigables para la web como .png o .jpg y reduzca las imágenes grandes a un máximo de 840px en el lado más largo. Esto es importante para los lectores en países con velocidades de Internet más lentas. +Utiliza formatos de archivos amigables para la web como .png o .jpg y reduce las imágenes grandes a un máximo de 840px en el lado más largo. Esto es importante para los lectores en países con velocidades de Internet más lentas. -Las imágenes deben guardarse en una carpeta con el mismo nombre que el archivo .md de la lección. El editor asignado a su lección puede ayudarle a subir sus imágenes cuando las envíe. +Las imágenes deben guardarse en una carpeta con el mismo nombre que el archivo .md de la lección. El editor asignado a tu lección puede ayudarle a subir sus imágenes cuando las envíes. Para insertar una imagen en su texto, utilice el siguiente formato: @@ -252,29 +251,29 @@ Para insertar una imagen en su texto, utilice el siguiente formato: ``` {% endraw %} -Tenga en cuenta que las comillas internas en su pie de foto deben escaparse con una barra invertida, como en el ejemplo anterior. Es posible que las imágenes no aparezcan en las vistas previas de la lección, pero el editor se asegurará de que se reproduzcan correctamente cuando se publique la lección. +Ten en cuenta que las comillas internas en el pie de foto deben escaparse con una barra invertida, como en el ejemplo anterior. Es posible que las imágenes no aparezcan en las vistas previas de la lección, pero el editor se asegurará de que se reproduzcan correctamente cuando se publique la lección. ### Ejemplos de código Las líneas de código deben tener un formato que las distinga claramente de la prosa: * Las líneas de código deben tener un máximo de 80 caracteres - * Los bloques de código multilínea deben estar encerrados en tres \`\`\`comillas-invertidas\`\`\`. - * Líneas de código (raramente usado) puede ser encerrado en una sola \`comilla invertida\`. + * Los bloques de código de varias líneas deben estar encerrados en tres \`\`\`comillas-invertidas\`\`\`. + * El código dentro del texto (raramente usado) puede ser encerrado en una sola \`comilla invertida\`. ``` Se verán así ``` -` y así ` respectivamente. +` y así `, respectivamente. -- Sigue las mejores prácticas para escribir tu código: -* **Variable and Function Names**: variable names should be nouns (eg "counter") and function names should be verbs (eg "createFile"). Choose names that are concise and meaningful. You may use [snake_case](https://en.wikipedia.org/wiki/Snake_case) or [camelCase](https://en.wikipedia.org/wiki/Camel_case), but be consistent. -* **User Commands**: when writing about text you want the reader to replace with their own information, use FULL CAPS and enclose by ` backticks ` (eg, \`USERNAME HERE\`). -* **Filenames**: filenames that you ask your reader to create or use should be enclosed in `backticks` when mentioned in the text and should include their file extension. Choose names that are concise and meaningful. You may use [snake_case](https://en.wikipedia.org/wiki/Snake_case) or [camelCase](https://en.wikipedia.org/wiki/Camel_case), but be consistent (eg, `data.txt`, `cleanData.py` etc). -* **Reserved Words**: words that are part of a programming language should always be formatted as `code` using `back-ticks` in the running prose. A list of reserved words in common programming languages include: +* **Nombres de variables y funciones**: los nombres de variables deben ser sustantivos (por ejemplo, "nombre_coleccion") y los nombres de funciones verbos (por ejemplo, "crear_archivo"). Elije nombres concisos y significativos. Puedes usar el formato [snake_case](https://en.wikipedia.org/wiki/Snake_case) o [camelCase](https://en.wikipedia.org/wiki/Camel_case); lo importante es que seas consistente a lo largo de la sección. +* **Comandos de usuario**: cuando hagas referencia a texto que quieres que el usuario remplace con su propia información, utiliza MAYÚSCULAS rodeadas de ` tildes graves ` (por ejemplo, \`NOMBRE USUARIO ACÁ\`). +* **Nombres de archivos**: los nombres de archivos que solicites crear los lectores deben estar rodeados de `tildes graves` cuando se mencionan en el texto y deben incluir la extensión del archivo. Elije nombres concisos y significativos. Puedes usar [snake_case](https://en.wikipedia.org/wiki/Snake_case) o [camelCase](https://en.wikipedia.org/wiki/Camel_case); lo importante es que seas consistente (por ejemplos, `datos.txt`, `datosLimpios.py`, `grafico_autores.png` etc). +* **Palabras reservadas**: los términos que son parte de un lenguaje de programación deben estár formateados como `código` usando tildes graves cuando los menciones en el texto. A continuación encontrarás una lista de nombres reservados de algunos lenguajes de programación comunes: #### JavaScript: @@ -321,20 +320,20 @@ Puede resultarte útil leer nuestras [guía para editores](es/guia-editor), dond Si en algún momento no estás seguro de tu papel o de lo que debes hacer a continuación, publica una pregunta en el número de revisión de pares. Uno de nuestros editores responderá lo antes posible. Nos esforzamos por responder a todas las preguntas en unos pocos días. -### Holding Us to Account [no sabría bien cómo traducir esto...] +### Haznos responsables -Nuestro equipo de voluntarios trabaja duro para proporcionar una rigurosa, colegial y eficiente revisión de pares para autores. Sin embargo, reconocemos que hay momentos en que las expectativas pueden no cumplirse. Queremos que los autores se sientan con el poder de exigirnos altos estándares. Si, por cualquier razón, sientes que has sido tratado injustamente, que está descontento o confundido por el proceso, que el proceso de revisión se ha retrasado innecesariamente, que un revisor ha sido grosero, que tu editor no ha sido lo suficientemente receptivo, o tienes alguna otra inquietud, por favor, déjanos saberpara que podamos abordarlo de manera proactiva. +Nuestro equipo de voluntarios trabaja duro para proporcionar a los autores una revisión entre pares rigurosa, colegiada y eficiente. Sin embargo, reconocemos que hay momentos en que las expectativas pueden no cumplirse. Queremos que los autores se sientan con el poder de exigirnos altos estándares. Si, por cualquier razón, sientes que has sido tratado injustamente, que estás descontento o confundido por el proceso, que el proceso de revisión se ha retrasado innecesariamente, que un revisor ha sido grosero, que tu editor no ha sido lo suficientemente receptivo, o tienes cualquier otra inquietud, por favor, déjanos saber para que podamos abordarlo de manera proactiva. -Plantear una preocupación NO afectará negativamente el resultado de su revisión de pares - incluso una revisión de pares en curso. +Plantear una preocupación NO afectará negativamente el resultado de tu revisión de pares, incluso si se trata de una revisión de pares en curso. -Para plantear una preocupación, por favor contacta una de las siguientes partes, eligiendo a quien te resulte más cómodo para acercarse. +Para plantear una preocupación, por favor contacta a una de las siguientes personas, según te resulte más cómodo: -* Tu editor asignado +* El editor de tu lección * El jefe de redacción * Nuestra ombudsperson independiente, [Silvia Gutiérrez de la Torre](/equipo-de-proyecto) -Esperamos que no se encuentre en una situación incómoda, pero si esto sucede te agradecemos que nos ayudes a mejorar. +Esperamos que no te encuentres en una situación incómoda, pero si esto sucede, te agradecemos que nos ayudes a mejorar. --- -Esta guía de estilo fue creada con el apoyo de la Escuela de Humanidades de la Universidad de Hertfordshire. La traducción y adaptación al español es producto del trabajo conjunto del equipo en español. +La versión en inglés de esta guía de estilo fue creada con el apoyo de la Escuela de Humanidades de la Universidad de Hertfordshire. Esta traducción y adaptación al español es producto del trabajo conjunto del Equipo Editorial de Programming Historian en español. From eb858dbf781bbad18bf5cfd7a6a85ad18d373a03 Mon Sep 17 00:00:00 2001 From: mariajoafana Date: Tue, 9 Jun 2020 10:51:40 -0500 Subject: [PATCH 9/9] Create guia-traducciones.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Acabo de hacer la traducción de la guía para traductores --- guia-traducciones.md | 72 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 guia-traducciones.md diff --git a/guia-traducciones.md b/guia-traducciones.md new file mode 100644 index 0000000000..04230bbebe --- /dev/null +++ b/guia-traducciones.md @@ -0,0 +1,72 @@ +--- +title: Guía para traductores +layout: blank +redirect_from: + - /new-lesson-workflow + - /guia-traducciones +skip_validation: true +--- + +# Guía para traductores + +

Paso 1: Proponer la traducción de una lección

+

Paso 2: Escribir y dar formato a una traducción

+

Paso 3: Enviar una lección traducida

+ +## Proponer la traducción de una lección +Si quieres traducir una lección publicada en *Programming Historian*, por favor mira la lista de traducciones pendientes y contacta con {% include managing-editor.html lang=page.lang %} para discutir tus habilidades lingüísticas y tu experiencia en la traducción. Buscamos traducciones que sean rigurosas, legibles y que consideren las necesidades de una audiencia que lea en español. + +Una vez que la traducción de una lección publicada es aprobada, uno de nuestros editores creará un "Ticket de Revisión de Traducción" en nuestro [repositorio Github](https://github.com/programminghistorian/ph-submissions) donde tendrá lugar la revisión por pares. Este ticket incluye una función de tablero de mensajes, que se utilizará para documentar el progreso realizado durante la revisión de la traducción. Para evitar retrasos en la publicación te pedimos que envíes tu traducción en un plazo de 90 días desde que el editor acepte tu propuesta. + +## Escribir y dar formato a una lección +Traducir una lección implica principalmente lo siguiente: +- traducir el cuerpo textual principal de una lección +- traducir los términos del código y los ejemplos, si es posible +- si una lección utiliza un software con una interfaz disponible en el idioma de la traducción, entonces los términos técnicos relacionados con el software que se utiliza en el texto (entradas de menú, botones, etc.) deben traducirse como corresponde +- traducir los títulos y subtítulos de las imágenes. En algunos casos, es necesario producir nuevas imágenes, por ejemplo, si un ejercicio utiliza un software con una interfaz que puede cambiarse al idioma de destino +- Adaptar los enlaces y notas proporcionados en el texto original para que se ajusten al contexto lingüístico al que se dirigen, si es posible; por ejemplo, el enlace a la documentación de los programas informáticos, las notas de Wikipedia, etc., si estos recursos se proporcionan en el idioma de destino. + +Si decides traducir, por favor ten en cuenta que te estás dirigiendo a una audiencia global. Para cuestiones de estilo y elección de idioma, por favor revisa nuestra [Guía para autores]({{site.baseurl}}/es/guia-para-autores). + +Todas nuestras lecciones deben ser escritas en Markdown y seguir nuestras directrices de formato técnico, también disponibles en nuestra [Guía para autores]({{site.baseurl}}/es/guia-para-autores). + + +## Enviar una lección traducida +Una vez que tu archivo de traducción ha sido preparado según las especificaciones anteriores, está listo para someterlo a una revisión de pares. + +Tenemos una [página de Programming Historian en GitHub](https://github.com/programminghistorian), donde mantenemos dos repositorios (un repositorio es un lugar para almacenar archivos y carpetas relacionadas - puedes pensar en ello como una especie de carpeta). Uno de ellos, llamado [jekyll], aloja el código de la versión en vivo del sitio que ves en http://programminghistorian.org. El otro repositorio se llama [ph-submissions]. + +Nuestra forma preferida para que los traductores envíen una lección es añadirlas directamente al repositorio [ph-submissions] (o repo, para abreviar). Gracias a las características de GitHub, puedes hacer esto usando acciones de arrastrar y soltar con las que probablemente ya estés familiarizado. Como nuevo traductor, estos son los pasos a seguir: + +1. Crea una [cuenta gratuita en GitHub](https://github.com/join). Esto tomará 30 segundos. +2. Envía un correo electrónico a tu editor con tu nuevo nombre de usuario de GitHub y el nombre del archivo de la lección. El editor te añadirá como **colaborador** en el repositorio [ph-submissions]. Una vez que seas añadido como colaborador, podrás hacer cambios directos en el repositorio [ph-submissions], incluyendo añadir, editar, eliminar y renombrar archivos. El editor también creará una carpeta con el mismo nombre de su lección en la carpeta de imágenes. (Si tienes otros archivos de datos a los que te conectas en tu tutorial, por favor pregunta a tu editor sobre ellos). +3. Una vez que tu editor te comunique que has sido agregado como colaborador, navega hasta la carpeta [es] y luego entra a la [carpeta lecciones](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/es/lecciones) del repositorio [ph-submissions]. A continuación, arrastra y suelta el archivo de anotaciones de tu lección desde tu ordenador a la ventana de tu navegador. (Si necesitas ayuda, revisa las instrucciones de [GitHub](https://help.github.com/articles/adding-a-file-to-a-repository/). Ahora haz clic en el botón verde "Commit Changes"; no necesitas cambiar el mensaje predeterminado. +4. Es posible que tengas algunas imágenes que acompañen a tu lección. Asegúrate de que todos los archivos de imágenes estén nombrados apropiadamente de acuerdo con nuestras convenciones de nomenclatura. Navega a la [carpeta de imágenes](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images) en el repositorio [ph-submissions]. Haga clic en la carpeta con el mismo nombre de su lección (que tu editor debería haber creado para ti; si no la ves, ponte en contacto con tu editor y espera las instrucciones). Una vez que estés en la carpeta correcta, arrastra y suelta todos los archivos de imágenes en la ventana del navegador, como en el paso 3. No puedes arrastrar una carpeta de imágenes; pero puedes arrastrar varios archivos a la vez. +5. ¡Previsualiza tu lección! Espera unos minutos (normalmente menos) para que GitHub convierta tu archivo Markdown en HTML y lo convierta en una página web en directo. Luego navega a `http://programminghistorian.github.io/ph-submissions/es/lecciones/` + `YOUR-LESSON-NAME` (pero reemplaza YOUR-LESSON-NAME con el nombre de tu archivo). +6. Hazle saber a tu editor que has subido los archivos de tu lección al repositorio de envíos ph (ellos deberían recibir una notificación sobre esto, pero queremos asegurarnos de que nada se pase por alto). + + +
+Si estás familiarizado con la línea de comandos git y GitHub, también puedes enviar tu traducción e imágenes como una solicitud de pull al repo `ph-submission` y fusionarlo tu mismo después de ser añadido como colaborador. + +### ¡Traducción eviada! ¿Ahora qué? +Para ver lo que sucede después de enviar una traducción, siéntete libre de navegar por nuestras [guía para editores](es/guia-editor), que detallan nuestro proceso editorial. Los puntos más destacados se encuentran a continuación: + +El paso inmediato más importante es que tu editor creará un [*issue*](https://github.com/programminghistorian/ph-submissions/issues) para la nueva traducción en el repositorio [ph-submissions], con un enlace a tu lección (que previsualizaste en el paso 5). El editor y al menos dos revisores invitados por el editor publicarán sus comentarios sobre este *issue*. + +### Espera la retroalimetación de los revisores +Nuestro objetivo es completar el proceso de revisión en cuatro semanas, pero a veces se producen retrasos o la gente está ocupada y el proceso puede tardar más de lo que esperábamos. + +De acuerdo con las ideas de la investigación pública y la revisión abierta de pares, animamos a que las discusiones se mantengan en GitHub. Sin embargo, también queremos que todos se sientan cómodos con el proceso. Si necesitas discutir algo en privado, por favor, no dudes en [enviar un correo electrónico a tu editor directamente](/equipo de proyecto), o en contactar con uno de nuestra [mediadora](silviaegt@gmail.com). + +### Responde a la retroalimentación +Su editor y revisores probablemente harán algunas sugerencias para mejorar el *issue* de su traducción. El editor debe aclarar qué sugerencias son esenciales de abordar, cuáles son opcionales y cuáles pueden ser dejadas de lado. + +Puedes editar tus archivos en GitHub, siguiendo [estas instrucciones](https://help.github.com/articles/editing-files-in-your-repository/). + +Tus revisiones deben completarse dentro de las cuatro semanas siguientes a la recepción de la orientación del editor sobre cómo responder a la revisión por pares. Esto es para asegurar que las traducciones se publiquen a tiempo y no se alarguen innecesariamente. Si prevés que tendrá problemas para cumplir con la fecha límite, debes ponerte en contacto con tu editor para establecer una fecha de entrega más adecuada. + +Si en algún momento no estás seguro de tu rol o de lo que debe hacer a continuación, no dudes en enviar un correo electrónico a tu editor o, mejor aún, en publicar una pregunta en el *issue* (otro editor podría verlo y podría ayudarte antes que tu propio editor). Comprenderás que a veces nos llevará unos días responder, pero esperamos que las mejoras de la lección terminada valgan la pena la espera. + +### Hazle saber a tu editor que has terminado +Una vez que hayas terminado de responder a los comentarios, avísale saber a tu editor. Si están satisfechos con la lección en esta etapa, el, Jefe de Redacción de *Programming Historian* revisará tu lección, la moverá del repositorio `ph-submissions` al repositorio `jekyll`, y actualizará nuestro directorio de lecciones donde será publicada.