mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

link process annotations to glossary

Browse source
This commit is contained in:
Zeke Sikelianos 2016-11-23 11:20:56 -08:00
commit e57cb713b2
35 changed files with 39 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs-translations/pt-BR/api/power-save-blocker.md
View file

@ -2,7 +2,7 @@
> loquear o sistema de entrar no modo de pouca energia (suspenso). > loquear o sistema de entrar no modo de pouca energia (suspenso).
Processo: [Main](../tutorial/quick-start.md#main-process) Processo: [Main](../glossary.md#main-process)
Por exemplo: Por exemplo:

2
docs/api/app.md
View file

@ -2,7 +2,7 @@
> Control your application's event lifecycle. > Control your application's event lifecycle.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
The following example shows how to quit the application when the last window is The following example shows how to quit the application when the last window is
closed: closed:

2
docs/api/auto-updater.md
View file

@ -2,7 +2,7 @@
> Enable apps to automatically update themselves. > Enable apps to automatically update themselves.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
The `autoUpdater` module provides an interface for the The `autoUpdater` module provides an interface for the
[Squirrel](https://github.com/Squirrel) framework. [Squirrel](https://github.com/Squirrel) framework.

2
docs/api/browser-window-proxy.md
View file

@ -2,7 +2,7 @@
> Manipulate the child browser window > Manipulate the child browser window
Process: [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Renderer](../glossary.md#renderer-process)
The `BrowserWindowProxy` object is returned from `window.open` and provides The `BrowserWindowProxy` object is returned from `window.open` and provides
limited functionality with the child window. limited functionality with the child window.

4
docs/api/browser-window.md
View file

@ -2,7 +2,7 @@
> Create and control browser windows. > Create and control browser windows.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
```javascript ```javascript
// In the main process. // In the main process.
@ -111,7 +111,7 @@ child.once('ready-to-show', () => {
> Create and control browser windows. > Create and control browser windows.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
`BrowserWindow` is an `BrowserWindow` is an
[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter).

2
docs/api/client-request.md
View file

@ -2,7 +2,7 @@
> Make HTTP/HTTPS requests. > Make HTTP/HTTPS requests.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
`ClientRequest` implements the [Writable Stream](https://nodejs.org/api/stream.html#stream_writable_streams) `ClientRequest` implements the [Writable Stream](https://nodejs.org/api/stream.html#stream_writable_streams)
interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter).

2
docs/api/clipboard.md
View file

@ -2,7 +2,7 @@
> Perform copy and paste operations on the system clipboard. > Perform copy and paste operations on the system clipboard.
Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
The following example shows how to write a string to the clipboard: The following example shows how to write a string to the clipboard:

2
docs/api/content-tracing.md
View file

@ -3,7 +3,7 @@
> Collect tracing data from Chromium's content module for finding performance > Collect tracing data from Chromium's content module for finding performance
bottlenecks and slow operations. bottlenecks and slow operations.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
This module does not include a web interface so you need to open This module does not include a web interface so you need to open
`chrome://tracing/` in a Chrome browser and load the generated file to view the `chrome://tracing/` in a Chrome browser and load the generated file to view the

2
docs/api/cookies.md
View file

@ -2,7 +2,7 @@
> Query and modify a session's cookies. > Query and modify a session's cookies.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
Instances of the `Cookies` class are accessed by using `cookies` property of Instances of the `Cookies` class are accessed by using `cookies` property of
a `Session`. a `Session`.

2
docs/api/crash-reporter.md
View file

@ -2,7 +2,7 @@
> Submit crash reports to a remote server. > Submit crash reports to a remote server.
Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
The following is an example of automatically submitting a crash report to a The following is an example of automatically submitting a crash report to a
remote server: remote server:

2
docs/api/debugger.md
View file

@ -2,7 +2,7 @@
> An alternate transport for Chrome's remote debugging protocol. > An alternate transport for Chrome's remote debugging protocol.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
Chrome Developer Tools has a [special binding][rdp] available at JavaScript Chrome Developer Tools has a [special binding][rdp] available at JavaScript
runtime that allows interacting with pages and instrumenting them. runtime that allows interacting with pages and instrumenting them.

2
docs/api/desktop-capturer.md
View file

@ -3,7 +3,7 @@
> Access information about media sources that can be used to capture audio and > Access information about media sources that can be used to capture audio and
> video from the desktop using the [`navigator.webkitGetUserMedia`] API. > video from the desktop using the [`navigator.webkitGetUserMedia`] API.
Process: [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Renderer](../glossary.md#renderer-process)
The following example shows how to capture video from a desktop window whose The following example shows how to capture video from a desktop window whose
title is `Electron`: title is `Electron`:

2
docs/api/dialog.md
View file

@ -2,7 +2,7 @@
> Display native system dialogs for opening and saving files, alerting, etc. > Display native system dialogs for opening and saving files, alerting, etc.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
An example of showing a dialog to select multiple files and directories: An example of showing a dialog to select multiple files and directories:

2
docs/api/download-item.md
View file

@ -2,7 +2,7 @@
> Control file downloads from remote sources. > Control file downloads from remote sources.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
`DownloadItem` is an `EventEmitter` that represents a download item in Electron. `DownloadItem` is an `EventEmitter` that represents a download item in Electron.
It is used in `will-download` event of `Session` class, and allows users to It is used in `will-download` event of `Session` class, and allows users to

2
docs/api/global-shortcut.md
View file

@ -2,7 +2,7 @@
> Detect keyboard events when the application does not have keyboard focus. > Detect keyboard events when the application does not have keyboard focus.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
The `globalShortcut` module can register/unregister a global keyboard shortcut The `globalShortcut` module can register/unregister a global keyboard shortcut
with the operating system so that you can customize the operations for various with the operating system so that you can customize the operations for various

2
docs/api/incoming-message.md
View file

@ -2,7 +2,7 @@
> Handle responses to HTTP/HTTPS requests. > Handle responses to HTTP/HTTPS requests.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
`IncomingMessage` implements the [Readable Stream](https://nodejs.org/api/stream.html#stream_readable_streams) `IncomingMessage` implements the [Readable Stream](https://nodejs.org/api/stream.html#stream_readable_streams)
interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter).

2
docs/api/ipc-main.md
View file

@ -2,7 +2,7 @@
> Communicate asynchronously from the main process to renderer processes. > Communicate asynchronously from the main process to renderer processes.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
The `ipcMain` module is an instance of the The `ipcMain` module is an instance of the
[EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. When used in the main [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. When used in the main

2
docs/api/ipc-renderer.md
View file

@ -2,7 +2,7 @@
> Communicate asynchronously from a renderer process to the main process. > Communicate asynchronously from a renderer process to the main process.
Process: [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Renderer](../glossary.md#renderer-process)
The `ipcRenderer` module is an instance of the The `ipcRenderer` module is an instance of the
[EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. It provides a few [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. It provides a few

2
docs/api/menu-item.md
View file

@ -2,7 +2,7 @@
> Add items to native application menus and context menus. > Add items to native application menus and context menus.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
See [`Menu`](menu.md) for examples. See [`Menu`](menu.md) for examples.

2
docs/api/menu.md
View file

@ -2,7 +2,7 @@
> Create native application menus and context menus. > Create native application menus and context menus.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
### `new Menu()` ### `new Menu()`

4
docs/api/native-image.md
View file

@ -2,7 +2,7 @@
> Create tray, dock, and application icons using PNG or JPG files. > Create tray, dock, and application icons using PNG or JPG files.
Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
In Electron, for the APIs that take images, you can pass either file paths or In Electron, for the APIs that take images, you can pass either file paths or
`NativeImage` instances. An empty image will be used when `null` is passed. `NativeImage` instances. An empty image will be used when `null` is passed.
@ -159,7 +159,7 @@ Creates a new `NativeImage` instance from `dataURL`.
> Natively wrap images such as tray, dock, and application icons. > Natively wrap images such as tray, dock, and application icons.
Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
### Instance Methods ### Instance Methods

2
docs/api/net.md
View file

@ -2,7 +2,7 @@
> Issue HTTP/HTTPS requests using Chromium's native networking library > Issue HTTP/HTTPS requests using Chromium's native networking library
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
The `net` module is a client-side API for issuing HTTP(S) requests. It is The `net` module is a client-side API for issuing HTTP(S) requests. It is
similar to the [HTTP](https://nodejs.org/api/http.html) and similar to the [HTTP](https://nodejs.org/api/http.html) and

2
docs/api/power-monitor.md
View file

@ -2,7 +2,7 @@
> Monitor power state changes. > Monitor power state changes.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
You cannot require or use this module until the `ready` event of the `app` You cannot require or use this module until the `ready` event of the `app`
module is emitted. module is emitted.

2
docs/api/power-save-blocker.md
View file

@ -2,7 +2,7 @@
> Block the system from entering low-power (sleep) mode. > Block the system from entering low-power (sleep) mode.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
For example: For example:

2
docs/api/process.md
View file

@ -2,7 +2,7 @@
> Extensions to process object. > Extensions to process object.
Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
Electron's `process` object is extended from the Electron's `process` object is extended from the
[Node.js `process` object](https://nodejs.org/api/process.html). [Node.js `process` object](https://nodejs.org/api/process.html).

2
docs/api/protocol.md
View file

@ -2,7 +2,7 @@
> Register a custom protocol and intercept existing protocol requests. > Register a custom protocol and intercept existing protocol requests.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
An example of implementing a protocol that has the same effect as the An example of implementing a protocol that has the same effect as the
`file://` protocol: `file://` protocol:

2
docs/api/remote.md
View file

@ -2,7 +2,7 @@
> Use main process modules from the renderer process. > Use main process modules from the renderer process.
Process: [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Renderer](../glossary.md#renderer-process)
The `remote` module provides a simple way to do inter-process communication The `remote` module provides a simple way to do inter-process communication
(IPC) between the renderer process (web page) and the main process. (IPC) between the renderer process (web page) and the main process.

2
docs/api/screen.md
View file

@ -2,7 +2,7 @@
> Retrieve information about screen size, displays, cursor position, etc. > Retrieve information about screen size, displays, cursor position, etc.
Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
You cannot require or use this module until the `ready` event of the `app` You cannot require or use this module until the `ready` event of the `app`
module is emitted. module is emitted.

4
docs/api/session.md
View file

@ -2,7 +2,7 @@
> Manage browser sessions, cookies, cache, proxy settings, etc. > Manage browser sessions, cookies, cache, proxy settings, etc.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
The `session` module can be used to create new `Session` objects. The `session` module can be used to create new `Session` objects.
@ -54,7 +54,7 @@ A `Session` object, the default session object of the app.
> Get and set properties of a session. > Get and set properties of a session.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
You can create a `Session` object in the `session` module: You can create a `Session` object in the `session` module:

2
docs/api/shell.md
View file

@ -2,7 +2,7 @@
> Manage files and URLs using their default applications. > Manage files and URLs using their default applications.
Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
The `shell` module provides functions related to desktop integration. The `shell` module provides functions related to desktop integration.

2
docs/api/system-preferences.md
View file

@ -2,7 +2,7 @@
> Get system preferences. > Get system preferences.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
```javascript ```javascript
const {systemPreferences} = require('electron') const {systemPreferences} = require('electron')

2
docs/api/tray.md
View file

@ -2,7 +2,7 @@
> Add icons and context menus to the system's notification area. > Add icons and context menus to the system's notification area.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
`Tray` is an [EventEmitter][event-emitter]. `Tray` is an [EventEmitter][event-emitter].

4
docs/api/web-contents.md
View file

@ -2,7 +2,7 @@
> Render and control web pages. > Render and control web pages.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
`webContents` is an `webContents` is an
[EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter).
@ -49,7 +49,7 @@ Returns `WebContents` - A WebContents instance with the given ID.
> Render and control the contents of a BrowserWindow instance. > Render and control the contents of a BrowserWindow instance.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
### Instance Events ### Instance Events

2
docs/api/web-frame.md
View file

@ -2,7 +2,7 @@
> Customize the rendering of the current web page. > Customize the rendering of the current web page.
Process: [Renderer](../tutorial/quick-start.md#renderer-process) Process: [Renderer](../glossary.md#renderer-process)
An example of zooming current page to 200%. An example of zooming current page to 200%.

2
docs/api/web-request.md
View file

@ -2,7 +2,7 @@
> Intercept and modify the contents of a request at various stages of its lifetime. > Intercept and modify the contents of a request at various stages of its lifetime.
Process: [Main](../tutorial/quick-start.md#main-process) Process: [Main](../glossary.md#main-process)
Instances of the `WebRequest` class are accessed by using the `webRequest` Instances of the `WebRequest` class are accessed by using the `webRequest`
property of a `Session`. property of a `Session`.