Skip to content

Commit a60f8a3

Browse files
author
Bruno Herfst
committed
Finished modules.init
1 parent b709ffc commit a60f8a3

File tree

17 files changed

+426
-344
lines changed

17 files changed

+426
-344
lines changed

Diff for: aes/util/schema/schema.document/document.js

+185-179
Large diffs are not rendered by default.

Diff for: ind/util/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A couple of bundles of modules often used together.
1010
## Measurements
1111
Modules that are related to measurements.
1212

13-
- [ ] [Ruler.set](ruler.set)
13+
- [ ] [Ruler](ruler)
1414

1515
## More info
1616

Diff for: ind/util/ruler.set/ruler.set.js

-148
This file was deleted.

Diff for: ind/util/ruler/.npmignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.venv
2+
test/results.md

Diff for: ind/util/ruler.set/README.md renamed to ind/util/ruler/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# ruler.set
1+
# ruler
22

33
> InDesign Utility
44
55
The `ruler.set()` method sets both rulers to the desired units. It returns the original ruler-settings which we can pass back to reset the rulers to original state.
66

77
## Install
88

9-
npm install @extendscript/aes.ind.util.ruler.set
9+
npm install @extendscript/aes.ind.util.ruler
1010

1111
## Test
1212

Diff for: ind/util/ruler/package.json

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"name": "@extendscript/ind.util.ruler",
3+
"version": "0.1.0",
4+
"description": "The ruler.set() method sets both rulers to the desired units. It returns the original ruler-settings which we can pass back to reset the rulers to original state.",
5+
"main": "ruler.set.js",
6+
"scripts": {
7+
"buildEnv": "curl https://raw.githubusercontent.com/ES-Collection/build-node-venv/master/build-node-venv.sh > ./.bnv.sh && chmod +x ./.bnv.sh && ./.bnv.sh && rm ./.bnv.sh",
8+
"prepublishOnly": "npm config set scope extendscript",
9+
"test": "node ./test/test.js"
10+
},
11+
"repository": {
12+
"type": "git",
13+
"url": "git+https://github.com/ExtendScript/extendscript-modules.git"
14+
},
15+
"keywords": [
16+
"extendscript",
17+
"extendscript-modules",
18+
"indesign",
19+
"ruler"
20+
],
21+
"author": "extendscript.org",
22+
"license": "MIT",
23+
"bugs": {
24+
"url": "https://github.com/ExtendScript/extendscript-modules/issues"
25+
},
26+
"homepage": "https://github.com/ExtendScript/extendscript-modules#readme",
27+
"devDependencies": {
28+
"tap-es": "git+https://github.com/ExtendScript/tap-es.git"
29+
}
30+
}

