[xwiki-devs] [Proposal] New URL configuration parameters - Naming choice
Hi devs, I've implemented "XWIKI-3951: Replace oldcore Entity URL parsing by the new URL module" and this means using more the xwiki-platform-url module. It also means replacing the 2 xwiki.cfg properties by new ones located in xwiki.properties. To be replaced: xwiki.virtual.usepath xwiki.virtual.usepath.servletpath New properties: #------------------------------------------------------------------------------------- # URL #------------------------------------------------------------------------------------- #-# IMPORTANT: The URL module is a feature still in development and as such should be considered experimental at the #-# moment. The configuration parameters below are used only in some part of the code at the moment. The idea is to #-# progressively refactor more and more till only the new properties are used. For the moment you should continue to #-# use the following old properties located in xwiki.cfg: #-# xwiki.virtual.usepath #-# xwiki.virtual.usepath.servletpath #-# [Since 5.1M1] #-# The id of the URL format to use. This allows to plug in different implementations and thus allows to completely #-# control the format of XWiki URLs. #-# #-# The default is: # url.format=standard #-# [Since 5.1M1] #-# Defines where the wiki part is defined in a URL pointing to a subwiki #-# If true then the wiki part is located in the URL path (a.k.a path-based), for example: #-# http://server/xwiki/wiki/mywiki/view/Space/Page #-# If false then the wiki part is located in the URL host domain (a.k.a domain-based), for example: #-# http://mywiki.domain/xwiki/bin/view/Space/Page #-# #-# The default is: # url.standard.multiwiki.isPathBased=true #-# [Since 5.1M1] #-# For path-based setups, this property defines the path segment before the one identifying the subwiki in the URL. #-# For example if set to "thewiki", then the following URL will point to a subwiki named "mywiki": #-# http://server/xwiki/thewiki/mywiki/view/Space/Page #-# Note that the mapping in web.xml has to be modified accordingly if you don't use the default value: #-# <servlet-mapping> #-# <servlet-name>action</servlet-name> #-# <url-pattern>/wiki/*</url-pattern> #-# </servlet-mapping> #-# #-# The default is: # url.standard.multiwiki.wikiPathPrefix=wiki We need to decide if we're ok with these new names or if we want something else. Since these are properties used quite often it's important that we agree on the naming. BTW note that I've implemented LegacyStandardURLConfiguration (in xwiki-platform-legacy-url) to fall back to the old xwiki.cfg properties if they are defined. Thomas proposed the following properties instead: url.standard.multiwiki.path.enabled=true|false url.standard.multiwiki.path.prefix=wiki url.standard.multiwiki.domain.enabled=true|false WDYT? Thanks -Vincent
On Fri, May 3, 2013 at 7:14 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
I've implemented "XWIKI-3951: Replace oldcore Entity URL parsing by the new URL module" and this means using more the xwiki-platform-url module.
It also means replacing the 2 xwiki.cfg properties by new ones located in xwiki.properties.
To be replaced: xwiki.virtual.usepath xwiki.virtual.usepath.servletpath
New properties:
#------------------------------------------------------------------------------------- # URL #-------------------------------------------------------------------------------------
#-# IMPORTANT: The URL module is a feature still in development and as such should be considered experimental at the #-# moment. The configuration parameters below are used only in some part of the code at the moment. The idea is to #-# progressively refactor more and more till only the new properties are used. For the moment you should continue to #-# use the following old properties located in xwiki.cfg: #-# xwiki.virtual.usepath #-# xwiki.virtual.usepath.servletpath
#-# [Since 5.1M1] #-# The id of the URL format to use. This allows to plug in different implementations and thus allows to completely #-# control the format of XWiki URLs. #-# #-# The default is: # url.format=standard
#-# [Since 5.1M1] #-# Defines where the wiki part is defined in a URL pointing to a subwiki #-# If true then the wiki part is located in the URL path (a.k.a path-based), for example: #-# http://server/xwiki/wiki/mywiki/view/Space/Page #-# If false then the wiki part is located in the URL host domain (a.k.a domain-based), for example: #-# http://mywiki.domain/xwiki/bin/view/Space/Page #-# #-# The default is: # url.standard.multiwiki.isPathBased=true
#-# [Since 5.1M1] #-# For path-based setups, this property defines the path segment before the one identifying the subwiki in the URL. #-# For example if set to "thewiki", then the following URL will point to a subwiki named "mywiki": #-# http://server/xwiki/thewiki/mywiki/view/Space/Page #-# Note that the mapping in web.xml has to be modified accordingly if you don't use the default value: #-# <servlet-mapping> #-# <servlet-name>action</servlet-name> #-# <url-pattern>/wiki/*</url-pattern> #-# </servlet-mapping> #-# #-# The default is: # url.standard.multiwiki.wikiPathPrefix=wiki
We need to decide if we're ok with these new names or if we want something else. Since these are properties used quite often it's important that we agree on the naming. BTW note that I've implemented LegacyStandardURLConfiguration (in xwiki-platform-legacy-url) to fall back to the old xwiki.cfg properties if they are defined.
Thomas proposed the following properties instead:
url.standard.multiwiki.path.enabled=true|false url.standard.multiwiki.path.prefix=wiki url.standard.multiwiki.domain.enabled=true|false
We should not add url.standard.multiwiki.domain.enabled now but that's an idea for the future.
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
On Fri, May 3, 2013 at 8:10 PM, Thomas Mortagne <[email protected]>wrote:
On Fri, May 3, 2013 at 7:14 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
I've implemented "XWIKI-3951: Replace oldcore Entity URL parsing by the new URL module" and this means using more the xwiki-platform-url module.
It also means replacing the 2 xwiki.cfg properties by new ones located in xwiki.properties.
To be replaced: xwiki.virtual.usepath xwiki.virtual.usepath.servletpath
New properties:
#-------------------------------------------------------------------------------------
# URL
#-------------------------------------------------------------------------------------
#-# IMPORTANT: The URL module is a feature still in development and as
such should be considered experimental at the
#-# moment. The configuration parameters below are used only in some part of the code at the moment. The idea is to #-# progressively refactor more and more till only the new properties are used. For the moment you should continue to #-# use the following old properties located in xwiki.cfg: #-# xwiki.virtual.usepath #-# xwiki.virtual.usepath.servletpath
#-# [Since 5.1M1] #-# The id of the URL format to use. This allows to plug in different implementations and thus allows to completely #-# control the format of XWiki URLs. #-# #-# The default is: # url.format=standard
#-# [Since 5.1M1] #-# Defines where the wiki part is defined in a URL pointing to a subwiki #-# If true then the wiki part is located in the URL path (a.k.a path-based), for example: #-# http://server/xwiki/wiki/mywiki/view/Space/Page #-# If false then the wiki part is located in the URL host domain (a.k.a domain-based), for example: #-# http://mywiki.domain/xwiki/bin/view/Space/Page #-# #-# The default is: # url.standard.multiwiki.isPathBased=true
#-# [Since 5.1M1] #-# For path-based setups, this property defines the path segment before the one identifying the subwiki in the URL. #-# For example if set to "thewiki", then the following URL will point to a subwiki named "mywiki": #-# http://server/xwiki/thewiki/mywiki/view/Space/Page #-# Note that the mapping in web.xml has to be modified accordingly if you don't use the default value: #-# <servlet-mapping> #-# <servlet-name>action</servlet-name> #-# <url-pattern>/wiki/*</url-pattern> #-# </servlet-mapping> #-# #-# The default is: # url.standard.multiwiki.wikiPathPrefix=wiki
We need to decide if we're ok with these new names or if we want something else. Since these are properties used quite often it's important that we agree on the naming. BTW note that I've implemented LegacyStandardURLConfiguration (in xwiki-platform-legacy-url) to fall back to the old xwiki.cfg properties if they are defined.
Thomas proposed the following properties instead:
url.standard.multiwiki.path.enabled=true|false url.standard.multiwiki.path.prefix=wiki url.standard.multiwiki.domain.enabled=true|false
We should not add url.standard.multiwiki.domain.enabled now but that's an idea for the future.
Does it means that path and domain based wiki will work at the same time and are not opposite of each other ?
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Denis Gervalle SOFTEC sa - CEO eGuilde sarl - CTO
On Fri, May 3, 2013 at 8:14 PM, Denis Gervalle <[email protected]> wrote:
On Fri, May 3, 2013 at 8:10 PM, Thomas Mortagne <[email protected]>wrote:
On Fri, May 3, 2013 at 7:14 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
I've implemented "XWIKI-3951: Replace oldcore Entity URL parsing by the new URL module" and this means using more the xwiki-platform-url module.
It also means replacing the 2 xwiki.cfg properties by new ones located in xwiki.properties.
To be replaced: xwiki.virtual.usepath xwiki.virtual.usepath.servletpath
New properties:
#-------------------------------------------------------------------------------------
# URL
#-------------------------------------------------------------------------------------
#-# IMPORTANT: The URL module is a feature still in development and as
such should be considered experimental at the
#-# moment. The configuration parameters below are used only in some part of the code at the moment. The idea is to #-# progressively refactor more and more till only the new properties are used. For the moment you should continue to #-# use the following old properties located in xwiki.cfg: #-# xwiki.virtual.usepath #-# xwiki.virtual.usepath.servletpath
#-# [Since 5.1M1] #-# The id of the URL format to use. This allows to plug in different implementations and thus allows to completely #-# control the format of XWiki URLs. #-# #-# The default is: # url.format=standard
#-# [Since 5.1M1] #-# Defines where the wiki part is defined in a URL pointing to a subwiki #-# If true then the wiki part is located in the URL path (a.k.a path-based), for example: #-# http://server/xwiki/wiki/mywiki/view/Space/Page #-# If false then the wiki part is located in the URL host domain (a.k.a domain-based), for example: #-# http://mywiki.domain/xwiki/bin/view/Space/Page #-# #-# The default is: # url.standard.multiwiki.isPathBased=true
#-# [Since 5.1M1] #-# For path-based setups, this property defines the path segment before the one identifying the subwiki in the URL. #-# For example if set to "thewiki", then the following URL will point to a subwiki named "mywiki": #-# http://server/xwiki/thewiki/mywiki/view/Space/Page #-# Note that the mapping in web.xml has to be modified accordingly if you don't use the default value: #-# <servlet-mapping> #-# <servlet-name>action</servlet-name> #-# <url-pattern>/wiki/*</url-pattern> #-# </servlet-mapping> #-# #-# The default is: # url.standard.multiwiki.wikiPathPrefix=wiki
We need to decide if we're ok with these new names or if we want something else. Since these are properties used quite often it's important that we agree on the naming. BTW note that I've implemented LegacyStandardURLConfiguration (in xwiki-platform-legacy-url) to fall back to the old xwiki.cfg properties if they are defined.
Thomas proposed the following properties instead:
url.standard.multiwiki.path.enabled=true|false url.standard.multiwiki.path.prefix=wiki url.standard.multiwiki.domain.enabled=true|false
We should not add url.standard.multiwiki.domain.enabled now but that's an idea for the future.
Does it means that path and domain based wiki will work at the same time and are not opposite of each other ?
That's how it's working right now. When you enable path based, domain based still works so that would make the option more clear.
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Denis Gervalle SOFTEC sa - CEO eGuilde sarl - CTO _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
participants (3)
-
Denis Gervalle -
Thomas Mortagne -
Vincent Massol