"a couple" => "a few"/"some"
Because apparently I was using it wrong, at least for some parts of the world :)
This commit is contained in:
parent
bba9d6cc18
commit
251a1ea4b5
12 changed files with 18 additions and 18 deletions
|
|
@ -380,7 +380,7 @@ Those usually have one of the following prefixes:
|
||||||
* `dev/...` or `feature/...`: New functionality under development that is to be merged
|
* `dev/...` or `feature/...`: New functionality under development that is to be merged
|
||||||
into the `devel` branch.
|
into the `devel` branch.
|
||||||
|
|
||||||
There is also the `gh-pages` branch, which holds OctoPrint's web page, and a couple of
|
There is also the `gh-pages` branch, which holds OctoPrint's web page, and a few
|
||||||
older development branches that are slowly being migrated or deleted.
|
older development branches that are slowly being migrated or deleted.
|
||||||
|
|
||||||
## How OctoPrint is versioned
|
## How OctoPrint is versioned
|
||||||
|
|
|
||||||
|
|
@ -67,7 +67,7 @@ and at its settings.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
OctoPrint depends on a couple of python modules to do its job. Those are automatically installed when installing
|
OctoPrint depends on a few python modules to do its job. Those are automatically installed when installing
|
||||||
OctoPrint via `setup.py`:
|
OctoPrint via `setup.py`:
|
||||||
|
|
||||||
python setup.py install
|
python setup.py install
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ Printer State
|
||||||
* - ``flags``
|
* - ``flags``
|
||||||
- 1
|
- 1
|
||||||
- Printer state flags
|
- Printer state flags
|
||||||
- A couple of boolean printer state flags
|
- A few boolean printer state flags
|
||||||
* - ``flags.operational``
|
* - ``flags.operational``
|
||||||
- 1
|
- 1
|
||||||
- Boolean
|
- Boolean
|
||||||
|
|
|
||||||
|
|
@ -943,8 +943,8 @@ Use the following settings to configure the server:
|
||||||
* ``X-Scheme``: should contain your custom URL scheme to use (if different from ``http``), e.g. ``https``
|
* ``X-Scheme``: should contain your custom URL scheme to use (if different from ``http``), e.g. ``https``
|
||||||
|
|
||||||
If you use these headers OctoPrint will work both via the reverse proxy as well as when called directly. Take a look
|
If you use these headers OctoPrint will work both via the reverse proxy as well as when called directly. Take a look
|
||||||
`into OctoPrint's wiki <https://github.com/foosel/OctoPrint/wiki/Reverse-proxy-configuration-examples>`_ for a couple
|
`into OctoPrint's wiki <https://github.com/foosel/OctoPrint/wiki/Reverse-proxy-configuration-examples>`_ for some
|
||||||
of examples on how to configure this.
|
examples on how to configure this.
|
||||||
|
|
||||||
.. _sec-configuration-config_yaml-slicing:
|
.. _sec-configuration-config_yaml-slicing:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@ on Windows and ``~/Library/Application Support/OctoPrint`` on MacOS).
|
||||||
|
|
||||||
These GCODE scripts are backed by the templating engine `Jinja2 <http://jinja.pocoo.org/>`_, allowing more than just
|
These GCODE scripts are backed by the templating engine `Jinja2 <http://jinja.pocoo.org/>`_, allowing more than just
|
||||||
simple "send-as-is" scripts but making use of a full blown templating language in order to create your scripts. To
|
simple "send-as-is" scripts but making use of a full blown templating language in order to create your scripts. To
|
||||||
this end, OctoPrint injects a couple of variables into the :ref:`template rendering context <sec-features-gcode_scripts-context>`
|
this end, OctoPrint injects some variables into the :ref:`template rendering context <sec-features-gcode_scripts-context>`
|
||||||
as described below.
|
as described below.
|
||||||
|
|
||||||
.. _sec-features-gcode_scripts-predefined:
|
.. _sec-features-gcode_scripts-predefined:
|
||||||
|
|
@ -64,7 +64,7 @@ All GCODE scripts have access to the following template variables through the te
|
||||||
* ``script``: An object wrapping the script's type (``gcode``) and name (e.g. ``afterPrintCancelled``) as ``script.type``
|
* ``script``: An object wrapping the script's type (``gcode``) and name (e.g. ``afterPrintCancelled``) as ``script.type``
|
||||||
and ``script.name`` respectively.
|
and ``script.name`` respectively.
|
||||||
|
|
||||||
There are a couple of additional template variables available for the following specific scripts:
|
There are a few additional template variables available for the following specific scripts:
|
||||||
|
|
||||||
* ``afterPrintPaused`` and ``beforePrintResumed``
|
* ``afterPrintPaused`` and ``beforePrintResumed``
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -49,7 +49,7 @@ development environment::
|
||||||
by running ``octoprint --version`` or by taking a look into the lower left corner in OctoPrint's
|
by running ``octoprint --version`` or by taking a look into the lower left corner in OctoPrint's
|
||||||
web interface.
|
web interface.
|
||||||
|
|
||||||
We'll start at the most basic form a plugin can take - just a couple of simple lines of Python code:
|
We'll start at the most basic form a plugin can take - just a few simple lines of Python code:
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
:linenos:
|
:linenos:
|
||||||
|
|
@ -116,7 +116,7 @@ used :func:`~octoprint.plugin.StartupPlugin.on_startup` instead, in which case o
|
||||||
up and ready to serve requests.
|
up and ready to serve requests.
|
||||||
|
|
||||||
You'll also note that we are using ``self._logger`` for logging. Where did that one come from? OctoPrint's plugin system
|
You'll also note that we are using ``self._logger`` for logging. Where did that one come from? OctoPrint's plugin system
|
||||||
injects :ref:`a couple of useful objects <sec-plugins-mixins-injectedproperties>` into our plugin implementation classes,
|
injects :ref:`a some useful objects <sec-plugins-mixins-injectedproperties>` into our plugin implementation classes,
|
||||||
one of those being a fully instantiated `python logger <https://docs.python.org/2/library/logging.html>`_ ready to be
|
one of those being a fully instantiated `python logger <https://docs.python.org/2/library/logging.html>`_ ready to be
|
||||||
used by your plugin. As you can see in the log output above, that logger uses the namespace ``octoprint.plugins.helloworld``
|
used by your plugin. As you can see in the log output above, that logger uses the namespace ``octoprint.plugins.helloworld``
|
||||||
for our little plugin here, or more generally ``octoprint.plugins.<plugin identifier>``.
|
for our little plugin here, or more generally ``octoprint.plugins.<plugin identifier>``.
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,7 @@ Helpers
|
||||||
Helpers are methods that plugin can exposed to other plugins in order to make common functionality available on the
|
Helpers are methods that plugin can exposed to other plugins in order to make common functionality available on the
|
||||||
system. They are registered with the OctoPrint plugin system through the use of the control property ``__plugin_helpers__``.
|
system. They are registered with the OctoPrint plugin system through the use of the control property ``__plugin_helpers__``.
|
||||||
|
|
||||||
An example for providing a couple of helper functions to the system can be found in the
|
An example for providing some helper functions to the system can be found in the
|
||||||
`Discovery Plugin <https://github.com/foosel/OctoPrint/wiki/Plugin:-Discovery>`_,
|
`Discovery Plugin <https://github.com/foosel/OctoPrint/wiki/Plugin:-Discovery>`_,
|
||||||
which provides it's SSDP browsing and Zeroconf browsing and publishing functions as helper methods.
|
which provides it's SSDP browsing and Zeroconf browsing and publishing functions as helper methods.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -376,7 +376,7 @@ class CommandTrigger(GenericEventListener):
|
||||||
|
|
||||||
def _processCommand(self, command, payload):
|
def _processCommand(self, command, payload):
|
||||||
"""
|
"""
|
||||||
Performs string substitutions in the command string based on a couple of current parameters.
|
Performs string substitutions in the command string based on a few current parameters.
|
||||||
|
|
||||||
The following substitutions are currently supported:
|
The following substitutions are currently supported:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -239,7 +239,7 @@ class PluginSettings(object):
|
||||||
"""
|
"""
|
||||||
The :class:`PluginSettings` class is the interface for plugins to their own or globally defined settings.
|
The :class:`PluginSettings` class is the interface for plugins to their own or globally defined settings.
|
||||||
|
|
||||||
It provides a couple of convenience methods for directly accessing plugin settings via the regular
|
It provides some convenience methods for directly accessing plugin settings via the regular
|
||||||
:class:`octoprint.settings.Settings` interfaces as well as means to access plugin specific folder locations.
|
:class:`octoprint.settings.Settings` interfaces as well as means to access plugin specific folder locations.
|
||||||
|
|
||||||
All getter and setter methods will ensure that plugin settings are stored in their correct location within the
|
All getter and setter methods will ensure that plugin settings are stored in their correct location within the
|
||||||
|
|
|
||||||
|
|
@ -531,7 +531,7 @@ class UiPlugin(OctoPrintPlugin, SortablePlugin):
|
||||||
provided request by calling :meth:`~octoprint.plugin.UiPlugin.will_handle_ui` with the Flask
|
provided request by calling :meth:`~octoprint.plugin.UiPlugin.will_handle_ui` with the Flask
|
||||||
`Request <http://flask.pocoo.org/docs/0.10/api/#flask.Request>`_ object as
|
`Request <http://flask.pocoo.org/docs/0.10/api/#flask.Request>`_ object as
|
||||||
parameter. If you plugin returns `True` here, OctoPrint will next call
|
parameter. If you plugin returns `True` here, OctoPrint will next call
|
||||||
:meth:`~octoprint.plugin.UiPlugin.on_ui_render` with a couple of parameters like
|
:meth:`~octoprint.plugin.UiPlugin.on_ui_render` with a few parameters like
|
||||||
- again - the Flask Request object and the render keyword arguments as
|
- again - the Flask Request object and the render keyword arguments as
|
||||||
used by the default OctoPrint web interface. For more information see below.
|
used by the default OctoPrint web interface. For more information see below.
|
||||||
|
|
||||||
|
|
@ -582,7 +582,7 @@ class UiPlugin(OctoPrintPlugin, SortablePlugin):
|
||||||
it only gets re-rendered if the request demands that (by having no-cache headers set) or if
|
it only gets re-rendered if the request demands that (by having no-cache headers set) or if
|
||||||
the cache gets invalidated otherwise.
|
the cache gets invalidated otherwise.
|
||||||
|
|
||||||
In order to be able to do that, the ``UiPlugin`` offers overriding a couple of cache specific
|
In order to be able to do that, the ``UiPlugin`` offers overriding some cache specific
|
||||||
methods used for figuring out the source files whose modification time to use for cache invalidation
|
methods used for figuring out the source files whose modification time to use for cache invalidation
|
||||||
as well as override possibilities for ETag and LastModified calculation. Additionally there are
|
as well as override possibilities for ETag and LastModified calculation. Additionally there are
|
||||||
methods to allow persisting call parameters to allow for preemptively caching your UI during
|
methods to allow persisting call parameters to allow for preemptively caching your UI during
|
||||||
|
|
@ -1038,7 +1038,7 @@ class SimpleApiPlugin(OctoPrintPlugin):
|
||||||
mixin offers.
|
mixin offers.
|
||||||
|
|
||||||
Use this mixin if all you need to do is return some kind of dynamic data to your plugin from the backend
|
Use this mixin if all you need to do is return some kind of dynamic data to your plugin from the backend
|
||||||
and/or want to react to simple commands which boil down to a type of command and a couple of flat parameters
|
and/or want to react to simple commands which boil down to a type of command and a few flat parameters
|
||||||
supplied with it.
|
supplied with it.
|
||||||
|
|
||||||
The simple API constructed by OctoPrint for you will be made available under ``/api/plugin/<plugin identifier>/``.
|
The simple API constructed by OctoPrint for you will be made available under ``/api/plugin/<plugin identifier>/``.
|
||||||
|
|
|
||||||
|
|
@ -398,7 +398,7 @@ function formatFuzzyPrintTime(totalSeconds) {
|
||||||
*
|
*
|
||||||
* Accuracy decreases the higher the estimation is:
|
* Accuracy decreases the higher the estimation is:
|
||||||
*
|
*
|
||||||
* * less than 30s: "a couple of seconds"
|
* * less than 30s: "a few seconds"
|
||||||
* * 30s to a minute: "less than a minute"
|
* * 30s to a minute: "less than a minute"
|
||||||
* * 1 to 30min: rounded to full minutes, above 30s is minute + 1 ("27 minutes", "2 minutes")
|
* * 1 to 30min: rounded to full minutes, above 30s is minute + 1 ("27 minutes", "2 minutes")
|
||||||
* * 30min to 40min: "40 minutes"
|
* * 30min to 40min: "40 minutes"
|
||||||
|
|
@ -495,7 +495,7 @@ function formatFuzzyPrintTime(totalSeconds) {
|
||||||
} else {
|
} else {
|
||||||
// only seconds
|
// only seconds
|
||||||
if (seconds < 30) {
|
if (seconds < 30) {
|
||||||
text = gettext("a couple of seconds");
|
text = gettext("a few seconds");
|
||||||
} else {
|
} else {
|
||||||
text = gettext("less than a minute");
|
text = gettext("less than a minute");
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -46,7 +46,7 @@
|
||||||
<label class="checkbox">
|
<label class="checkbox">
|
||||||
<input type="checkbox" data-bind="checked: feature_firmwareDetection" id="settings-firmwareDetection"> {{ _('Enable automatic firmware detection') }}
|
<input type="checkbox" data-bind="checked: feature_firmwareDetection" id="settings-firmwareDetection"> {{ _('Enable automatic firmware detection') }}
|
||||||
<span class="help-inline">{% trans %}
|
<span class="help-inline">{% trans %}
|
||||||
If enabled, OctoPrint will try to figure out your printer's firmware automatically and adjust a couple of communication parameters based on that.
|
If enabled, OctoPrint will try to figure out your printer's firmware automatically and adjust some communication parameters based on that.
|
||||||
If that doesn't work out, or you want more granular control, uncheck this and the parameters in question will become visible for you to adjust.
|
If that doesn't work out, or you want more granular control, uncheck this and the parameters in question will become visible for you to adjust.
|
||||||
{% endtrans %}</span>
|
{% endtrans %}</span>
|
||||||
</label>
|
</label>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue