зеркало из https://github.com/electron/electron.git
Update README
This commit is contained in:
Родитель
60b9ff3948
Коммит
d02125bde5
|
@ -53,6 +53,7 @@ contains documents describing how to build and contribute to Electron.
|
|||
- [Spanish](https://github.com/electron/electron/tree/master/docs-translations/es)
|
||||
- [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN)
|
||||
- [Traditional Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-TW)
|
||||
- [Turkish](https://github.com/electron/electron/tree/master/docs-translations/tr-TR)
|
||||
- [Ukrainian](https://github.com/electron/electron/tree/master/docs-translations/uk-UA)
|
||||
- [Russian](https://github.com/electron/electron/tree/master/docs-translations/ru-RU)
|
||||
- [French](https://github.com/electron/electron/tree/master/docs-translations/fr-FR)
|
||||
|
|
|
@ -0,0 +1,86 @@
|
|||
Lütfen kullandığınız dokümanın Electron versiyonunuzla aynı olduğundan emin olun.
|
||||
Versiyon numarası okuduğunuz dokümanın URL'sindekiyle aynı olmalı. Eğer aynı değilse, muhtemelen geliştirme aşamasındaki API değişikliklerini içerebilecek dokümantasyonudur.
|
||||
Eğer öyleyse, atom.io üzerinden [mevcut sürümler](http://electron.atom.io/docs/)e göz atabilirsiniz ya da eğer GitHub arayüzünü kullanıyorsanız "Switch branches/tags" açılır menüsünden versiyonunuza uygun olanı seçebilirsiniz.
|
||||
|
||||
## SSS(Sıkça Sorulan Sorular)
|
||||
|
||||
Bir problem(issue) bildirmeden önce sıkça sorulan sorulara göz atın:
|
||||
* [Electron SSS](faq/electron-faq.md)
|
||||
|
||||
## Klavuzlar
|
||||
|
||||
* [Desteklenen Platformlar ](tutorial/supported-platforms.md)
|
||||
* [Uygulama Dağıtımı](tutorial/application-distribution.md)
|
||||
* [Mac Uygulama Mağazası Başvuru Klavuzu](tutorial/mac-app-store-submission-guide.md)
|
||||
* [Uygulama Paketleme](tutorial/application-packaging.md)
|
||||
* [Native Node Modüllerini Kullanma](tutorial/using-native-node-modules.md)
|
||||
* [Ana Süreç(Main Process) Hata ayıklama](tutorial/debugging-main-process.md)
|
||||
* [Selenium ve WebDriver kullanımı](tutorial/using-selenium-and-webdriver.md)
|
||||
* [DevTools Eklentisi](tutorial/devtools-extension.md)
|
||||
* [Pepper Flash Kullanımı](tutorial/using-pepper-flash-plugin.md)
|
||||
* [Widevine CDM Kullanımı](tutorial/using-widevine-cdm-plugin.md)
|
||||
* [CI Sistem Testleri (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
|
||||
|
||||
## Eğitimler
|
||||
|
||||
* [Quick Start](tutorial/quick-start.md)
|
||||
* [Desktop Environment Integration](tutorial/desktop-environment-integration.md)
|
||||
* [Online/Offline Event Detection](tutorial/online-offline-events.md)
|
||||
|
||||
## API Kaynakları
|
||||
|
||||
* [Synopsis](api/synopsis.md)
|
||||
* [Process Object](api/process.md)
|
||||
* [Desteklenen Chrome Komut Satırı Anahtarları](api/chrome-command-line-switches.md)
|
||||
* [Environment Değişkenleri](api/environment-variables.md)
|
||||
|
||||
### Özel DOM Elementleri:
|
||||
|
||||
* [`File` Nesnesi](api/file-object.md)
|
||||
* [`<webview>` Etiketi](api/web-view-tag.md)
|
||||
* [`window.open` Fonksiyonu](api/window-open.md)
|
||||
|
||||
### Ana Süreç(Main Process) Modülleri:
|
||||
|
||||
* [app](api/app.md)
|
||||
* [autoUpdater](api/auto-updater.md)
|
||||
* [BrowserWindow](api/browser-window.md)
|
||||
* [contentTracing](api/content-tracing.md)
|
||||
* [dialog](api/dialog.md)
|
||||
* [globalShortcut](api/global-shortcut.md)
|
||||
* [ipcMain](api/ipc-main.md)
|
||||
* [Menu](api/menu.md)
|
||||
* [MenuItem](api/menu-item.md)
|
||||
* [powerMonitor](api/power-monitor.md)
|
||||
* [powerSaveBlocker](api/power-save-blocker.md)
|
||||
* [protocol](api/protocol.md)
|
||||
* [session](api/session.md)
|
||||
* [webContents](api/web-contents.md)
|
||||
* [Tray](api/tray.md)
|
||||
|
||||
### Renderer Process Modülelri (Web Page):
|
||||
|
||||
* [desktopCapturer](api/desktop-capturer.md)
|
||||
* [ipcRenderer](api/ipc-renderer.md)
|
||||
* [remote](api/remote.md)
|
||||
* [webFrame](api/web-frame.md)
|
||||
|
||||
### Her İki Süreç İçin Geçerli Modüller:
|
||||
|
||||
* [clipboard](api/clipboard.md)
|
||||
* [crashReporter](api/crash-reporter.md)
|
||||
* [nativeImage](api/native-image.md)
|
||||
* [screen](api/screen.md)
|
||||
* [shell](api/shell.md)
|
||||
|
||||
## Geliştirme
|
||||
|
||||
* [Kodlama Stili](development/coding-style.md)
|
||||
* [Kaynak Kod Dizin Yapısı](development/source-code-directory-structure.md)
|
||||
* [NW.js(node-webkit adıyla bilinen) İle Arasındaki Teknik Farklılıklar](development/atom-shell-vs-node-webkit.md)
|
||||
* [Build Sisyem Genel Bakış](development/build-system-overview.md)
|
||||
* [(OS X) Build Komutları](development/build-instructions-osx.md)
|
||||
* [(Windows) Build Komutları](development/build-instructions-windows.md)
|
||||
* [(Linux) Build Komutları](development/build-instructions-linux.md)
|
||||
* [(Windows) Hata Ayıklama Komutları](development/debug-instructions-windows.md)
|
||||
* [Simge Sunucusu(Symbol Server) Hata Ayıklama Kurulumu](development/setting-up-symbol-server.md)
|
|
@ -0,0 +1,95 @@
|
|||
# Electron Dokümantasyonu Stil Rehberi
|
||||
|
||||
Size uygun bölümü bulun: [Electron Dokümantasyonunu okumak](#reading-electron-documentation)
|
||||
ya da [Electron Dokümantasyonunu yazmak](#writing-electron-documentation).
|
||||
|
||||
## Electron Dokümantasyonunu Yazmak
|
||||
|
||||
Electron Dokümantasyonunu geliştirmek için aşağıdaki yöntemleri takip edin.
|
||||
|
||||
- Her sayfada en fazla bir tane `h1` etiketi olmalıdır.
|
||||
- Kod bloklarında `cmd` yerine `bash` kullanın.(syntax highlighter için).
|
||||
- `h1` Başlığı nesne ismiyle eşleşmeli (ör. `browser-window` →
|
||||
`BrowserWindow`).
|
||||
- Hyphen separated filenames, however, are fine.
|
||||
- No headers following headers, add at least a one-sentence description.
|
||||
- Methods headers are wrapped in `code` ticks.
|
||||
- Event headers are wrapped in single 'quotation' marks.
|
||||
- No nesting lists more than 2 levels (unfortunately because of markdown
|
||||
renderer).
|
||||
- Add section titles: Events, Class Methods and Instance Methods.
|
||||
- Use 'will' over 'would' when describing outcomes.
|
||||
- Events and methods are `h3` headers.
|
||||
- Optional arguments written as `function (required[, optional])`.
|
||||
- Optional arguments are denoted when called out in list.
|
||||
- Line length is 80-column wrapped.
|
||||
- Platform specific methods are noted in italics following method header.
|
||||
- ```### `method(foo, bar)` _OS X_```
|
||||
- Prefer 'in the ___ process' over 'on'
|
||||
|
||||
### Dokümantasyon Çevirisi
|
||||
|
||||
Electron Dokümantasyonunun çevirileri `docs-translations` klasörü içerisindedir.
|
||||
|
||||
To add another set (or partial set):
|
||||
|
||||
- Create a subdirectory named by language abbreviation.
|
||||
- Within that subdirectory, duplicate the `docs` directory, keeping the
|
||||
names of directories and files same.
|
||||
- Translate the files.
|
||||
- Update the `README.md` within your language directory to link to the files
|
||||
you have translated.
|
||||
- Add a link to your translation directory on the main Electron [README](https://github.com/electron/electron#documentation-translations).
|
||||
|
||||
## Electron Dokümantasyonunu Okumak
|
||||
|
||||
Electron Dokümantasyon sözdizimini(syntax) anlayabileceğiniz bir kaç ipucu:
|
||||
|
||||
### Metodlar
|
||||
|
||||
[Method](https://developer.mozilla.org/en-US/docs/Glossary/Method) dokümantasyonunun bir örneği:
|
||||
|
||||
---
|
||||
|
||||
`methodName(required[, optional]))`
|
||||
|
||||
* `require` String (**required**)
|
||||
* `optional` Integer
|
||||
|
||||
---
|
||||
|
||||
The method name is followed by the arguments it takes. Optional arguments are
|
||||
notated by brackets surrounding the optional argument as well as the comma
|
||||
required if this optional argument follows another argument.
|
||||
|
||||
Below the method is more detailed information on each of the arguments. The type
|
||||
of argument is notated by either the common types:
|
||||
[`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/Reference/Global_Objects/Object),
|
||||
[`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
|
||||
or a custom type like Electron's [`webContent`](api/web-content.md).
|
||||
|
||||
### Events
|
||||
|
||||
[event](https://developer.mozilla.org/en-US/docs/Web/API/Event) Dokümantasyonunun bir örneği:
|
||||
|
||||
---
|
||||
|
||||
Event: 'wake-up'
|
||||
|
||||
Returns:
|
||||
|
||||
* `time` String
|
||||
|
||||
---
|
||||
|
||||
The event is a string that is used after a `.on` listener method. If it returns
|
||||
a value it and its type is noted below. If you were to listen and respond to
|
||||
this event it might look something like this:
|
||||
|
||||
```javascript
|
||||
Alarm.on('wake-up', function(time) {
|
||||
console.log(time)
|
||||
})
|
||||
```
|
Загрузка…
Ссылка в новой задаче