Coder Social home page Coder Social logo

reference-pt's Introduction

Reference-pt

Reference-pt é o repositório da documentação de referência para a sintaxe da linguagem Arduino em Português. Todos os arquivos da referência devem estar no formato AsciiDoc. Obrigado por se interessar em contribuir para a documentação de referência, isso ajuda bastante toda a comunidade Arduino.

A documentação traduzida em Português pode ser encontrada nessa Página

Criação e Edição de Conteúdo

Se você quer contribuir com um novo conteúdo, crie um novo arquivo (com qualquer editor de texto ou código) e salve-o como um arquivo formato AsciiDoc (extensão ".adoc"). Não use parênteses ou qualquer outro caractere especial no nome do arquivo. No link reference-pt/AsciiDoc_sample/AsciiDoc_Dictionary você vai encontrar uma visão geral da sintaxe AsciiDoc. Isso inclui títulos, texto, links, imagens, tabelas, código e vários embeds (vídeo, slideshow, áudio e código). Você pode ver esse exemplo renderizado aqui.

Se você quer contribuir para a documentação de referência da linguagem ou editar um conteúdo existente, há dois templates disponíveis em reference-pt/AsciiDoc_sample/Reference_Terms:

Por favor note que todo arquivo da referência deve incluir pelo menos uma descrição, algum código de exemplo, e links para outras informações relevantes (na seção Ver Também).

Se você precisar adicionar imagens no arquivo Asciidoc, por favor crie uma pasta chamada "attachments" na mesma pasta em que se encontra o arquivo Asciidoc. Imagens podem ser salvas em formato SVG ou PNG, de tamanho máximo 200KB.

Contribuir com Conteúdo no Github

Se ainda não é familiarizado com Git, você pode contribuir diretamente pelo Github pela sua interface online. Nós criamos um pequeno tutorial para explicar como, Confira!

Você pode também seguir esse tutorial (escrito pela equipe do Github) para aprender a editar um arquivo .adoc e propor à equipe Arduino uma atualização do arquivo. Quando sugerir uma atualização, por favor siga as recomendações descritas nos arquivos template da referência do Arduino.

Submeter um Pull request

Ficamos felizes que você tenha interesse em contribuir para a documentação de referência, essa é a melhor forma de ajudar a comunidade Arduino!

Se sua contribuição está adicionando ou modificando código existente ou descrições completas, por favor sempre consulte se há issues abertos ou abra um novo issue antes de contribuir.

Estrutura de Diretórios

reference-pt
├─ AsciiDoc_sample
│   ├── AsciiDoc_Dictionary
│   │   ├── AsciiDoc_Template-Dictionary.adoc
│   │   └── attachments
│   └── Reference_Terms
│       ├── AsciiDoc_Template-Parent_Of_Entities.adoc
│       ├── AsciiDoc_Template-Single_Entity.adoc
│       └── attachments
├── Language
│   ├── Functions
│   ├── Structure
│   └── Variables
├── LICENCE.md
└── README.adoc

Dentro da pasta Language, a arvore de arquivos segue a mesma estrutura que no link: Página da Referência do Arduino

Licença

Por favor note que sua contribuição para a documentação de referência é licenciada sob a licença Creative Commons Attribution-Share Alike 3.0. Veja https://creativecommons.org/licenses/by-sa/3.0/

Creative Commons License Este trabalho está licenceado sob a licença: Creative Commons Attribution-ShareAlike 3.0 Unported.

reference-pt's People

Contributors

arnold-n avatar batheusz avatar emviveros avatar flachtiago avatar francisconamvi avatar fv3rdugo avatar hasegawataizou avatar holographicleah avatar hydrocontrol avatar matteosuppo avatar ogomesguilherme avatar per1234 avatar redyf avatar robotiste avatar robsoncouto avatar robzach avatar sauloaislan avatar sepppenner avatar theintel avatar vctor-c avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

reference-pt's Issues

Finished translating all files, but there are some missing in the main page

Hey @smellai, just finished translating all files!!
I need your help with an issue tough, the bitwise operators were not appearing in the documentation, so I believe it is because of either the "()" or "-" characters somehow.

Can you than change "Operadores Bitwise (Bit-a-Bit)" to just "Operadores Bitwise" im the main page? The files are already edited to use this title.

Thanks!

Fixes in main page

Hello @smellai, can you make these changes in the main page?

  • "Escope de variáveis e Qualificadores" should be "Escopo de Variáveis e Qualificadores"

Just a typo

  • "Família Zero, Due e MKR" should be "Apenas Zero, Due e Família MKR"

My bad. At the time I did not know that there was a MKR family of boards, so I thought these three boards were the family. I put the "Apenas" to clarify, it is equivalent to "only", as these functions are available only in these boards.

  • "Trigonometria" would be better as "Funções Trigonométricas"

So it matches the math and time sections above.

Less relevant, but desirable:

  • "Estruturas de controle" -> "Estruturas de Controle"
  • "Tipos de dados" -> "Tipos de Dados"
  • "Outros elementos da sintaxe" -> "Outros Elementos da Sintaxe"

Thanks

Translate subcategories names

languageCode: "es"
title: "Arduino Reference"

params:
description: "The Arduino programming language Reference, organized into Functions, Variable and Constant, and Structure keywords."
category:

name: "functions"
intro: "For controlling the Arduino board and performing computations."
subCategories:

name: "Main"
name: "Digital I/O"
name: "Analog I/O"
name: "Zero, Due & MKR Family"
name: "Advanced I/O"
name: "Time"
name: "Math"
name: "Trigonometry"
name: "Characters"
name: "Random Numbers"
name: "Bits and Bytes"
name: "External Interrupts"
name: "Interrupts"
name: "Communication"
child:
name: "Serial"
name: "Stream"
name: "USB"
child:
name: "Keyboard"
name: "Mouse"
name: "variables"
intro: "Arduino data types and constants."
subCategories:

name: "Constants"
name: "Conversion"
name: "Data Types"
name: "Variable Scope & Qualifiers"
name: "Utilities"
name: "structure"
intro: "The elements of Arduino (C++) code."
subCategories:

name: "Control Structure"
name: "Further Syntax"
name: "Arithmetic Operators"
name: "Comparison Operators"
name: "Boolean Operators"
name: "Pointer Access Operators"
name: "Bitwise Operators"
name: "Compound Operators"

Translate Titles

Hi @smellai , is it possible to translate titles?
I still had not to, as I only translated function pages up to now, but I was writing contribution guidelines and noticed many pages need their titles to be translated.
If so, do their names need to be translated as well? I mean, the semicolon page had its title translated, but never worked.

Ex:

title: "+" (translate?if needed)
title_expanded: "addition" (translate?)
categories: [ "Structure" ]
subCategories: [ "Operadores Aritméticos" ]

Upload content to match reference-en

Hi @smellai . Can you give me write permission to this repository?
The way I thought for translating while keeping up with the English version is:
First update the folder I want to translate to catch up with the en repo. Using git to push a copy of the last English version of the folder.
Then translate each file (inside the folder) individually as I have been doing, I strongly rely on the preview tool of the github online interface to compare the translation and have a final revision on each file.
Thanks!

List of broken links

Auto-generated list of broken links for reference-pt as of 2020/04/27 08:41:05 (GMT)
0 total:

This issue will auto close once all links are working.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.