EN translation for view plugin dev doc #2240
Conversation
cemremengu
changed the title
Codecov Report
@@ Coverage Diff @@
## master #2240 +/- ##
=======================================
Coverage 99.59% 99.59%
=======================================
Files 29 29
Lines 749 749
=======================================
Hits 746 746
Misses 3 3Continue to review full report at Codecov.
|
|
|
||
| In most cases, we need to read the data, render the template and then present it to the user. The framework does not force the use of some template engine. The developer selects the [template](../core/view.md). For details, see [Template Rendering](../core/view.md). | ||
|
|
There was a problem hiding this comment.
- some template engine -> one template engine(某种）
- The developer selects the template -> the developer can select the template by theirselves (ps:这一句和前一句不应该隔开，前后两句为完整的一句）
|
|
||
| ```bash | ||
| Egg-view-ejs |
|
|
||
| * Follow the [plugin development specification](./plugin.md) | ||
| * According to convention, plugin names start with `egg-view-` |
There was a problem hiding this comment.
plugin names start with -> the name of plugin starts with
| * Follow the [plugin development specification](./plugin.md) | ||
| * According to convention, plugin names start with `egg-view-` | ||
| * `package.json` is configured as follows. Plugin names are named after the template engine, such as ejs |
There was a problem hiding this comment.
plugin names -> the names of plugin
|
|
||
| `json { "name": "egg-view-ejs", "eggPlugin": { "name": "ejs" }, "keywords": [ "egg", "egg-plugin", "egg-view", "ejs" ], }` | ||
|
|
| }; | ||
| ``` | ||
|
|
|
|
||
| * filename: is the path to the complete file. The framework determines if the file exists when it looks for the file. It does not need to be processed here. | ||
| * locals: The data needed for rendering. The data comes from `app.locals`, `ctx.locals` and calls `render` methods. The framework also has built-in `ctx`, `request`, `ctx.helper` objects. |
There was a problem hiding this comment.
built-in 是 形容词，改成 built in
There was a problem hiding this comment.
Keeping this as is due to
https://www.merriam-webster.com/dictionary/built-in
| * locals: The data needed for rendering. The data comes from `app.locals`, `ctx.locals` and calls `render` methods. The framework also has built-in `ctx`, `request`, `ctx.helper` objects. | ||
| * viewOptions: The incoming configuration of the user, which overrides the default configuration of the template engine. This can be considered based on the characteristics of the template engine. For example, the cache is enabled by default, and a page does not need to be cached. | ||
|
|
There was a problem hiding this comment.
- which overrides -> which can override
- and a page-> but a page(为转折关系）
| The framework provides `ctx.helper` for developer use, but in some cases we want to override the helper method and only take effect when the template is rendered. | ||
|
|
||
| In template rendering, we often need to output a user-supplied html fragment, usually using the `helper.shtml` provided by the `egg-security` plugin. |
There was a problem hiding this comment.
感觉句子不太顺，建议：
In template rendering, we often need to output a user-supplied html fragment, in which case, we usually use the helper.shtml provided by the egg-security plugin
| [egg-security]: https://github.com/eggjs/egg-security | ||
| [egg-view-nunjucks]: https://github.com/eggjs/egg-view-nunjucks | ||
| [egg-view-ejs]: https://github.com/eggjs/egg-view-ejs |
| @@ -23,49 +23,61 @@ Egg-view-ejs | |||
| ## Plugin naming convention | |||
|
|
|||
| * Follow the [plugin development specification](./plugin.md) | |||
| * According to convention, plugin names start with `egg-view-` | |||
| * `package.json` is configured as follows. Plugin names are named after the template engine, such as ejs | |||
| * According to the convention, the name of the plugins start with `egg-view-` | |||
There was a problem hiding this comment.
the name of plugins start with -> the names of plugins start with
| @@ -75,7 +87,7 @@ The three parameters of the `render` method are | |||
|
|
|||
| * filename: is the path to the complete file. The framework determines if the file exists when it looks for the file. It does not need to be processed here. | |||
| * locals: The data needed for rendering. The data comes from `app.locals`, `ctx.locals` and calls `render` methods. The framework also has built-in `ctx`, `request`, `ctx.helper` objects. | |||
There was a problem hiding this comment.
built-in 是形容词，这里的语义是“内置了” 为动词，故需要分开写
There was a problem hiding this comment.
I don't agree. You might be confused by thinking in Chinese. 😄 but I will do as you say since you have the authority here.
See this for example: https://www.treehugger.com/bikes/cyclevision-bike-helmet-has-built-cameras-front-and-rear.html
|
done~ @atian25 |
docs: EN translation for view plugin dev doc (#2240)
Added en translation for view plugin dev doc #363