JezerM
4 years ago
96 changed files with 2 additions and 9301 deletions
@ -1,20 +0,0 @@
|
||||
# Web Greeter for LightDM |
||||
|
||||
A modern, visually appealing greeter for LightDM, that allows to create web based themes with HTML, CSS and JavaScript. |
||||
|
||||
This is a try to update the [Antergos web-greeter](https://github.com/Antergos/web-greeter), following what they left. |
||||
|
||||
## Features |
||||
|
||||
- Create themes with HTML, CSS and JavaScript! |
||||
- Should work everywhere. |
||||
- JavaScript error handling, allowing to load the default theme. |
||||
- Themes could be simple, or very complex. |
||||
- Battery and brightness control. |
||||
|
||||
## Theme JavaScript API |
||||
See the [JavaScript API][jsAPI] here, and some [HOWTO][howto] here too! |
||||
|
||||
|
||||
[jsAPI]: ./api/LightDM.md |
||||
[howto]: ./howto |
||||
@ -1,18 +0,0 @@
|
||||
# Summary |
||||
|
||||
* [Introduction](README.md) |
||||
|
||||
## Javascript API |
||||
* [LightDM](api/LightDM.md) |
||||
* [Greeter](api/Greeter.md) |
||||
* [GreeterConfig](api/GreeterConfig.md) |
||||
* [ThemeUtils](api/ThemeUtils.md) |
||||
* [Battery](api/Battery.md) |
||||
* [Language](api/Language.md) |
||||
* [Layout](api/Layout.md) |
||||
* [Session](api/Session.md) |
||||
* [User](api/User.md) |
||||
* [Signal](api/Signal.md) |
||||
|
||||
## HOWTO |
||||
* [Introduction](howto/intro.md) |
||||
@ -1,23 +0,0 @@
|
||||
<a id="LightDM.Battery"></a> |
||||
|
||||
## LightDM.Battery |
||||
Interface for object that holds info about the battery on the system. This object is not created by the theme's code, but rather by the [`LightDM.Greeter`](Greeter.md) class. |
||||
|
||||
<a id="LightDM.Battery+level"></a> |
||||
|
||||
### battery.level : <code>String</code> \| <code>Null</code> |
||||
The battery level. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Battery+name"></a> |
||||
|
||||
### battery.name : <code>String</code> \| <code>Null</code> |
||||
The battery's name. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Battery+state"></a> |
||||
|
||||
### battery.state : <code>String</code> \| <code>Null</code> |
||||
The state for the battery |
||||
|
||||
**Read only**: true |
||||
@ -1,338 +0,0 @@
|
||||
<a id="LightDM.Greeter"></a> |
||||
|
||||
## LightDM.Greeter |
||||
Base class for the greeter's Theme JavaScript API. Greeter themes will interact |
||||
directly with an object derived from this class to facilitate the user log-in process. |
||||
The greeter will automatically create an instance when it starts. |
||||
The instance can be accessed using the global variable: `lightdm`. |
||||
|
||||
<a id="LightDM.Greeter+authentication_user"></a> |
||||
|
||||
### greeter.authentication\_user : <code>String</code> \| <code>Null</code> |
||||
The username of the user being authenticated or [null](null) |
||||
if no authentication is in progress |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+autologin_guest"></a> |
||||
|
||||
### greeter.autologin\_guest : <code>Boolean</code> |
||||
Whether or not the guest account should be automatically logged |
||||
into when the timer expires. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+autologin_timeout"></a> |
||||
|
||||
### greeter.autologin\_timeout : <code>Number</code> |
||||
The number of seconds to wait before automatically logging in. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+autologin_user"></a> |
||||
|
||||
### greeter.autologin\_user : <code>String</code> |
||||
The username with which to automattically log in when the timer expires. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+batteryData"></a> |
||||
|
||||
### greeter.batteryData : <code>Battery</code> |
||||
The battery data |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+brightness"></a> |
||||
|
||||
### greeter.brightness : <code>Number</code> |
||||
The display brightness |
||||
|
||||
<a id="LightDM.Greeter+can_access_battery"></a> |
||||
|
||||
### greeter.can\_access\_battery : <code>boolean</code> |
||||
Whether or not the greeter can access to battery data. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+can_access_brightness"></a> |
||||
|
||||
### greeter.can\_access\_brightness : <code>boolean</code> |
||||
Whether or not the greeter can control display brightness. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+can_hibernate"></a> |
||||
|
||||
### greeter.can\_hibernate : <code>Boolean</code> |
||||
Whether or not the greeter can make the system hibernate. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+can_restart"></a> |
||||
|
||||
### greeter.can\_restart : <code>Boolean</code> |
||||
Whether or not the greeter can make the system restart. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+can_shutdown"></a> |
||||
|
||||
### greeter.can\_shutdown : <code>Boolean</code> |
||||
Whether or not the greeter can make the system shutdown. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+can_suspend"></a> |
||||
|
||||
### greeter.can\_suspend : <code>Boolean</code> |
||||
Whether or not the greeter can make the system suspend/sleep. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+default_session"></a> |
||||
|
||||
### greeter.default\_session : <code>String</code> |
||||
The name of the default session. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+has_guest_account"></a> |
||||
|
||||
### greeter.has\_guest\_account : <code>Boolean</code> |
||||
Whether or not guest sessions are supported. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+hide_users_hint"></a> |
||||
|
||||
### greeter.hide\_users\_hint : <code>boolean</code> |
||||
Whether or not user accounts should be hidden. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+hostname"></a> |
||||
|
||||
### greeter.hostname : <code>String</code> |
||||
The system's hostname. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+in_authentication"></a> |
||||
|
||||
### greeter.in\_authentication : <code>Boolean</code> |
||||
Whether or not the greeter is in the process of authenticating. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+is_authenticated"></a> |
||||
|
||||
### greeter.is\_authenticated : <code>Boolean</code> |
||||
Whether or not the greeter has successfully authenticated. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+language"></a> |
||||
|
||||
### greeter.language : <code>Language</code> \| <code>null</code> |
||||
The current language or [null](null) if no language. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+languages"></a> |
||||
|
||||
### greeter.languages : <code>Array.<Language></code> |
||||
A list of languages to present to the user. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+layout"></a> |
||||
|
||||
### greeter.layout : <code>Layout</code> |
||||
The currently active layout for the selected user. |
||||
|
||||
<a id="LightDM.Greeter+layouts"></a> |
||||
|
||||
### greeter.layouts : <code>Array.<Layout></code> |
||||
A list of keyboard layouts to present to the user. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+lock_hint"></a> |
||||
|
||||
### greeter.lock\_hint : <code>Boolean</code> |
||||
Whether or not the greeter was started as a lock screen. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+select_guest_hint"></a> |
||||
|
||||
### greeter.select\_guest\_hint : <code>Boolean</code> |
||||
Whether or not the guest account should be selected by default. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+select_user_hint"></a> |
||||
|
||||
### greeter.select\_user\_hint : <code>String</code> |
||||
The username to select by default. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+sessions"></a> |
||||
|
||||
### greeter.sessions : <code>Array.<Session></code> |
||||
List of available sessions. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+show_manual_login_hint"></a> |
||||
|
||||
### greeter.show\_manual\_login\_hint : <code>Boolean</code> |
||||
Check if a manual login option should be shown. If [true](true), the theme should |
||||
provide a way for a username to be entered manually. Otherwise, themes that show |
||||
a user list may limit logins to only those users. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+show_remote_login_hint"></a> |
||||
|
||||
### greeter.show\_remote\_login\_hint : <code>Boolean</code> |
||||
Check if a remote login option should be shown. If [true](true), the theme should provide |
||||
a way for a user to log into a remote desktop server. |
||||
|
||||
**Read only**: true |
||||
**Internal**: |
||||
<a id="LightDM.Greeter+users"></a> |
||||
|
||||
### greeter.users : <code>Array.<User></code> |
||||
List of available users. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Greeter+authentication_complete"></a> |
||||
|
||||
### greeter.authentication\_complete : <code>Signal</code> |
||||
Gets emitted when the greeter has completed authentication. |
||||
|
||||
<a id="LightDM.Greeter+autologin_timer_expired"></a> |
||||
|
||||
### greeter.autologin\_timer\_expired : <code>Signal</code> |
||||
Gets emitted when the automatic login timer has expired. |
||||
|
||||
<a id="LightDM.Greeter+brightness_update"></a> |
||||
|
||||
### greeter.brightness\_update : <code>Signal</code> |
||||
Gets emitted when brightness is updated |
||||
|
||||
<a id="LightDM.Greeter+idle"></a> |
||||
|
||||
### greeter.idle : <code>Signal</code> |
||||
Gets emitted when the user has logged in and the greeter is no longer needed. |
||||
|
||||
<a id="LightDM.Greeter+reset"></a> |
||||
|
||||
### greeter.reset : <code>Signal</code> |
||||
Gets emitted when the user is returning to a greeter that |
||||
was previously marked idle. |
||||
|
||||
<a id="LightDM.Greeter+show_message"></a> |
||||
|
||||
### greeter.show\_message : <code>Signal</code> |
||||
Gets emitted when the greeter should show a message to the user. |
||||
|
||||
<a id="LightDM.Greeter+show_prompt"></a> |
||||
|
||||
### greeter.show\_prompt : <code>Signal</code> |
||||
Gets emitted when the greeter should show a prompt to the user. |
||||
|
||||
<a name="LightDM.Greeter+authenticate"></a> |
||||
|
||||
### greeter.authenticate(username) |
||||
Starts the authentication procedure for a user. |
||||
|
||||
|
||||
| Param | Type | Description | |
||||
| --- | --- | --- | |
||||
| username | <code>String</code> \| <code>null</code> | A username or [null](null) to prompt for a username. | |
||||
|
||||
<a id="LightDM.Greeter+authenticate_as_guest"></a> |
||||
|
||||
### greeter.authenticate\_as\_guest() |
||||
Starts the authentication procedure for the guest user. |
||||
|
||||
<a id="LightDM.Greeter+batteryUpdate"></a> |
||||
|
||||
### greeter.batteryUpdate() |
||||
Updates the battery data |
||||
|
||||
<a id="LightDM.Greeter+brightnessSet"></a> |
||||
|
||||
### greeter.brightnessSet(quantity) |
||||
Set the brightness to quantity |
||||
|
||||
|
||||
| Param | Type | Description | |
||||
| --- | --- | --- | |
||||
| quantity | <code>Number</code> | The quantity to set | |
||||
|
||||
<a id="LightDM.Greeter+brightnessIncrease"></a> |
||||
|
||||
### greeter.brightnessIncrease(quantity) |
||||
Increase the brightness by quantity |
||||
|
||||
|
||||
| Param | Type | Description | |
||||
| --- | --- | --- | |
||||
| quantity | <code>Number</code> | The quantity to increase | |
||||
|
||||
<a id="LightDM.Greeter+brightnessDecrease"></a> |
||||
|
||||
### greeter.brightnessDecrease(quantity) |
||||
Decrease the brightness by quantity |
||||
|
||||
|
||||
| Param | Type | Description | |
||||
| --- | --- | --- | |
||||
| quantity | <code>Number</code> | The quantity to decrease | |
||||
|
||||
<a id="LightDM.Greeter+cancel_authentication"></a> |
||||
|
||||
### greeter.cancel\_authentication() |
||||
Cancel user authentication that is currently in progress. |
||||
|
||||
<a id="LightDM.Greeter+cancel_autologin"></a> |
||||
|
||||
### greeter.cancel\_autologin() |
||||
Cancel the automatic login. |
||||
|
||||
<a id="LightDM.Greeter+hibernate"></a> |
||||
|
||||
### greeter.hibernate() ⇒ <code>Boolean</code> |
||||
Triggers the system to hibernate. |
||||
|
||||
**Returns**: <code>Boolean</code> - [true](true) if hibernation initiated, otherwise [false](false) |
||||
<a id="LightDM.Greeter+respond"></a> |
||||
|
||||
### greeter.respond(response) |
||||
Provide a response to a prompt. |
||||
|
||||
|
||||
| Param | Type | |
||||
| --- | --- | |
||||
| response | <code>\*</code> | |
||||
|
||||
<a id="LightDM.Greeter+restart"></a> |
||||
|
||||
### greeter.restart() ⇒ <code>Boolean</code> |
||||
Triggers the system to restart. |
||||
|
||||
**Returns**: <code>Boolean</code> - [true](true) if restart initiated, otherwise [false](false) |
||||
<a id="LightDM.Greeter+set_language"></a> |
||||
|
||||
### greeter.set\_language(language) ⇒ <code>Boolean</code> |
||||
Set the language for the currently authenticated user. |
||||
|
||||
**Returns**: <code>Boolean</code> - [true](true) if successful, otherwise [false](false) |
||||
|
||||
| Param | Type | Description | |
||||
| --- | --- | --- | |
||||
| language | <code>String</code> | The language in the form of a locale specification (e.g. 'de_DE.UTF-8') | |
||||
|
||||
<a id="LightDM.Greeter+shutdown"></a> |
||||
|
||||
### greeter.shutdown() ⇒ <code>Boolean</code> |
||||
Triggers the system to shutdown. |
||||
|
||||
**Returns**: <code>Boolean</code> - [true](true) if shutdown initiated, otherwise [false](false) |
||||
<a id="LightDM.Greeter+start_session"></a> |
||||
|
||||
### greeter.start\_session(session) ⇒ <code>Boolean</code> |
||||
Start a session for the authenticated user. |
||||
|
||||
**Returns**: <code>Boolean</code> - [true](true) if successful, otherwise [false](false) |
||||
|
||||
| Param | Type | Description | |
||||
| --- | --- | --- | |
||||
| session | <code>String</code> \| <code>null</code> | The session to log into or [null](null) to use the default. | |
||||
|
||||
<a id="LightDM.Greeter+suspend"></a> |
||||
|
||||
### greeter.suspend() ⇒ <code>Boolean</code> |
||||
Triggers the system to suspend/sleep. |
||||
|
||||
**Returns**: <code>Boolean</code> - [true](true) if suspend/sleep initiated, otherwise [false](false) |
||||
@ -1,55 +0,0 @@
|
||||
<a id="LightDM.GreeterConfig"></a> |
||||
|
||||
## LightDM.GreeterConfig |
||||
Provides greeter themes with a way to access values from the greeter's config |
||||
file located at `/etc/lightdm/web-greeter.yml`. The greeter will |
||||
create an instance of this class when it starts. The instance can be accessed |
||||
with the global variable: `greeter_config`. |
||||
|
||||
<a id="LightDM.GreeterConfig+branding"></a> |
||||
|
||||
### greeterConfig.branding : <code>object</code> |
||||
Holds keys/values from the `branding` section of the config file. |
||||
|
||||
**Read only**: true |
||||
**Properties** |
||||
|
||||
| Name | Type | Description | |
||||
| --- | --- | --- | |
||||
| background_images_dir | <code>string</code> | Path to directory that contains background images for use in greeter themes. | |
||||
| logo | <code>string</code> | Path to distro logo image for use in greeter themes. | |
||||
| user_image | <code>string</code> | Default user image/avatar. This is used by greeter themes for users that have not configured a `.face` image. | |
||||
|
||||
<a id="LightDM.GreeterConfig+greeter"></a> |
||||
|
||||
### greeterConfig.greeter : <code>object</code> |
||||
Holds keys/values from the `greeter` section of the config file. |
||||
|
||||
**Read only**: true |
||||
**Properties** |
||||
|
||||
| Name | Type | Description | |
||||
| --- | --- | --- | |
||||
| debug_mode | <code>boolean</code> | Greeter theme debug mode. | |
||||
| detect_theme_errors | <code>boolean</code> | Provide an option to load a fallback theme when theme errors are detected. | |
||||
| screensaver_timeout | <code>number</code> | Blank the screen after this many seconds of inactivity. | |
||||
| secure_mode | <code>boolean</code> | Don't allow themes to make remote http requests. | |
||||
| time_format | <code>string</code> | A moment.js format string to be used by the greeter to generate localized time for display. | |
||||
| time_language | <code>string</code> | Language to use when displaying the time or `auto` to use the system's language. | |
||||
| theme | <code>string</code> | The name of the theme to be used by the greeter. | |
||||
|
||||
<a id="LightDM.GreeterConfig+features"></a> |
||||
|
||||
### greeterConfig.features : <code>Object</code> |
||||
Holds keys/values from the `features` section of the config file. |
||||
|
||||
**Properties** |
||||
|
||||
| Name | Type | Description | |
||||
| --- | --- | --- | |
||||
| battery | <code>Boolean</code> | Enable greeter and themes to ger battery status. | |
||||
| backlight | <code>Object</code> | | |
||||
| backlight.enabled | <code>Boolean</code> | Enable greeter and themes to control display backlight. | |
||||
| backlight.value | <code>Number</code> | The amount to increase/decrease brightness by greeter. | |
||||
| backlight.steps | <code>Number</code> | How many steps are needed to do the change. | |
||||
|
||||
@ -1,24 +0,0 @@
|
||||
<a id="LightDM.Language"></a> |
||||
|
||||
## LightDM.Language |
||||
Interface for object that holds info about a language on the system. Language objects are not |
||||
created by the theme's code, but rather by the [`LightDM.Greeter`](Greeter.md) class. |
||||
|
||||
<a id="LightDM.Language+code"></a> |
||||
|
||||
### language.code : <code>String</code> |
||||
The code for the language. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Language+name"></a> |
||||
|
||||
### language.name : <code>String</code> |
||||
The name for the layout. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Language+territory"></a> |
||||
|
||||
### language.territory : <code>String</code> |
||||
The territory for the language. |
||||
|
||||
**Read only**: true |
||||
@ -1,24 +0,0 @@
|
||||
<a id="LightDM.Layout"></a> |
||||
|
||||
## LightDM.Layout |
||||
Interface for object that holds info about a keyboard layout on the system. Language |
||||
objects are not created by the theme's code, but rather by the [`LightDM.Greeter`](Greeter.md) class. |
||||
|
||||
<a id="LightDM.Layout+description"></a> |
||||
|
||||
### layout.description : <code>String</code> |
||||
The description for the layout. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Layout+name"></a> |
||||
|
||||
### layout.name : <code>String</code> |
||||
The name for the layout. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Layout+short_description"></a> |
||||
|
||||
### layout.short\_description : <code>String</code> |
||||
The territory for the layout. |
||||
|
||||
**Read only**: true |
||||
@ -1,6 +0,0 @@
|
||||
<a id="LightDM"></a> |
||||
|
||||
## LightDM : <code>object</code> |
||||
The greeter's Theme JavaScript API. |
||||
Accesible through `lightdm` global variable. |
||||
|
||||
@ -1,24 +0,0 @@
|
||||
<a id="LightDM.Session"></a> |
||||
|
||||
## LightDM.Session |
||||
Interface for object that holds info about a session. Session objects are not |
||||
created by the theme's code, but rather by the [`LightDM.Greeter`](Greeter.md) class. |
||||
|
||||
<a id="LightDM.Session+name"></a> |
||||
|
||||
### session.name : <code>String</code> |
||||
The name for the session. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Session+key"></a> |
||||
|
||||
### session.key : <code>String</code> |
||||
The key for the session. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.Session+comment"></a> |
||||
|
||||
### session.comment : <code>String</code> |
||||
The comment for the session. |
||||
|
||||
**Read only**: true |
||||
@ -1,26 +0,0 @@
|
||||
<a id="LightDM.Signal"></a> |
||||
|
||||
## LightDM.Signal |
||||
Interface for signals connected to LightDM itself. This is not created by the theme's code, but rather by Web Greeter. |
||||
When Web Greeter triggers the signal, all calbacks are executed. |
||||
|
||||
<a id="LightDM.Signal+connect"></a> |
||||
|
||||
### signal.connect(callback) |
||||
Connects a callback to the signal. |
||||
|
||||
|
||||
| Param | Type | Description | |
||||
| --- | --- | --- | |
||||
| callback | <code>function</code> | The callback to attach. | |
||||
|
||||
<a id="LightDM.Signal+disconnect"></a> |
||||
|
||||
### signal.disconnect(callback) |
||||
Disconnects a callback to the signal. |
||||
|
||||
|
||||
| Param | Type | Description | |
||||
| --- | --- | --- | |
||||
| callback | <code>function</code> | The callback to disattach. | |
||||
|
||||
@ -1,47 +0,0 @@
|
||||
<a id="LightDM.ThemeUtils"></a> |
||||
|
||||
## LightDM.ThemeUtils |
||||
Provides various utility methods for use in greeter themes. The greeter will automatically |
||||
create an instance of this class when it starts. The instance can be accessed |
||||
with the global variable: `theme_utils`. |
||||
|
||||
<a id="LightDM.ThemeUtils+bind_this"></a> |
||||
|
||||
### themeUtils.bind\_this(context) ⇒ <code>Object</code> |
||||
Binds `this` to class, `context`, for all of the class's methods. |
||||
|
||||
**Returns**: <code>Object</code> - `context` with `this` bound to it for all of its methods. |
||||
|
||||
| Param | Type | Description | |
||||
| --- | --- | --- | |
||||
| context | <code>Object</code> | An ES6 class instance with at least one method. | |
||||
|
||||
<a id="LightDM.ThemeUtils+dirlist"></a> |
||||
|
||||
### themeUtils.dirlist(path, only_images, callback) |
||||
Returns the contents of directory found at `path` provided that the (normalized) `path` |
||||
meets at least one of the following conditions: |
||||
* Is located within the greeter themes' root directory. |
||||
* Has been explicitly allowed in the greeter's config file. |
||||
* Is located within the greeter's shared data directory (`/var/lib/lightdm-data`). |
||||
* Is located in `/tmp`. |
||||
|
||||
|
||||
| Param | Type | Default | Description | |
||||
| --- | --- | --- | --- | |
||||
| path | <code>String</code> | | The abs path to desired directory. | |
||||
| only_images | <code>Boolean</code> | <code>true</code> | Include only images in the results. Default `true`. | |
||||
| callback | <code>function</code> | | Callback function to be called with the result. | |
||||
|
||||
<a id="LightDM.ThemeUtils+get_current_localized_time"></a> |
||||
|
||||
### themeUtils.get\_current\_localized\_time() ⇒ <code>String</code> |
||||
Get the current time in a localized format. Time format and language are auto-detected |
||||
by default, but can be set manually in the greeter config file. |
||||
* `language` defaults to the system's language, but can be set manually in the config file. |
||||
* When `time_format` config file option has a valid value, time will be formatted |
||||
according to that value. |
||||
* When `time_format` does not have a valid value, the time format will be `LT` |
||||
which is `1:00 PM` or `13:00` depending on the system's locale. |
||||
|
||||
**Returns**: <code>String</code> - The current localized time. |
||||
@ -1,54 +0,0 @@
|
||||
<a id="LightDM.User"></a> |
||||
|
||||
## LightDM.User |
||||
Interface for object that holds info about a user account on the system. User |
||||
objects are not created by the theme's code, but rather by the [`LightDM.Greeter`](Greeter.md) class. |
||||
|
||||
<a id="LightDM.User+display_name"></a> |
||||
|
||||
### user.display\_name : <code>String</code> |
||||
The display name for the user. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.User+language"></a> |
||||
|
||||
### user.language : <code>String</code> |
||||
The language for the user. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.User+layout"></a> |
||||
|
||||
### user.layout : <code>String</code> |
||||
The keyboard layout for the user. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.User+image"></a> |
||||
|
||||
### user.image : <code>String</code> |
||||
The image for the user. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.User+home_directory"></a> |
||||
|
||||
### user.home\_directory : <code>String</code> |
||||
The home_directory for the user. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.User+username"></a> |
||||
|
||||
### user.username : <code>String</code> |
||||
The username for the user. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.User+logged_in"></a> |
||||
|
||||
### user.logged\_in : <code>Boolean</code> |
||||
Whether or not the user is currently logged in. |
||||
|
||||
**Read only**: true |
||||
<a id="LightDM.User+session"></a> |
||||
|
||||
### user.session : <code>String</code> \| <code>Null</code> |
||||
The last session that the user logged into. |
||||
|
||||
**Read only**: true |
||||
@ -1,51 +0,0 @@
|
||||
# Introduction |
||||
|
||||
Web Greeter has a simple API, documented here, which allows to communicate to the Web Greeter itself and the LightDM API. |
||||
|
||||
To create a theme, you will need these essential functions: |
||||
|
||||
```javascript |
||||
lightdm.authenticate(username) |
||||
|
||||
lightdm.respond(response) |
||||
|
||||
lightdm.start_session(session) |
||||
``` |
||||
|
||||
### [lightdm.authenticate(username)](/api/Greeter.md#LightDM.Greeter+authenticate) |
||||
This method starts the authentication procedure for a user, allowing to start the user session. |
||||
|
||||
### lightdm.respond(response) |
||||
Provide a response to a prompt. Basically, this acts like a password provider. After the authentication is initiated, you need to provide the user password with this method. It could be "12345", "password", "strongpassword", y'know, a password. |
||||
|
||||
> NOTE: If authentication is not initiated, this will cause an error. |
||||
|
||||
### lightdm.start_session(session) |
||||
Starts a session for the authenticated user. After the user is authenticated, you will need to start the session with this method. |
||||
|
||||
> NOTE: If user is not authenticated, this won't work. |
||||
|
||||
And that's it. You can create a simple javascript file with this: |
||||
```javascript |
||||
lightdm.authenticate("superuser") |
||||
lightdm.respond("superpassword") |
||||
lightdm.start_session("ubuntu") |
||||
``` |
||||
|
||||
Although, if this could really work, it won't at first. The `lightdm` object is not available when the greeter is initiated, it is after a little delay. To make this work, an event is triggered when the API is ready to be used. Add an event listener to the `GreeterReady` event. |
||||
|
||||
```javascript |
||||
window.addEventListener("GreeterReady", initGreeter) |
||||
``` |
||||
|
||||
And so, it will look like this: |
||||
|
||||
```javascript |
||||
function initGreeter() { |
||||
lightdm.authenticate("superuser") |
||||
lightdm.respond("superpassword") |
||||
lightdm.start_session("ubuntu") |
||||
} |
||||
|
||||
window.addEventListener("GreeterReady", initGreeter) |
||||
``` |
||||
@ -1,43 +0,0 @@
|
||||
'use strict' |
||||
const jsdoc2md = require("jsdoc-to-markdown") |
||||
const fs = require('fs') |
||||
const path = require('path') |
||||
|
||||
const outputDir = "./docs/api/" |
||||
|
||||
function generateFiles(file) { |
||||
const templateData = jsdoc2md.getTemplateDataSync({ |
||||
files: file, |
||||
//configure: "./jsdoc.json"
|
||||
}) |
||||
|
||||
let selectedData = templateData.reduce( (selectedData, identifier) => { |
||||
if (identifier.kind == 'class' || identifier.kind == 'namespace') { |
||||
selectedData.push(identifier) |
||||
} |
||||
return selectedData |
||||
}, []) |
||||
|
||||
for (const identifier of selectedData) { |
||||
let template = "" |
||||
let name = identifier.name |
||||
if (identifier.kind == 'class') { |
||||
template = `{{#class name="${name}"}}{{>docs}}{{/class}}` |
||||
} else { |
||||
template = `{{#namespace name="${name}"}}{{>header~}}{{>body}}{{/namespace}}` |
||||
} |
||||
console.log(`rendering ${name}, template: ${template}`) |
||||
|
||||
const output = jsdoc2md.renderSync({ |
||||
data: templateData, |
||||
template: template, |
||||
partial: ["templates/partials/**/*.hbs"], |
||||
"global-index-format": "none", |
||||
"module-index-format": "none" |
||||
}) |
||||
|
||||
fs.writeFileSync(path.resolve(outputDir, `${name}.md`), output) |
||||
} |
||||
} |
||||
|
||||
generateFiles(["src/*.js"]) |
||||
@ -1,17 +0,0 @@
|
||||
{ |
||||
"plugins": [], |
||||
"recurseDepth": 10, |
||||
"source": { |
||||
"include": ["test"], |
||||
"includePattern": ".+\\.js(doc|x)?$", |
||||
"excludePattern": "(node_modules)" |
||||
}, |
||||
"templates": { |
||||
"cleverLinks": false, |
||||
"monospaceLinks": false |
||||
}, |
||||
"opts": { |
||||
"recurse": "true", |
||||
"destination": "./docs/" |
||||
} |
||||
} |
||||
@ -1,19 +0,0 @@
|
||||
Interface for object that holds info about battery. Battery object is not created by the theme's code, but rather by the **LightDM.Greeter** class. |
||||
|
||||
# Members |
||||
|
||||
## level |
||||
**Type**: [String] |
||||
|
||||
The battery level. |
||||
|
||||
## name |
||||
**Type**: [String] |
||||
|
||||
The battery's name. |
||||
|
||||
## state |
||||
**Type**: [String] |
||||
|
||||
The state for the battery. |
||||
|
||||
@ -1,297 +0,0 @@
|
||||
Base class for the greeter's Theme JavaScript API. Greeter themes will interact directly with an object derived from this class to facilitate the user log-in process. The greeter will automatically create an instance when it starts. The instance can be accessed using the global variable: `lightdm` |
||||
|
||||
# Methods |
||||
|
||||
## authenticate(username) |
||||
Starts the authentication with the given `username`. |
||||
**Arguments**: |
||||
- `username` [String] |
||||
|
||||
## authenticate_as_guest() |
||||
Authenticates as the guest user. |
||||
|
||||
## batteryUpdate() |
||||
Updates the battery data. |
||||
|
||||
## brightnessSet(quantity) |
||||
Set the brightness to `quantity`. |
||||
|
||||
## brightnessIncrease(quantity) |
||||
Increase the brightness by `quantity` |
||||
|
||||
## brightnessDecrease(quantity) |
||||
Decrease the brightness by `quantity` |
||||
|
||||
## cancel_authentication() |
||||
Cancel the user authentication that is currently in progress. |
||||
|
||||
## cancel_autologin() |
||||
Cancels the automatic login. |
||||
|
||||
## hibernate() |
||||
Triggers the system to hibernate. |
||||
|
||||
**Returns**: |
||||
- [Boolean] |
||||
`true` if hibernation initiated, otherwise `false` |
||||
|
||||
## respond(response) |
||||
Provide a response to a greeter |
||||
|
||||
**Arguments**: |
||||
- `response` [String] |
||||
|
||||
## restart() |
||||
Triggers the system to restart. |
||||
|
||||
**Returns**: |
||||
- [Boolean] |
||||
`true` if restart initiated, otherwise `false` |
||||
|
||||
## set_language(language) |
||||
Set the language for the currently authenticated user. |
||||
|
||||
**Arguments**: |
||||
- language [String] |
||||
The language specification (e.g 'de\_DE.UTF-8') |
||||
|
||||
**Returns**: |
||||
- Boolean |
||||
`true` if successful, otherwise `false` |
||||
|
||||
## shutdown() |
||||
Triggers the system to shutdown. |
||||
|
||||
**Returns**: |
||||
- Boolean |
||||
`true` if successful, otherwise `false` |
||||
|
||||
## start_session(session) |
||||
Starts a session for the authenticated user. |
||||
|
||||
**Arguments**: |
||||
- `session` [String | Null] |
||||
The session to log into or null to use the default |
||||
|
||||
**Returns**: |
||||
- Boolean |
||||
`true` if successful, otherwise `false` |
||||
|
||||
## suspend() |
||||
Triggers the system to suspend/sleep. |
||||
|
||||
**Returns** |
||||
- [Boolean] |
||||
`true` if suspend/sleep initiated, otherwise `false` |
||||
|
||||
# Members |
||||
|
||||
## authentication_user |
||||
**Type**: [String | Null] |
||||
**Readonly** |
||||
|
||||
The username of the user being authenticated or null if there is no authentication in progress. |
||||
|
||||
## autologin_guest |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the guest account should be automatically logged into when the timer expires. |
||||
|
||||
## autologin_timeout |
||||
**Type**: [Number] |
||||
**Readonly** |
||||
|
||||
The number of seconds to wait before automatically loggin in. |
||||
|
||||
## autologin_user |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
The username with which to automatically log in when the timer expires. |
||||
|
||||
## batteryData |
||||
**Type**: [LightDM.Battery] |
||||
**Readonly** |
||||
|
||||
The battery data. |
||||
|
||||
## brightness |
||||
**Type**: [Number] |
||||
|
||||
The display brightness. |
||||
|
||||
## can_access_battery |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Wheter or not the greeter can access to battery data. |
||||
|
||||
## can_access_brightness |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the greeter can control display brightness. |
||||
|
||||
## can_hibernate |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the greeter can make the system hibernate. |
||||
|
||||
## can_restart |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the greeter can make the system restart. |
||||
|
||||
## can_shutdown |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the greeter can make the system shutdown. |
||||
|
||||
## can_suspend |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the greeter can make the system suspend/sleep. |
||||
|
||||
## default_session |
||||
**Type**: [String] |
||||
**Readonly** |
||||
|
||||
The name of the default session |
||||
|
||||
## has_guest_account |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not guest sessions are supported |
||||
|
||||
## hide_users_hint |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not user accounts should be hidden |
||||
|
||||
## hostname |
||||
**Type**: [String] |
||||
**Readonly** |
||||
|
||||
The system's hostname |
||||
|
||||
## in_authentication |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the greeter is in the process of authenticating. |
||||
|
||||
## is_authenticated |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the greeter has succesfully authenticated. |
||||
|
||||
## language |
||||
**Type**: [LightDM.Language | Null] |
||||
**Readonly** |
||||
|
||||
The current language or `null` if no language. |
||||
|
||||
## languages |
||||
**Type**: [Array<LightDM.Language>] |
||||
**Readonly** |
||||
|
||||
A list of languages to present to the user. |
||||
|
||||
## layout |
||||
**Type**: [LightDM.Layout] |
||||
**Readonly** |
||||
|
||||
The currently active layout for the selected user. |
||||
|
||||
## layouts |
||||
**Type**: [Array<LightDM.Layout>] |
||||
**Readonly** |
||||
|
||||
A list of keyboard layouts to present to the user. |
||||
|
||||
## lock_hint |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the greeter was started as a lock screen. |
||||
|
||||
## select_guest_hint |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Whether or not the guest account should be selected by default |
||||
|
||||
## select_user_hint |
||||
**Type**: [String] |
||||
**Readonly** |
||||
|
||||
The username to select by default. |
||||
|
||||
## sessions |
||||
**Type**: [String] |
||||
**Readonly** |
||||
|
||||
List of available sessions. |
||||
|
||||
## show_manual_login_hint |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Check if manual login should be shown. If `true`, the theme should provide a way for username to be entered manually. Otherwise, themes that show a user list may limit logins to only those users. |
||||
|
||||
## show_remote_login_hint |
||||
**Type**: [Boolean] |
||||
**Readonly** |
||||
|
||||
Check if a remote login option should be shown. If `true`, the theme should provide a way for a user to log into a remote desktop server. |
||||
|
||||
## users |
||||
**Type**: [Array<LightDM.User>] |
||||
**Readonly** |
||||
|
||||
List of available users. |
||||
|
||||
# Signals |
||||
|
||||
## authentication_complete |
||||
**Type**: [Signal] |
||||
|
||||
Gets emitted when the greeter has completed authentication. |
||||
|
||||
## autologin_timer_expired |
||||
**Type**: [Signal] |
||||
|
||||
Gets emitted when the automatic login timer has expired. |
||||
|
||||
## brightness_update |
||||
**Type**: [Signal] |
||||
|
||||
Gets emitted when brightness is updated. |
||||
|
||||
## idle |
||||
**Type**: [Signal] |
||||
|
||||
Gets emitted when the user has logged in and the greeter is no longer needed. |
||||
|
||||
## reset |
||||
**Type**: [Signal] |
||||
|
||||
Gets emitted when the user is returning to a greeter that was previously marked idle. |
||||
|
||||
## show_message |
||||
**Type**: [Signal] |
||||
|
||||
Get emitted when the greeter should show a message to the user. |
||||
|
||||
## show_prompt |
||||
**Type**: [Signal] |
||||
|
||||
Gets emitted when the greeter should show a prompt to the user. |
||||
@ -1,53 +0,0 @@
|
||||
Provides greeter themes with a way to access values from the greeter's config file located at **/etc/lightdm/web-greeter.yml**. The greeter will create an instance of this class when it starts. The instance can be accessed with the global variable: `greeter_config` |
||||
|
||||
# Members |
||||
|
||||
## branding |
||||
**Type**: [Object] |
||||
|
||||
Holds keys&values from the **branding** section of the config file. |
||||
|
||||
**Properties**: |
||||
- **background_images_dir** |
||||
Path to directory that contains background images for use in greeter themes. |
||||
- **logo_image** |
||||
Path to distro logo image for use in greeter themes |
||||
- **user_image** |
||||
Default user image/avatar. |
||||
|
||||
## greeter |
||||
**Type**: [Object] |
||||
|
||||
Holds keys/values from the **greeter** section of the config file. |
||||
|
||||
**Properties**: |
||||
- **debug_mode** |
||||
Greeter theme debug mode. |
||||
- **detect_theme_errors** |
||||
Provide an option to load default theme when theme errors are detected. |
||||
- **screensaver_timeout** |
||||
Blank the screen after this seconds of inactivity. |
||||
- **secure_mode** |
||||
Don't allow themes to make http requests. |
||||
- **time_format** |
||||
A moment.js format string to be used by the greeter to generate localized time for display. |
||||
- **time_language** |
||||
Language to use when displaying the time, or **auto** to use the system's language. |
||||
- **theme** |
||||
The name of the theme to be used by the greeter. |
||||
|
||||
## features |
||||
**Type**: [Object] |
||||
|
||||
Holds keys/values from the **features** section of the config file. |
||||
|
||||
**Properties**: |
||||
- **battery** |
||||
Enable greeter and themes to get battery status. |
||||
- **backlight** |
||||
- **enabled** |
||||
Enable greeter and themes to control display backlight. |
||||
- **value** |
||||
The amount to increase/decrease brightness by greeter. |
||||
- **steps** |
||||
How many steps are needed to do the change. **0** for instant change |
||||
@ -1,18 +0,0 @@
|
||||
Interface for object that holds info about a language on the system. Language objects are not created by the theme's code, but rather by the **LightDM.Greeter** class. |
||||
|
||||
# Members |
||||
|
||||
## code |
||||
**Type**: [String] |
||||
|
||||
The code for the language. |
||||
|
||||
## name |
||||
**Type**: [String] |
||||
|
||||
The name for the layout. |
||||
|
||||
## territory |
||||
**Type**: [String] |
||||
|
||||
The territory for the language. |
||||
@ -1,18 +0,0 @@
|
||||
Interface for object that holds info about a keyboard layout on the system. Language objects are not created by the theme's code, but rather by the **LightDM.Greeter** class. |
||||
|
||||
# Members |
||||
|
||||
## description |
||||
**Type**: [String] |
||||
|
||||
The description for the layout. |
||||
|
||||
## name |
||||
**Type**: [String] |
||||
|
||||
The name for the layout. |
||||
|
||||
## short_description |
||||
**Type**: [String] |
||||
|
||||
The territory for the layout. |
||||
@ -1,23 +0,0 @@
|
||||
Interface for object that holds info about a session. Session objects are not created by the theme's code, but rather by the **LightDM.Greeter** class. |
||||
|
||||
# Members |
||||
|
||||
## comment |
||||
**Type**: [String] |
||||
|
||||
The comment for the session. |
||||
|
||||
## key |
||||
**Type**: [String] |
||||
|
||||
The key for the session. |
||||
|
||||
## name |
||||
**Type**: [String] |
||||
|
||||
The name for the session. |
||||
|
||||
## Type |
||||
**Type**: [String] |
||||
|
||||
The type for the sesion. |
||||
@ -1,39 +0,0 @@
|
||||
Provides various utility methods for use in greeter themes. The greeter will automatically create an instance of this class when it starts. The instance can be accessed with the global variable: `theme_utils` |
||||
|
||||
# Methods |
||||
|
||||
## bind_this(context) |
||||
Bind **this** to class, **context**, for all of the class's methods. |
||||
|
||||
**Arguments**: |
||||
- `context` [Object] |
||||
An ES6 class instance with at least one method. |
||||
|
||||
**Returns**: |
||||
- Object |
||||
**context** with **this** bound to it for all of its methods. |
||||
|
||||
## dirlist(path) |
||||
Returns the contents of a directory found at **path**, only if the **path** meets at least one of the following conditions: |
||||
- Is located whithin the greeter theme's root directory. |
||||
- Has been explicitly allowed in the greeter's config file. |
||||
- Is located within the greeter's shared data directory (**/var/lib/lightdm-data/**) |
||||
- Is located in **/tmp**. |
||||
|
||||
**Arguments**: |
||||
- `path` [String] |
||||
The abs path to desired directory. |
||||
|
||||
**Returns**: |
||||
- Array<String> |
||||
List of abs paths for the files and directories found in **path** |
||||
|
||||
## get_current_localized_time() |
||||
Get the current time in a localized format. Time format and language are auto-detected by default, but can be set manually in the greeter config file. |
||||
- **language** defaults to the system's language, but can be set manually in the config gile. |
||||
- When **time_format** config file option has a valid value, time will be formatted according to that value. |
||||
- When **time_format** does not have a valid value, the time format will be **LT** which is **1:00 PM** or **13:00** depending on the system's locale. |
||||
|
||||
**Returns**: |
||||
- String |
||||
The current localized time. |
||||
@ -1,43 +0,0 @@
|
||||
Interface for object that holds info about a user account on the system. User objects are not created by the theme's code, but rather by the **LightDM.Greeter** class. |
||||
|
||||
# Members |
||||
|
||||
## display_name |
||||
**Type**: [String] |
||||
|
||||
The display name for the user. |
||||
|
||||
## home_directory |
||||
**Type**: [String] |
||||
|
||||
The home directory for the user. |
||||
|
||||
## image |
||||
**Type**: [String] |
||||
|
||||
The image for the user. |
||||
|
||||
## language |
||||
**Type**: [String] |
||||
|
||||
The language for the user. |
||||
|
||||
## layout |
||||
**Type**: [String] |
||||
|
||||
The keyboard layout for the user. |
||||
|
||||
## logged_in |
||||
**Type**: [Boolean] |
||||
|
||||
Whether or not the user is currently logged in. |
||||
|
||||
## session |
||||
**Type**: [String] |
||||
|
||||
The last session that the user logged into. |
||||
|
||||
## username |
||||
**Type**: [String] |
||||
|
||||
The username for the user. |
||||
File diff suppressed because it is too large
Load Diff
@ -1,22 +0,0 @@
|
||||
{ |
||||
"name": "docs", |
||||
"version": "1.0.0", |
||||
"description": "", |
||||
"main": "index.js", |
||||
"directories": { |
||||
"src": "src" |
||||
}, |
||||
"scripts": { |
||||
"docs": "node index.js", |
||||
"clean": "rm docs/api/* -f", |
||||
"build": "honkit build", |
||||
"serve": "honkit serve" |
||||
}, |
||||
"keywords": [], |
||||
"author": "", |
||||
"license": "ISC", |
||||
"devDependencies": { |
||||
"honkit": "^3.6.20", |
||||
"jsdoc-to-markdown": "^7.0.1" |
||||
} |
||||
} |
||||
@ -1,3 +0,0 @@
|
||||
{{#orphans ~}} |
||||
{{>docs~}} |
||||
{{/orphans~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if access}}**Access**: {{{access}}} |
||||
{{/if~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if augments}}**Extends**: {{>linked-type-list types=augments delimiter=", " }} |
||||
{{/if}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if author}}{{#each author}}**Author**: {{{inlineLinks this}}} |
||||
{{/each}}{{/if~}} |
||||
@ -1,29 +0,0 @@
|
||||
{{>deprecated~}} |
||||
{{>description~}} |
||||
{{!-- {{>scope~}} --}} |
||||
{{>summary~}} |
||||
{{>augments~}} |
||||
{{>implements~}} |
||||
{{>mixes~}} |
||||
{{>default~}} |
||||
{{>chainable~}} |
||||
{{>overrides~}} |
||||
{{>returns~}} |
||||
{{>category~}} |
||||
{{>throws~}} |
||||
{{>fires~}} |
||||
{{>this~}} |
||||
{{>access~}} |
||||
{{>readOnly~}} |
||||
{{>requires~}} |
||||
{{>customTags~}} |
||||
{{>see~}} |
||||
{{>since~}} |
||||
{{>version~}} |
||||
{{>authors~}} |
||||
{{>license~}} |
||||
{{>copyright~}} |
||||
{{>todo~}} |
||||
{{>params~}} |
||||
{{>properties~}} |
||||
{{>examples~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if category}}**Category**: {{inlineLinks category}} |
||||
{{/if~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if chainable}}**Chainable** |
||||
{{/if~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if copyright}}**Copyright**: {{{inlineLinks copyright}}} |
||||
{{/if~}} |
||||
@ -1,3 +0,0 @@
|
||||
{{#if customTags}}{{#each customTags}}**{{titleCase tag}}**: {{#with (parseType value)~}} |
||||
{{#if type}}{{>link to=type}}{{/if}}{{#if description}}{{{inlineLinks description}}}{{/if}}{{/with}} |
||||
{{/each}}{{/if~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#unless (equal defaultvalue undefined)}}**Default**: {{>defaultvalue}} |
||||
{{/unless}} |
||||
@ -1,3 +0,0 @@
|
||||
{{#if deprecated}}***Deprecated*** |
||||
|
||||
{{/if~}} |
||||
@ -1,3 +0,0 @@
|
||||
{{#if description}}{{{inlineLinks description}}} |
||||
|
||||
{{/if}} |
||||
@ -1,4 +0,0 @@
|
||||
{{#examples}} |
||||
**Example**{{#if caption}} *({{caption}})* {{else}} {{/if}} |
||||
{{{inlineLinks example}}} |
||||
{{/examples}} |
||||
@ -1,3 +0,0 @@
|
||||
{{#if fires~}} |
||||
**Emits**: {{>linked-type-list types=fires delimiter=", " }} |
||||
{{/if}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if implements}}**Implements**: {{>linked-type-list types=implements delimiter=", " }} |
||||
{{/if}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if license}}**License**: {{inlineLinks license}} |
||||
{{/if~}} |
||||
@ -1,3 +0,0 @@
|
||||
{{#if mixes~}} |
||||
**Mixes**: {{>linked-type-list types=mixes delimiter=", " }} |
||||
{{/if}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if overrides}}**Overrides**: {{>link to=overrides}} |
||||
{{/if~}} |
||||
@ -1,4 +0,0 @@
|
||||
{{#if optional}}[{{/if~}} |
||||
{{#if variable}}...{{/if~}} |
||||
{{{name}~}} |
||||
{{#if optional}}]{{/if}} |
||||
@ -1,9 +0,0 @@
|
||||
{{#if params}} |
||||
{{#params}}**Params** |
||||
|
||||
{{#each this~}} |
||||
{{indent}}- {{name}}{{#if type}} {{>linked-type-list types=type.names delimiter=" | " }}{{/if}}{{#unless (equal defaultvalue undefined)}} {{>defaultvalue equals=true ~}}{{/unless}}{{#if description}} - {{{inlineLinks description}}}{{/if}} |
||||
{{/each}} |
||||
|
||||
{{/params~}} |
||||
{{/if}} |
||||
@ -1,20 +0,0 @@
|
||||
{{#if params}} |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
{{#each (tableHeadHtml params "name|Param" "type|Type" "defaultvalue|Default" "description|Description")}}<th>{{this}}</th>{{/each}} |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
{{#tableRow params "name" "type" "defaultvalue" "description" ~}} |
||||
<tr> |
||||
{{#if @col1}}<td>{{>param-table-name}}</td>{{/if~}} |
||||
{{#if @col2}}<td>{{>linked-type-list types=type.names delimiter=" | " html=true}}</td>{{/if~}} |
||||
{{#if @col3}}<td>{{>defaultvalue}}</td>{{/if~}} |
||||
{{#if @col4}}<td>{{{md (inlineLinks description)}}}</td>{{/if}} |
||||
</tr> |
||||
{{~/tableRow}} |
||||
</tbody> |
||||
</table> |
||||
|
||||
{{/if}} |
||||
@ -1,12 +0,0 @@
|
||||
{{#if params}} |
||||
|
||||
{{tableHead params "name|Param" "type|Type" "defaultvalue|Default" "description|Description" ~}} |
||||
|
||||
{{#tableRow params "name" "type" "defaultvalue" "description" ~}} |
||||
| {{#if @col1}}{{>param-table-name}} | {{/if~}} |
||||
{{#if @col2}}{{>linked-type-list types=type.names delimiter=" \| " }} | {{/if~}} |
||||
{{#if @col3}}{{>defaultvalue}} | {{/if~}} |
||||
{{#if @col4}}{{{stripNewlines (inlineLinks description)}}} |{{/if}} |
||||
{{/tableRow}} |
||||
|
||||
{{/if}} |
||||
@ -1,4 +0,0 @@
|
||||
{{#if (optionEquals "param-list-format" "list")}}{{>params-list~}}{{/if~}} |
||||
{{#if (optionEquals "param-list-format" "table")~}} |
||||
{{#if (optionEquals "no-gfm" true)}}{{>params-table-html~}}{{else}}{{>params-table~}}{{/if~}} |
||||
{{/if~}} |
||||
@ -1,7 +0,0 @@
|
||||
{{#if properties}}**Properties** |
||||
|
||||
{{#each properties~}} |
||||
{{#if (regexp-test name "\w+\.\w+")}} {{/if}}- {{{name}}} {{>linked-type-list types=type.names delimiter=" \| " ~}}{{#if description}} - {{{inlineLinks description}}}{{/if}} |
||||
{{/each}} |
||||
|
||||
{{/if~}} |
||||
@ -1,21 +0,0 @@
|
||||
{{#if properties~}}**Properties** |
||||
|
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
{{#each (tableHeadHtml properties "name|Name" "type|Type" "defaultvalue|Default" "description|Description")}}<th>{{this}}</th>{{/each}} |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
{{#tableRow properties "name" "type" "defaultvalue" "description" ~}} |
||||
<tr> |
||||
{{#if @col1}}<td>{{>param-table-name}}</td>{{/if~}} |
||||
{{#if @col2}}<td>{{>linked-type-list types=type.names delimiter=" | " html=true}}</td>{{/if~}} |
||||
{{#if @col3}}<td>{{>defaultvalue}}</td>{{/if~}} |
||||
{{#if @col4}}<td>{{{md (inlineLinks description)}}}</td>{{/if}} |
||||
</tr> |
||||
{{~/tableRow}} |
||||
</tbody> |
||||
</table> |
||||
|
||||
{{/if}} |
||||
@ -1,12 +0,0 @@
|
||||
{{#if properties}}**Properties** |
||||
|
||||
{{tableHead properties "name|Name" "type|Type" "defaultvalue|Default" "description|Description" ~}} |
||||
|
||||
{{#tableRow properties "name" "type" "defaultvalue" "description" ~}} |
||||
| {{#if @col1}}{{>param-table-name}} | {{/if~}} |
||||
{{#if @col2}}{{>linked-type-list types=type.names delimiter=" \| " }} | {{/if~}} |
||||
{{#if @col3}}{{>defaultvalue}} | {{/if~}} |
||||
{{#if @col4}}{{{stripNewlines (inlineLinks description)}}} |{{/if}} |
||||
{{/tableRow}} |
||||
|
||||
{{/if}} |
||||
@ -1,4 +0,0 @@
|
||||
{{#if (optionEquals "property-list-format" "list")}}{{>properties-list~}}{{/if~}} |
||||
{{#if (optionEquals "property-list-format" "table")~}} |
||||
{{#if (optionEquals "no-gfm" true)}}{{>properties-table-html}}{{else}}{{>properties-table}}{{/if~}} |
||||
{{/if~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if readonly}}**Read only**: true |
||||
{{/if~}} |
||||
@ -1,3 +0,0 @@
|
||||
{{#if requires~}} |
||||
**Requires**: {{>linked-type-list types=requires delimiter=", " }} |
||||
{{/if}} |
||||
@ -1,12 +0,0 @@
|
||||
{{#if returns}} |
||||
{{#if returns.[0].description~}} |
||||
**Returns**: {{#each returns~}} |
||||
{{#if type~}} |
||||
{{#if type.names}}{{>linked-type-list types=type.names delimiter=" \| " ~}}{{/if}} |
||||
{{~#if description}} - {{{inlineLinks description}}}{{/if~}} |
||||
{{else~}} |
||||
{{{inlineLinks description}~}} |
||||
{{/if~}} |
||||
{{~/each}} |
||||
|
||||
{{/if}}{{/if}} |
||||
@ -1,10 +0,0 @@
|
||||
{{#if scope}} |
||||
**Kind**: {{#if (equal kind "event") ~}} |
||||
event emitted{{#if memberof}} by {{>link to=memberof}}{{/if}} |
||||
{{else~}} |
||||
{{scope}} {{#if virtual}}abstract {{/if}}{{kindInThisContext}}{{#if memberof}} of {{>link to=memberof}}{{/if}} |
||||
{{/if~}} |
||||
{{else~}} |
||||
{{#if isExported}}**Kind**: Exported {{kind}} |
||||
{{/if~}} |
||||
{{/if~}} |
||||
@ -1,12 +0,0 @@
|
||||
{{#if see~}} |
||||
|
||||
{{#if (equal see.length 1)~}} |
||||
**See**: {{{inlineLinks see.[0]}}} |
||||
{{else~}} |
||||
**See** |
||||
|
||||
{{#each see}}- {{{inlineLinks this}}} |
||||
{{/each}} |
||||
|
||||
{{/if~}} |
||||
{{/if~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if since}}**Since**: {{{inlineLinks since}}} |
||||
{{/if~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if summary}}**Summary**: {{{inlineLinks summary}}} |
||||
{{/if~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if thisvalue}}**this**: {{>link to=thisvalue}} |
||||
{{/if~}} |
||||
@ -1,8 +0,0 @@
|
||||
{{#if exceptions~}} |
||||
**Throws**: |
||||
|
||||
{{#each exceptions~}} |
||||
- {{#if type.names}}{{>linked-type-list types=type.names}} {{/if}}{{{inlineLinks description}}} |
||||
{{/each}} |
||||
|
||||
{{/if}} |
||||
@ -1,22 +0,0 @@
|
||||
{{#if todoList~}} |
||||
**Todo** |
||||
|
||||
{{#if (option "no-gfm")~}} |
||||
|
||||
{{#each todoList~}} |
||||
{{#if done}}- {{{inlineLinks task}}} ✓ |
||||
{{else}}- {{{inlineLinks task}}} |
||||
{{/if~}} |
||||
{{/each~}} |
||||
|
||||
{{else~}} |
||||
|
||||
{{#each todoList~}} |
||||
{{#if done}}- [x] {{{inlineLinks task}}} |
||||
{{else}}- [ ] {{{inlineLinks task}}} |
||||
{{/if~}} |
||||
{{/each~}} |
||||
|
||||
{{/if}} |
||||
|
||||
{{/if~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{#if version}}**Version**: {{inlineLinks version}} |
||||
{{/if~}} |
||||
@ -1,5 +0,0 @@
|
||||
{{>header~}} |
||||
{{>body}} |
||||
{{!-- {{>member-index~}} --}} |
||||
{{>separator~}} |
||||
{{>members~}} |
||||
@ -1,3 +0,0 @@
|
||||
<a id="{{{anchorName}}}"></a> |
||||
|
||||
{{>heading-indent}}{{>sig-name}} |
||||
@ -1,4 +0,0 @@
|
||||
{{string-repeat " " (add level baseLevel)}}* {{#unless (equal _title undefined)}}_{{_title}}_{{else}}{{>sig-link}}{{/unless}} |
||||
{{#groupBy (option "group-by")~}} |
||||
{{>member-index-grouped baseLevel=(add ../level ../baseLevel 1)~}} |
||||
{{/groupBy~}} |
||||
@ -1,4 +0,0 @@
|
||||
{{>index-indent}}* {{>sig-link-parent}} |
||||
{{#indexChildren ~}} |
||||
{{>member-index-list~}} |
||||
{{/indexChildren}} |
||||
@ -1,26 +0,0 @@
|
||||
{{setLevel this 0~}} |
||||
{{#if (descendants min=(option 'memberIndex.minDescendants'))~}} |
||||
{{#if isExported~}} |
||||
{{#if (equal (depth) 0)}} |
||||
{{#if (optionEquals "member-index-format" "list")}} |
||||
|
||||
{{>member-index-list}} |
||||
|
||||
{{else~}} |
||||
|
||||
{{>member-index-grouped}} |
||||
|
||||
{{/if~}} |
||||
{{/if~}} |
||||
{{else~}} |
||||
{{#if (optionEquals "member-index-format" "list")}} |
||||
|
||||
{{>member-index-list}} |
||||
|
||||
{{else}} |
||||
|
||||
{{>member-index-grouped}} |
||||
|
||||
{{/if~}} |
||||
{{/if~}} |
||||
{{/if}} |
||||
@ -1,3 +0,0 @@
|
||||
{{#children inherited=undefined ~}} |
||||
{{>docs~}} |
||||
{{/children~}} |
||||
@ -1,11 +0,0 @@
|
||||
{{#globals kind=kind ~}} |
||||
{{#if @first~}}{{>heading-indent}}{{../title}} |
||||
|
||||
<dl> |
||||
{{/if~}} |
||||
<dt>{{>sig-link-html}}</dt> |
||||
<dd>{{{md (inlineLinks description)}}}</dd> |
||||
{{#if @last~}}</dl> |
||||
|
||||
{{/if~}} |
||||
{{/globals~}} |
||||
@ -1,9 +0,0 @@
|
||||
{{#globals kind=kind~}} |
||||
{{#if @first~}}{{>heading-indent}}{{../title}} |
||||
|
||||
{{/if~}} |
||||
{{>member-index-grouped~}} |
||||
{{#if @last}} |
||||
|
||||
{{/if~}} |
||||
{{/globals}} |
||||
@ -1,11 +0,0 @@
|
||||
{{#unless (optionEquals "global-index-format" "none")~}} |
||||
{{#if (optionEquals "global-index-format" "dl")}} |
||||
{{>global-index-dl kind=kind title=title ~}} |
||||
{{/if~}} |
||||
{{#if (optionEquals "global-index-format" "grouped")}} |
||||
{{>global-index-grouped kind=kind title=title }} |
||||
{{/if~}} |
||||
{{#if (optionEquals "global-index-format" "table")}} |
||||
{{>global-index-table kind=kind title=title ~}} |
||||
{{/if~}} |
||||
{{/unless~}} |
||||
@ -1,22 +0,0 @@
|
||||
{{#globals kind=kind~}} |
||||
{{#if @first~}} |
||||
{{>heading-indent}}{{../title}} |
||||
|
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Global</th><th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
{{/if~}} |
||||
<tr> |
||||
<td>{{>sig-link-html}}</td> |
||||
<td>{{{md (inlineLinks description)}}}</td> |
||||
</tr> |
||||
{{#if @last~}} |
||||
</tbody> |
||||
</table> |
||||
|
||||
{{/if~}} |
||||
{{/globals}} |
||||
@ -1,10 +0,0 @@
|
||||
{{>global-index-kinds kind="class" title="Classes" ~}} |
||||
{{>global-index-kinds kind="mixin" title="Mixins" ~}} |
||||
{{>global-index-kinds kind="member" title="Members" ~}} |
||||
{{>global-index-kinds kind="namespace" title="Objects" ~}} |
||||
{{>global-index-kinds kind="constant" title="Constants" ~}} |
||||
{{>global-index-kinds kind="function" title="Functions" ~}} |
||||
{{>global-index-kinds kind="event" title="Events" ~}} |
||||
{{>global-index-kinds kind="typedef" title="Typedefs" ~}} |
||||
{{>global-index-kinds kind="external" title="External" ~}} |
||||
{{>global-index-kinds kind="interface" title="Interfaces" ~}} |
||||
@ -1,6 +0,0 @@
|
||||
{{! a main index is only shown if at least 2 global or modules exist ~}} |
||||
|
||||
{{#if (showMainIndex)~}} |
||||
{{>module-index~}} |
||||
{{>global-index~}} |
||||
{{/if~}} |
||||
@ -1,11 +0,0 @@
|
||||
{{#modules~}} |
||||
{{#if @first~}}{{>heading-indent}}Modules |
||||
|
||||
<dl> |
||||
{{/if~}} |
||||
<dt>{{>sig-link-html}}</dt> |
||||
<dd>{{{md (inlineLinks description)}}}</dd> |
||||
{{#if @last~}}</dl> |
||||
|
||||
{{/if~}} |
||||
{{/modules~}} |
||||
@ -1,7 +0,0 @@
|
||||
{{#modules~}} |
||||
{{#if @first~}}{{>heading-indent}}Modules |
||||
|
||||
{{/if~}} |
||||
{{>member-index-grouped~}} |
||||
{{/modules}} |
||||
|
||||
@ -1,22 +0,0 @@
|
||||
{{#modules~}} |
||||
{{#if @first~}} |
||||
{{>heading-indent}}Modules |
||||
|
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Module</th><th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
{{/if~}} |
||||
<tr> |
||||
<td>{{>sig-link-html}}</td> |
||||
<td>{{{md (inlineLinks description)}}}</td> |
||||
</tr> |
||||
{{#if @last~}} |
||||
</tbody> |
||||
</table> |
||||
|
||||
{{/if~}} |
||||
{{/modules}} |
||||
@ -1,5 +0,0 @@
|
||||
{{#unless (optionEquals "module-index-format" "none")~}} |
||||
{{#if (optionEquals "module-index-format" "dl")}}{{>module-index-dl ~}}{{/if~}} |
||||
{{#if (optionEquals "module-index-format" "grouped")}}{{>module-index-grouped ~}}{{/if~}} |
||||
{{#if (optionEquals "module-index-format" "table")}}{{>module-index-table ~}}{{/if~}} |
||||
{{/unless~}} |
||||
@ -1,2 +0,0 @@
|
||||
{{>main-index~}} |
||||
{{>all-docs~}} |
||||
@ -1 +0,0 @@
|
||||
{{string-repeat "#" (headingDepth)}} |
||||
@ -1 +0,0 @@
|
||||
{{string-repeat " " (indexDepth)}} |
||||
@ -1,5 +0,0 @@
|
||||
{{#if (option "separators")}} |
||||
|
||||
* * * |
||||
|
||||
{{/if~}} |
||||
@ -1,14 +0,0 @@
|
||||
{{#if name}}{{#sig no-gfm=true ~}} |
||||
{{{@depOpen}~}} |
||||
<a href="#{{{anchorName}}}"> |
||||
{{~{@codeOpen}~}} |
||||
{{#if @prefix}}{{@prefix}} {{/if~}} |
||||
{{@accessSymbol}}{{#if (isEvent)}}"{{{name}}}"{{else}}{{{name}}}{{/if~}} |
||||
{{~#if @methodSign}}{{#if (isEvent)}} {{@methodSign}}{{else}}{{@methodSign}}{{/if}}{{/if~}} |
||||
{{{@codeClose}~}} |
||||
</a> |
||||
{{~#if @returnSymbol}} {{@returnSymbol}}{{/if~}} |
||||
{{#if @returnTypes}} {{>linked-type-list types=@returnTypes html=true delimiter=" | " }}{{/if~}} |
||||
{{#if @suffix}} {{@suffix}}{{/if~}} |
||||
{{{@depClose}~}} |
||||
{{~/sig}}{{/if~}} |
||||
@ -1,13 +0,0 @@
|
||||
{{#if name}}{{#sig~}} |
||||
{{{@depOpen}~}} |
||||
[{{{@codeOpen}~}} |
||||
{{#if @prefix}}{{@prefix}} {{/if~}} |
||||
{{#if (isClassMember)}}{{@parent~}}{{/if~}} |
||||
{{@accessSymbol}}{{#if (isEvent)}}"{{{name}}}"{{else}}{{{name}}}{{/if~}} |
||||
{{~#if @methodSign}}{{#if (isEvent)}} {{@methodSign}}{{else}}{{@methodSign}}{{/if}}{{/if~}} |
||||
{{{@codeClose}}}](#{{{anchorName}}}) |
||||
{{~#if @returnSymbol}} {{@returnSymbol}}{{/if~}} |
||||
{{#if @returnTypes}} {{>linked-type-list types=@returnTypes delimiter=" \| " }}{{/if~}} |
||||
{{#if @suffix}} {{@suffix}}{{/if~}} |
||||
{{{@depClose}~}} |
||||
{{~/sig}}{{/if~}} |
||||
@ -1,14 +0,0 @@
|
||||
{{#if virtual}}*{{/if}}{{#with (parentObject)}}{{#if virtual}}*{{/if~}}{{/with~}} |
||||
{{#if name}}{{#sig~}} |
||||
{{{@depOpen}~}} |
||||
[{{{@codeOpen}~}} |
||||
{{#if @prefix}}{{@prefix}} {{/if~}} |
||||
{{@accessSymbol}}{{#if (isEvent)}}"{{{name}}}"{{else}}{{{name}}}{{/if~}} |
||||
{{~#if @methodSign}}{{#if (isEvent)}} {{@methodSign}}{{else}}{{@methodSign}}{{/if}}{{/if~}} |
||||
{{{@codeClose}}}](#{{{anchorName}}}) |
||||
{{~#if @returnSymbol}} {{@returnSymbol}}{{/if~}} |
||||
{{#if @returnTypes}} {{>linked-type-list types=@returnTypes delimiter=" \| " }}{{/if~}} |
||||
{{#if @suffix}} {{@suffix}}{{/if~}} |
||||
{{{@depClose}~}} |
||||
{{~/sig}}{{/if~}} |
||||
{{#if virtual}}*{{/if}}{{#with (parentObject)}}{{#if virtual}}*{{/if~}}{{/with~}} |
||||
@ -1,15 +0,0 @@
|
||||
{{#if virtual}}*{{/if}}{{#with (parentObject)}}{{#if virtual}}*{{/if~}}{{/with~}} |
||||
{{#if name}}{{#sig~}} |
||||
{{{@depOpen}~}} |
||||
{{{@codeOpen}~}} |
||||
{{#if @prefix}}{{@prefix}} {{/if~}} |
||||
{{@parent~}} |
||||
{{@accessSymbol}}{{#if (isEvent)}}"{{{name}}}"{{else}}{{{escape name}}}{{/if~}} |
||||
{{#if @methodSign}}{{#if (isEvent)}} {{@methodSign}}{{else}}{{@methodSign}}{{/if}}{{/if~}} |
||||
{{{@codeClose}~}} |
||||
{{#if @returnSymbol}} {{@returnSymbol}}{{/if~}} |
||||
{{#if @returnTypes}} {{>linked-type-list types=@returnTypes delimiter=" \| " }}{{/if~}} |
||||
{{#if @suffix}} {{@suffix}}{{/if~}} |
||||
{{{@depClose}~}} |
||||
{{~/sig}}{{/if~}} |
||||
{{#if virtual}}*{{/if}}{{#with (parentObject)}}{{#if virtual}}*{{/if~}}{{/with~}} |
||||
@ -1 +0,0 @@
|
||||
{{#unless (equal defaultvalue undefined)}}<code>{{#if equals}} = {{/if}}{{#if (equal type.names.[0] "string")}}{{json-stringify defaultvalue}}{{else}}{{defaultvalue}}{{/if}}</code>{{/unless}} |
||||
@ -1,25 +0,0 @@
|
||||
{{! usage: link to="namepath" html=true/false caption="optional caption"~}} |
||||
|
||||
{{~#if html~}} |
||||
<code> |
||||
|
||||
{{~#link to~}} |
||||
{{#if url~}} |
||||
<a href="{{{url}}}">{{#if ../../caption}}{{../../../caption}}{{else}}{{name}}{{/if}}</a> |
||||
{{~else~}} |
||||
{{#if ../../caption}}{{../../../caption}}{{else}}{{name}}{{/if~}} |
||||
{{/if~}} |
||||
{{/link~}} |
||||
|
||||
</code> |
||||
{{~else~}} |
||||
|
||||
{{#link to~}} |
||||
{{#if url~}} |
||||
[<code>{{#if ../../caption}}{{escape ../../../caption}}{{else}}{{escape name}}{{/if}}</code>]({{{url}}}) |
||||
{{~else~}} |
||||
<code>{{#if ../../caption}}{{escape ../../../caption}}{{else}}{{escape name}}{{/if~}}</code> |
||||
{{~/if~}} |
||||
{{/link~}} |
||||
|
||||
{{/if~}} |
||||
Loading…
Reference in new issue