From e57cb713b2d1b59fbc8e63c28b5d8380d0fe44d6 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Wed, 23 Nov 2016 11:20:56 -0800 Subject: [PATCH] link process annotations to glossary --- docs-translations/pt-BR/api/power-save-blocker.md | 2 +- docs/api/app.md | 2 +- docs/api/auto-updater.md | 2 +- docs/api/browser-window-proxy.md | 2 +- docs/api/browser-window.md | 4 ++-- docs/api/client-request.md | 2 +- docs/api/clipboard.md | 2 +- docs/api/content-tracing.md | 2 +- docs/api/cookies.md | 2 +- docs/api/crash-reporter.md | 2 +- docs/api/debugger.md | 2 +- docs/api/desktop-capturer.md | 2 +- docs/api/dialog.md | 2 +- docs/api/download-item.md | 2 +- docs/api/global-shortcut.md | 2 +- docs/api/incoming-message.md | 2 +- docs/api/ipc-main.md | 2 +- docs/api/ipc-renderer.md | 2 +- docs/api/menu-item.md | 2 +- docs/api/menu.md | 2 +- docs/api/native-image.md | 4 ++-- docs/api/net.md | 2 +- docs/api/power-monitor.md | 2 +- docs/api/power-save-blocker.md | 2 +- docs/api/process.md | 2 +- docs/api/protocol.md | 2 +- docs/api/remote.md | 2 +- docs/api/screen.md | 2 +- docs/api/session.md | 4 ++-- docs/api/shell.md | 2 +- docs/api/system-preferences.md | 2 +- docs/api/tray.md | 2 +- docs/api/web-contents.md | 4 ++-- docs/api/web-frame.md | 2 +- docs/api/web-request.md | 2 +- 35 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs-translations/pt-BR/api/power-save-blocker.md b/docs-translations/pt-BR/api/power-save-blocker.md index efed0c1c7f..fd9eed1da2 100644 --- a/docs-translations/pt-BR/api/power-save-blocker.md +++ b/docs-translations/pt-BR/api/power-save-blocker.md @@ -2,7 +2,7 @@ > 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: diff --git a/docs/api/app.md b/docs/api/app.md index 081c6dc2ab..e473f720cf 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -2,7 +2,7 @@ > 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 closed: diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index 720e289691..219e1eb213 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -2,7 +2,7 @@ > 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 [Squirrel](https://github.com/Squirrel) framework. diff --git a/docs/api/browser-window-proxy.md b/docs/api/browser-window-proxy.md index a6d57299cf..2bf5a15f74 100644 --- a/docs/api/browser-window-proxy.md +++ b/docs/api/browser-window-proxy.md @@ -2,7 +2,7 @@ > 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 limited functionality with the child window. diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 2b57a46d16..e88cae5717 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -2,7 +2,7 @@ > Create and control browser windows. -Process: [Main](../tutorial/quick-start.md#main-process) +Process: [Main](../glossary.md#main-process) ```javascript // In the main process. @@ -111,7 +111,7 @@ child.once('ready-to-show', () => { > Create and control browser windows. -Process: [Main](../tutorial/quick-start.md#main-process) +Process: [Main](../glossary.md#main-process) `BrowserWindow` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). diff --git a/docs/api/client-request.md b/docs/api/client-request.md index bcde94dd8d..0b722f2f09 100644 --- a/docs/api/client-request.md +++ b/docs/api/client-request.md @@ -2,7 +2,7 @@ > 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) interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index d648b22c02..932a1da7b2 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -2,7 +2,7 @@ > 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: diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 36a85ff035..a1c76d8807 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -3,7 +3,7 @@ > Collect tracing data from Chromium's content module for finding performance 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 `chrome://tracing/` in a Chrome browser and load the generated file to view the diff --git a/docs/api/cookies.md b/docs/api/cookies.md index 7a9151e97a..35759aaee1 100644 --- a/docs/api/cookies.md +++ b/docs/api/cookies.md @@ -2,7 +2,7 @@ > 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 a `Session`. diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 3fc85f9484..013a337767 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -2,7 +2,7 @@ > 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 remote server: diff --git a/docs/api/debugger.md b/docs/api/debugger.md index a0e20277c2..1be33833ed 100644 --- a/docs/api/debugger.md +++ b/docs/api/debugger.md @@ -2,7 +2,7 @@ > 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 runtime that allows interacting with pages and instrumenting them. diff --git a/docs/api/desktop-capturer.md b/docs/api/desktop-capturer.md index 5e64a8403d..85755dc03e 100644 --- a/docs/api/desktop-capturer.md +++ b/docs/api/desktop-capturer.md @@ -3,7 +3,7 @@ > Access information about media sources that can be used to capture audio and > 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 title is `Electron`: diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 0a330f525f..12700bd878 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -2,7 +2,7 @@ > 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: diff --git a/docs/api/download-item.md b/docs/api/download-item.md index 25f75ebdb3..6603b619aa 100644 --- a/docs/api/download-item.md +++ b/docs/api/download-item.md @@ -2,7 +2,7 @@ > 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. It is used in `will-download` event of `Session` class, and allows users to diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index db6253e4b7..d0f48a6f80 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -2,7 +2,7 @@ > 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 with the operating system so that you can customize the operations for various diff --git a/docs/api/incoming-message.md b/docs/api/incoming-message.md index addb975c5b..f047aaa7e4 100644 --- a/docs/api/incoming-message.md +++ b/docs/api/incoming-message.md @@ -2,7 +2,7 @@ > 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) interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). diff --git a/docs/api/ipc-main.md b/docs/api/ipc-main.md index c474512ad6..57c57b5a4e 100644 --- a/docs/api/ipc-main.md +++ b/docs/api/ipc-main.md @@ -2,7 +2,7 @@ > 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 [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. When used in the main diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md index db150d489c..de67648764 100644 --- a/docs/api/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -2,7 +2,7 @@ > 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 [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. It provides a few diff --git a/docs/api/menu-item.md b/docs/api/menu-item.md index 01ca90bf23..a5375a5b8c 100644 --- a/docs/api/menu-item.md +++ b/docs/api/menu-item.md @@ -2,7 +2,7 @@ > 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. diff --git a/docs/api/menu.md b/docs/api/menu.md index 3150d8ad55..64ab3afafb 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -2,7 +2,7 @@ > Create native application menus and context menus. -Process: [Main](../tutorial/quick-start.md#main-process) +Process: [Main](../glossary.md#main-process) ### `new Menu()` diff --git a/docs/api/native-image.md b/docs/api/native-image.md index a1f6614d65..cc910cbb8a 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -2,7 +2,7 @@ > 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 `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. -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 diff --git a/docs/api/net.md b/docs/api/net.md index b34790474f..e5e5961714 100644 --- a/docs/api/net.md +++ b/docs/api/net.md @@ -2,7 +2,7 @@ > 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 similar to the [HTTP](https://nodejs.org/api/http.html) and diff --git a/docs/api/power-monitor.md b/docs/api/power-monitor.md index 5827ef6205..0c012c64ac 100644 --- a/docs/api/power-monitor.md +++ b/docs/api/power-monitor.md @@ -2,7 +2,7 @@ > 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` module is emitted. diff --git a/docs/api/power-save-blocker.md b/docs/api/power-save-blocker.md index cd1138f195..f78ec5d999 100644 --- a/docs/api/power-save-blocker.md +++ b/docs/api/power-save-blocker.md @@ -2,7 +2,7 @@ > 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: diff --git a/docs/api/process.md b/docs/api/process.md index 9b05b61fdd..951abc7df1 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -2,7 +2,7 @@ > 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 [Node.js `process` object](https://nodejs.org/api/process.html). diff --git a/docs/api/protocol.md b/docs/api/protocol.md index 106839b4b7..3de153db48 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -2,7 +2,7 @@ > 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 `file://` protocol: diff --git a/docs/api/remote.md b/docs/api/remote.md index fd0ebcc159..0bed3ad9b5 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -2,7 +2,7 @@ > 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 (IPC) between the renderer process (web page) and the main process. diff --git a/docs/api/screen.md b/docs/api/screen.md index e324bb9ae0..9704f88134 100644 --- a/docs/api/screen.md +++ b/docs/api/screen.md @@ -2,7 +2,7 @@ > 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` module is emitted. diff --git a/docs/api/session.md b/docs/api/session.md index 8940ba7815..2ea3807957 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -2,7 +2,7 @@ > 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. @@ -54,7 +54,7 @@ A `Session` object, the default session object of the app. > 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: diff --git a/docs/api/shell.md b/docs/api/shell.md index 411ef9cce5..ae30de76f8 100644 --- a/docs/api/shell.md +++ b/docs/api/shell.md @@ -2,7 +2,7 @@ > 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. diff --git a/docs/api/system-preferences.md b/docs/api/system-preferences.md index f7569e6d11..eae68a6835 100644 --- a/docs/api/system-preferences.md +++ b/docs/api/system-preferences.md @@ -2,7 +2,7 @@ > Get system preferences. -Process: [Main](../tutorial/quick-start.md#main-process) +Process: [Main](../glossary.md#main-process) ```javascript const {systemPreferences} = require('electron') diff --git a/docs/api/tray.md b/docs/api/tray.md index d98b31689f..0be9702986 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -2,7 +2,7 @@ > 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]. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 54bacfb1ff..4b74dfd0c9 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -2,7 +2,7 @@ > Render and control web pages. -Process: [Main](../tutorial/quick-start.md#main-process) +Process: [Main](../glossary.md#main-process) `webContents` is an [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. -Process: [Main](../tutorial/quick-start.md#main-process) +Process: [Main](../glossary.md#main-process) ### Instance Events diff --git a/docs/api/web-frame.md b/docs/api/web-frame.md index 16d53edd1a..a8a430c7c5 100644 --- a/docs/api/web-frame.md +++ b/docs/api/web-frame.md @@ -2,7 +2,7 @@ > 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%. diff --git a/docs/api/web-request.md b/docs/api/web-request.md index c8f3af8b4e..6da98d81f1 100644 --- a/docs/api/web-request.md +++ b/docs/api/web-request.md @@ -2,7 +2,7 @@ > 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` property of a `Session`.