Diff for: ind/util/ruler/ruler.js

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
(function () {
2+
3+
var VERSION = 0.1;
4+
var MODULE_PATH = "ruler";
5+
6+
var module = Sky.getUtil(MODULE_PATH);
7+
if( module && module.version >= VERSION) {
8+
return;
9+
};
10+
11+
//--------------------------
12+
// start module
13+
14+
module = {
15+
"version" : VERSION
16+
};
17+
18+
module.set = function (doc, myNewUnits) {
19+
var myOldUnits = { xruler : doc.viewPreferences.horizontalMeasurementUnits,
20+
yruler : doc.viewPreferences.verticalMeasurementUnits,
21+
origin : doc.viewPreferences.rulerOrigin,
22+
zeroPoint : doc.zeroPoint };
23+
24+
if (myNewUnits.hasOwnProperty('xruler') && myNewUnits.hasOwnProperty('yruler')){
25+
doc.viewPreferences.horizontalMeasurementUnits = myNewUnits.xruler;
26+
doc.viewPreferences.verticalMeasurementUnits = myNewUnits.yruler;
27+
} else if( myNewUnits.hasOwnProperty('units')) {
28+
// Set both rulers to the same unit
29+
// We will cast everything to string so it can parse a wide variaty of input including the MeasurementUnits object
30+
var stringUnits = String(myNewUnits.units).toLowerCase();
31+
with(doc.viewPreferences){
32+
switch(stringUnits) {
33+
case "0":
34+
case "millimeters":
35+
case "mm":
36+
case "millimeter":
37+
case "zmms":
38+
case "2053991795":
39+
horizontalMeasurementUnits = MeasurementUnits.MILLIMETERS;
40+
verticalMeasurementUnits = MeasurementUnits.MILLIMETERS;
41+
break;
42+
case "1":
43+
case "inchesDecimal":
44+
case "inch": // shorthand to decimal
45+
case "zoll":
46+
case "pouce":
47+
case "zind":
48+
case "2053729892":
49+
horizontalMeasurementUnits = MeasurementUnits.INCHES_DECIMAL;
50+
verticalMeasurementUnits = MeasurementUnits.INCHES_DECIMAL;
51+
break;
52+
case "inches":
53+
case "zinc":
54+
case "2053729891":
55+
horizontalMeasurementUnits = MeasurementUnits.INCHES;
56+
verticalMeasurementUnits = MeasurementUnits.INCHES;
57+
break;
58+
case "2":
59+
case "points":
60+
case "pt":
61+
case "zpoi":
62+
case "2054188905":
63+
horizontalMeasurementUnits = MeasurementUnits.POINTS;
64+
verticalMeasurementUnits = MeasurementUnits.POINTS;
65+
break;
66+
case "american_points":
67+
case "apt":
68+
case "zapt":
69+
case "1514238068":
70+
horizontalMeasurementUnits = MeasurementUnits.AMERICAN_POINTS;
71+
verticalMeasurementUnits = MeasurementUnits.AMERICAN_POINTS;
72+
break;
73+
case "agates":
74+
case "zagt":
75+
case "2051106676":
76+
horizontalMeasurementUnits = MeasurementUnits.AGATES;
77+
verticalMeasurementUnits = MeasurementUnits.AGATES;
78+
break;
79+
case "bai":
80+
case "zbai":
81+
case "2051170665":
82+
horizontalMeasurementUnits = MeasurementUnits.BAI;
83+
verticalMeasurementUnits = MeasurementUnits.BAI;
84+
break;
85+
case "cm":
86+
case "centimeter":
87+
case "centimeters":
88+
case "zcms":
89+
case "2053336435":
90+
horizontalMeasurementUnits = MeasurementUnits.CENTIMETERS;
91+
verticalMeasurementUnits = MeasurementUnits.CENTIMETERS;
92+
break;
93+
case "ciceros":
94+
case "c":
95+
case "zcic":
96+
case "2053335395":
97+
horizontalMeasurementUnits = MeasurementUnits.CICEROS;
98+
verticalMeasurementUnits = MeasurementUnits.CICEROS;
99+
break;
100+
case "custom":
101+
case "cstm":
102+
case "1131639917":
103+
horizontalMeasurementUnits = MeasurementUnits.CUSTOM;
104+
verticalMeasurementUnits = MeasurementUnits.CUSTOM;
105+
break;
106+
case "ha":
107+
case "zha":
108+
case "1516790048":
109+
horizontalMeasurementUnits = MeasurementUnits.HA;
110+
verticalMeasurementUnits = MeasurementUnits.HA;
111+
break;
112+
case "mils":
113+
case "zmil":
114+
case "2051893612":
115+
horizontalMeasurementUnits = MeasurementUnits.MILS;
116+
verticalMeasurementUnits = MeasurementUnits.MILS;
117+
break;
118+
case "picas":
119+
case "p":
120+
case "zpic":
121+
case "2054187363":
122+
horizontalMeasurementUnits = MeasurementUnits.PICAS;
123+
verticalMeasurementUnits = MeasurementUnits.PICAS;
124+
break;
125+
case "pixels":
126+
case "pixel":
127+
case "px":
128+
case "zpix":
129+
case "2054187384":
130+
horizontalMeasurementUnits = MeasurementUnits.PIXELS;
131+
verticalMeasurementUnits = MeasurementUnits.PIXELS;
132+
break;
133+
case "q":
134+
case "zque":
135+
case "2054255973":
136+
horizontalMeasurementUnits = MeasurementUnits.Q;
137+
verticalMeasurementUnits = MeasurementUnits.Q;
138+
break;
139+
case "u":
140+
case "zju":
141+
case "2051691808":
142+
horizontalMeasurementUnits = MeasurementUnits.U;
143+
verticalMeasurementUnits = MeasurementUnits.U;
144+
break;
145+
default:
146+
alert("Function setRuler:\nCould not parse MeasurementUnits: " + typeof(myNewUnits) + " " + myNewUnits );
147+
break;
148+
}
149+
}
150+
}
151+
152+
if(myNewUnits.hasOwnProperty('origin')){
153+
doc.viewPreferences.rulerOrigin = myNewUnits.origin;
154+
} else { // Use page origin if not defined
155+
doc.viewPreferences.rulerOrigin = RulerOrigin.pageOrigin;
156+
};
157+
158+
if(myNewUnits.hasOwnProperty('zeroPoint')) {
159+
doc.zeroPoint = myNewUnits.zeroPoint;
160+
} else { // Use zero point if not defined
161+
doc.zeroPoint = [0,0];
162+
};
163+
164+
return myOldUnits;
165+
};
166+
//--------------------------
167+
// End module
168+
169+
Sky.setUtil(MODULE_PATH, module);
170+
171+
})();

Diff for: setup/test/results_log.md renamed to ind/util/ruler/test/results_log.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
As tests may be run by different people on different platforms the results are logged here. If you don't see your software version listed here, please run the test in your enviroment and add the result below. Thanks!
44

5-
## extendscript-modules.setup.js
5+
## ruler.js
66

77
> Version 0
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
var argv = require('minimist')(process.argv.slice(2)); // Remove nodePath, scriptpath
22
var tapes = require("tap-es"), targets = argv._, d = require('path').resolve(__dirname);
33

4-
tapes.add('setup', d+'/test.jsx', targets, true);
4+
tapes.add('ruler', d+'/test.jsx', targets, true);
55
tapes.run(d+'/results.md');

0 commit comments

Comments
 (0)