forked from thudoan/clouddocs-maven-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
replacements.config
75 lines (71 loc) · 3.4 KB
/
replacements.config
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
#
# Sample replacements file for Rackspace clouddocs maven plugin
#
# ********************** POM CONFIGURATION ***********************
# There are two ways to refer this file in your project.
# IMPLICIT: Just place this file next to your project's (e.g., /compute-api/) pom.xml and name it 'replacements.config'
# EXPLICIT: Add the following configuration parameter in your pom
# <replacementsFile>myreplacements.config</replacementsFile>
# Next to other configurations like
# <canonicalUrlBase>http://docs.openstack.org/api/openstack-compute/2/contentSALMANTEST/</canonicalUrlBase>
# <profileSecurity>reviewer</profileSecurity>
# or any other configuration you have defined for your generate-pdf, generate-webhelp goals.
#
#
# ********************** USAGE AND SYNTAX **********************
# Simple case: GLOBAL SEARCH AND REPLACE
# For global search and replace simply give the search and replace tokens in the following format:
# oldValue1->newValue1
# oldValue2->newValue2
# By default all oldValues are considered to be regular expressions unless they are given as a quoted string. e.g.
# "oldValue4"->newValue4
# This is helpful in cases where you want oldValue to be considered as a literal string and not a regular expression.
# So,
# Regular expression: old([Vv])alue4->newValue4 ----- will replace all instances of oldvalue4 and oldValue4 with newValue4.
# Literal String: "old([Vv])alue4"->newValueLiteral4 ----- will only replace instances of old([Vv])alue4 with newValueLiteral4
#
# The other case: TARGETED/RESTRICTED SEARCH AND REPLACE
# This tool allows you to target/restrict the search and replace feature to only
# specific elements of the input XML document using XPath expressions.
# To specify an XPath, start your line with a hardcoded identifier XPATH= and then give the XPath like:
# XPATH=<XPath Expression>
# More specifically:
# XPATH=//*:title/text() ----- Will only replace text value for title element.
# XPATH=//*:titleabbrev/text() ----- restricted titleabbrev text in this case.
# XPATH=//text() ----- same as global search and replace. Considers all text nodes for the search and replace functionality.
#
# An important point to remember here is that once you give an XPATH all oldValue->newValue pairs given below it would be grouped under that XPath.
# Search/Replace terms grouped under an XPath expression will only take effect on
# text of elements/nodes that are returned by matching their parent XPath expression
# e.g.,
# -----
# XPATH=//*:titleabbrev/text() |
# Developer->Dev | is the first group
# API->Application Programming Interface |
# -----
# -----
# XPATH=//*:para/text() |
# OpenStack->RackSpace | Will be considered as a second group
# servers.api.openstack.org->servers.api.rackspace.come |
# -----
#
# To write a comment. Start the line with a hash/pound (#) sign.
#
# first group of search & replace terms
# XPATH=//*:titleabbrev/text()
Dev->Dvlpr
# second group
XPATH=//*:para/text()
color-coded->COLOR-CODED
mimetype->MIMETYPE
# another group
XPATH=//*:title/text()
OpenStack -> Rackspace
# last group. XPath is same as global search and replace.
XPATH=//text()
#Open([Ss])tack->Rack$1pace
OpenStack->Rackspace
OPENSTACK->RACKSPACE
servers.api.openstack.org -> rackspace.api.com
api.servers.openstack.org -> rackspace.api.com
docs.openstack.org -> rackspace.documents.com