diff options
Diffstat (limited to 'mediagoblin/plugins')
-rw-r--r-- | mediagoblin/plugins/basic_auth/README.rst | 2 | ||||
-rw-r--r-- | mediagoblin/plugins/flatpagesfile/README.rst | 8 | ||||
-rw-r--r-- | mediagoblin/plugins/geolocation/templates/mediagoblin/plugins/geolocation/map.html | 5 | ||||
-rw-r--r-- | mediagoblin/plugins/ldap/README.rst | 18 | ||||
-rw-r--r-- | mediagoblin/plugins/openid/README.rst | 12 | ||||
-rw-r--r-- | mediagoblin/plugins/trim_whitespace/README.rst | 2 |
6 files changed, 24 insertions, 23 deletions
diff --git a/mediagoblin/plugins/basic_auth/README.rst b/mediagoblin/plugins/basic_auth/README.rst index 82f247ed..87a7b16f 100644 --- a/mediagoblin/plugins/basic_auth/README.rst +++ b/mediagoblin/plugins/basic_auth/README.rst @@ -5,7 +5,7 @@ =================== The basic_auth plugin is enabled by default in mediagoblin.ini. This plugin -provides basic username and password authentication for GNU Mediagoblin. +provides basic username and password authentication for GNU MediaGoblin. This plugin can be enabled alongside :ref:`openid-chapter` and :ref:`persona-chapter`. diff --git a/mediagoblin/plugins/flatpagesfile/README.rst b/mediagoblin/plugins/flatpagesfile/README.rst index 59cd6217..0354a46c 100644 --- a/mediagoblin/plugins/flatpagesfile/README.rst +++ b/mediagoblin/plugins/flatpagesfile/README.rst @@ -57,7 +57,7 @@ Examples: ``flatpages-about``, ``about-view``, ``contact-view``, ... The value has two parts separated by commas: -1. **route path**: This is the url that this route matches. +1. **route path**: This is the URL that this route matches. Examples: ``/about``, ``/contact``, ``/pages/about``, ... @@ -74,7 +74,7 @@ The value has two parts separated by commas: For example: ``'/siteadmin/{adminname:\w+}'`` -2. **template**: The template to use for this url. The template is in +2. **template**: The template to use for this URL. The template is in the flatpagesfile template directory, so you just need to specify the file name. @@ -139,10 +139,10 @@ template:: Recipes ======= -Url variables +URL variables ------------- -You can handle urls like ``/about/{name}`` and access the name that's +You can handle URLs like ``/about/{name}`` and access the name that's passed in in the template. Sample route:: diff --git a/mediagoblin/plugins/geolocation/templates/mediagoblin/plugins/geolocation/map.html b/mediagoblin/plugins/geolocation/templates/mediagoblin/plugins/geolocation/map.html index 87f790d1..be608ac0 100644 --- a/mediagoblin/plugins/geolocation/templates/mediagoblin/plugins/geolocation/map.html +++ b/mediagoblin/plugins/geolocation/templates/mediagoblin/plugins/geolocation/map.html @@ -43,8 +43,9 @@ href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors </li><li>Imaging ©<a - href="http://mapquest.com">MapQuest</a></li><li>Maps powered by - <a href="http://leafletjs.com/"> Leaflet</a></li></ul> + href="https://www.openstreetmap.org">OpenStreetMap + contributors</a></li><li>Maps powered by + <a href="http://leafletjs.com/">Leaflet</a></li></ul> </div> <p> <small> diff --git a/mediagoblin/plugins/ldap/README.rst b/mediagoblin/plugins/ldap/README.rst index ea9a34b3..049b5c4d 100644 --- a/mediagoblin/plugins/ldap/README.rst +++ b/mediagoblin/plugins/ldap/README.rst @@ -14,16 +14,16 @@ .. _ldap-plugin: ============= - ldap plugin + LDAP plugin ============= .. Warning:: This plugin is not compatible with the other authentication plugins. -This plugin allow your GNU Mediagoblin instance to authenticate against an +This plugin allow your GNU MediaGoblin instance to authenticate against an LDAP server. -Set up the ldap plugin +Set up the LDAP plugin ====================== 1. Install the ``python-ldap`` package. @@ -32,13 +32,13 @@ Set up the ldap plugin [[mediagoblin.plugins.ldap]] -Configuring the ldap plugin +Configuring the LDAP plugin =========================== -This plugin allows you to use multiple ldap servers for authentication. +This plugin allows you to use multiple LDAP servers for authentication. In order to configure a server, add the following to you MediaGoblin .ini file -under the ldap plugin:: +under the LDAP plugin:: [[mediagoblin.plugins.ldap]] [[[server1]]] @@ -50,15 +50,15 @@ under the ldap plugin:: Make any necessary changes to the above to work with your sever. Make sure ``{username}`` is where the username should be in LDAP_USER_DN_TEMPLATE. -If you would like to fetch the users email from the ldap server upon account +If you would like to fetch the users email from the LDAP server upon account registration, add ``LDAP_SEARCH_BASE = 'ou=users,dc=testathon,dc=net'`` and ``EMAIL_SEARCH_FIELD = 'mail'`` under you server configuration in your MediaGoblin .ini file. .. Warning:: By default, this plugin provides no encryption when communicating with the - ldap servers. If you would like to use an SSL connection, change - LDAP_SERVER_URI to use ``ldaps://`` and whichever port you use. Default ldap + LDAP servers. If you would like to use an SSL connection, change + LDAP_SERVER_URI to use ``ldaps://`` and whichever port you use. Default LDAP port for SSL connections is 636. If you would like to use a TLS connection, add ``LDAP_START_TLS = 'true'`` under your server configuration in your MediaGoblin .ini file. diff --git a/mediagoblin/plugins/openid/README.rst b/mediagoblin/plugins/openid/README.rst index 870a2b58..1a777336 100644 --- a/mediagoblin/plugins/openid/README.rst +++ b/mediagoblin/plugins/openid/README.rst @@ -1,23 +1,23 @@ .. _openid-chapter: =================== - openid plugin + OpenID plugin =================== -The openid plugin allows user to login to your GNU Mediagoblin instance using -their openid url. +The OpenID plugin allows user to login to your GNU MediaGoblin instance using +their OpenID URL. This plugin can be enabled alongside :ref:`basic_auth-chapter` and :ref:`persona-chapter`. .. note:: - When :ref:`basic_auth-chapter` is enabled alongside this openid plugin, and - a user creates an account using their openid. If they would like to add a + When :ref:`basic_auth-chapter` is enabled alongside this OpenID plugin, and + a user creates an account using their OpenID. If they would like to add a password to their account, they can use the forgot password feature to do so. -Set up the openid plugin +Set up the OpenID plugin ============================ 1. Install the ``python-openid`` package. diff --git a/mediagoblin/plugins/trim_whitespace/README.rst b/mediagoblin/plugins/trim_whitespace/README.rst index db9a0c53..d83af06b 100644 --- a/mediagoblin/plugins/trim_whitespace/README.rst +++ b/mediagoblin/plugins/trim_whitespace/README.rst @@ -2,7 +2,7 @@ Trim whitespace plugin ======================= -Mediagoblin templates are written with 80 char limit for better +MediaGoblin templates are written with 80 char limit for better readability. However that means that the HTML output is very verbose containing *lots* of whitespace. This plugin inserts a middleware that filters out whitespace from the returned HTML in the ``Response()`` |