Merge pull request #2709 from jonatasfreitasv/master

Start docs translation to pt-BR
This commit is contained in:
Jessica Lord 2015-09-04 11:39:26 -07:00
commit 6c5c202a99
3 changed files with 148 additions and 0 deletions

View file

@ -45,6 +45,7 @@ contains documents describing how to build and contribute to Electron.
## Documentation Translations ## Documentation Translations
- [Brazilian Portuguese](https://github.com/atom/electron/tree/master/docs-translations/pt-BR)
- [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko) - [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko)
- [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp) - [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp)
- [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es) - [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es)

View file

@ -0,0 +1,70 @@
## Guias
* [Distribuir Aplicação](../../docs/tutorial/application-distribution.md)
* [Empacotamento da aplicação](../../docs/tutorial/application-packaging.md)
* [Usando módulos nativos](../../docs/tutorial/using-native-node-modules.md)
* [Depuração do processo principal](../../docs/tutorial/debugging-main-process.md)
* [Usando Selenium e WebDriver](../../docs/tutorial/using-selenium-and-webdriver.md)
* [Extensão DevTools](../../docs/tutorial/devtools-extension.md)
* [Usando o plugin papper flash](../../docs/tutorial/using-pepper-flash-plugin.md)
## Tutoriais
* [Introdução](../../docs/tutorial/quick-start.md)
* [A integração com o ambiente de desenvolvimento](../../docs/tutorial/desktop-environment-integration.md)
* [Evento de detecção on-line/off-line](../../docs/tutorial/online-offline-events.md)
## API - Referencias
* [Sinopse](../../docs/api/synopsis.md)
* [Processos](../../docs/api/process.md)
* [Parâmetros CLI suportados (Chrome)](../../docs/api/chrome-command-line-switches.md)
DOM elementos personalizados:
* [Objeto `File`](../../docs/api/file-object.md)
* [Tag `<webview>`](../../docs/api/web-view-tag.md)
* [Função `window.open`](../../docs/api/window-open.md)
Os principais módulos:
* [app](../../docs/api/app.md)
* [auto-updater](../../docs/api/auto-updater.md)
* [browser-window](../../docs/api/browser-window.md)
* [content-tracing](../../docs/api/content-tracing.md)
* [dialog](../../docs/api/dialog.md)
* [global-shortcut](../../docs/api/global-shortcut.md)
* [ipc (main process)](../../docs/api/ipc-main-process.md)
* [menu](../../docs/api/menu.md)
* [menu-item](../../docs/api/menu-item.md)
* [power-monitor](../../docs/api/power-monitor.md)
* [power-save-blocker](../../docs/api/power-save-blocker.md)
* [protocol](../../docs/api/protocol.md)
* [session](../../docs/api/session.md)
* [webContents](../../docs/api/web-contents.md)
* [tray](../../docs/api/tray.md)
Módulos do renderizador (web page):
* [ipc (renderer)](../../docs/api/ipc-renderer.md)
* [remote](../../docs/api/remote.md)
* [web-frame](../../docs/api/web-frame.md)
Módulos de ambos os processos:
* [clipboard](../../docs/api/clipboard.md)
* [crash-reporter](../../docs/api/crash-reporter.md)
* [native-image](../../docs/api/native-image.md)
* [screen](../../docs/api/screen.md)
* [shell](../../docs/api/shell.md)
## Desenvolvimento
* [Estilo de código](../../docs/development/coding-style.md)
* [Estrutura de diretórios padrão](../../docs/development/source-code-directory-structure.md)
* [Diferenças técnicas do NW.js (antigo node-webkit)](../../docs/development/atom-shell-vs-node-webkit.md)
* [Visão geral do build](../../docs/development/build-system-overview.md)
* [Instrução de build (Mac)](../../docs/development/build-instructions-osx.md)
* [Instrução de build (Windows)](../../docs/development/build-instructions-windows.md)
* [Instrução de build (Linux)](../../docs/development/build-instructions-linux.md)
* [Configurando um symbol server no debugger](../../docs/development/setting-up-symbol-server.md)

View file

@ -0,0 +1,77 @@
# Styleguide do Electron
Localize a seção apropriada para a sua tarefa: [Lendo a documentação do Electron](#)
ou [Escrevendo documentação para o Electron](#).
## Escrevendo documentação para o Electron
Estas são as formas que escrevemos a documentação do Electron.
- No Máximo um `h1` por página.
- Usar `bash` ao invés de` cmd` em blocos de código (por causa do syntax highlighter).
- Títulos `h1` deve coincidir com o nome do objeto (i.e. `browser-window`
`BrowserWindow`).
- Nomes de arquivos separados por hífen.
- Adicionar pelo menos uma descrição a cada frase.
- Métodos de cabeçalhos são envolto em `code`.
- Cabeçalhos de eventos são envolto em single 'quotation' marks.
- Não há listas com identação com mais de 2 níveis (por causa do markdown).
- Adicione títulos nas seções: Events, Class Methods e Instance Methods.
- Use 'will' ao invéis de 'would' ao descrever os resultados.
- Eventos e métodos são com cabeçalhos `h3`.
- Argumentos opcionais escritos como `function (required[, optional])`.
- Argumentos opcionais são indicados quando chamado na lista.
- Comprimento da linha é de 80 caracteres com colunas quebradas.
- Métodos específicos para uma plataforma são postos em itálico seguindo o cabeçalho do método.
- ```### `method(foo, bar)` _OS X_```
## Lendo a documentação do Electron
Aqui estão algumas dicas de como entender a sintaxe da documentacão do Electron.
### Métodos
Um exemplo de [method](https://developer.mozilla.org/en-US/docs/Glossary/Method)
documentação:
---
`methodName(required[, optional]))`
* `require` String, **required**
* `optional` Integer
---
O nome do método é seguido pelos seus argumentos. Argumentos opcionais são
simbolizada por colchetes que cercam o argumento opcional, bem como a vírgula
requerido se este argumento opcional segue outro argumento.
Abaixo o método é para obter informações detalhadas sobre cada um dos argumentos. O tipo
de argumento é simbolizada por qualquer um dos tipos mais comuns: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [` Number`](https : //developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript Referência/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
ou um tipo personalizado como o de Electron [`webContent`](api/web-content.md).
### Eventos
Um exemplo de [evento](https://developer.mozilla.org/en-US/docs/Web/API/Event)
documentação:
---
Event: 'wake-up'
Returns:
* `time` String
---
O evento é uma cadeia que é utilizada após um `.on` em um método listner. Se ela retorna
-lhe um valor e seu tipo é observado abaixo. Se você quiser um método para esctuar e responder
crie algo parecido com o exemplo abaixo:
```javascript
Alarm.on('wake-up', function(time) {
console.log(time)
})
```