docs-translations/tr-TR/styleguide.md

   1 # Electron Dokümantasyonu Stil Rehberi
   2
   3 Size uygun bölümü bulun: [Electron Dokümantasyonunu okumak](#reading-electron-documentation)
   4 ya da [Electron Dokümantasyonunu yazmak](#writing-electron-documentation).
   5
   6 ## Electron Dokümantasyonunu Yazmak
   7
   8 Electron Dokümantasyonunu geliştirmek için aşağıdaki yöntemleri takip edin.
   9
  10 - Her sayfada en fazla bir tane `h1` etiketi olmalıdır.
  11 - Kod bloklarında `cmd` yerine `bash` kullanın.(syntax highlighter için).
  12 - `h1` Başlığı nesne ismiyle eşleşmeli (ör. `browser-window` →
  13   `BrowserWindow`).
  14   - Hyphen separated filenames, however, are fine.
  15 - No headers following headers, add at least a one-sentence description.
  16 - Methods headers are wrapped in `code` ticks.
  17 - Event headers are wrapped in single 'quotation' marks.
  18 - No nesting lists more than 2 levels (unfortunately because of markdown
  19   renderer).
  20 - Add section titles: Events, Class Methods and Instance Methods.
  21 - Use 'will' over 'would' when describing outcomes.
  22 - Events and methods are `h3` headers.
  23 - Optional arguments written as `function (required[, optional])`.
  24 - Optional arguments are denoted when called out in list.
  25 - Line length is 80-column wrapped.
  26 - Platform specific methods are noted in italics following method header.
  27  - ```### `method(foo, bar)` _macOS_```
  28 - Prefer 'in the ___ process' over 'on'
  29
  30 ### Dokümantasyon Çevirisi
  31
  32 Electron Dokümantasyonunun çevirileri `docs-translations` klasörü içerisindedir.
  33
  34 To add another set (or partial set):
  35
  36 - Create a subdirectory named by language abbreviation.
  37 - Within that subdirectory, duplicate the `docs` directory, keeping the
  38   names of directories and files same.
  39 - Translate the files.
  40 - Update the `README.md` within your language directory to link to the files
  41   you have translated.
  42 - Add a link to your translation directory on the main Electron [README](https://github.com/electron/electron#documentation-translations).
  43
  44 ## Electron Dokümantasyonunu Okumak
  45
  46 Electron Dokümantasyon sözdizimini(syntax) anlayabileceğiniz bir kaç ipucu:
  47
  48 ### Metodlar
  49
  50 [Method](https://developer.mozilla.org/en-US/docs/Glossary/Method) dokümantasyonunun bir örneği:
  51
  52 ---
  53
  54 `methodName(required[, optional]))`
  55
  56 * `require` String (**required**)
  57 * `optional` Integer
  58
  59 ---
  60
  61 The method name is followed by the arguments it takes. Optional arguments are
  62 notated by brackets surrounding the optional argument as well as the comma
  63 required if this optional argument follows another argument.
  64
  65 Below the method is more detailed information on each of the arguments. The type
  66 of argument is notated by either the common types:
  67 [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String),
  68 [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number),
  69 [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object),
  70 [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
  71 or a custom type like Electron's [`webContent`](https://github.com/electron/electron/tree/master/docs/api/web-content.md).
  72
  73 ### Events
  74
  75 [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) Dokümantasyonunun bir örneği:
  76
  77 ---
  78
  79 Event: 'wake-up'
  80
  81 Returns:
  82
  83 * `time` String
  84
  85 ---
  86
  87 The event is a string that is used after a `.on` listener method. If it returns
  88 a value it and its type is noted below. If you were to listen and respond to
  89 this event it might look something like this:
  90
  91 ```javascript
  92 Alarm.on('wake-up', function (time) {
  93   console.log(time)
  94 })
  95 ```