| author | convert-repo |
| Sun, 22 Oct 2017 03:41:12 +0000 | |
| changeset 1053 | 75f684c8517a |
| parent 823 | 70eca15a7972 |
| permissions | -rw-r--r-- |
|
820
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
1 |
<HTML> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
2 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
3 |
<HEAD> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
4 |
<TITLE>Smalltalk/X Programmers guide - API for custom code generators and refactorings - installation</TITLE> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
5 |
</HEAD> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
6 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
7 |
<BODY> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
8 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
9 |
<A NOPRINT HREF="refactoring_custom.html"> <IMG SRC="../../icons/DocsLeftArrow.gif" ALT="[prev]"></A> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
10 |
<A NOPRINT HREF="refactoring_custom.html"> <IMG SRC="../../icons/DocsUpArrow.gif" ALT="[up]"></A> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
11 |
<A NOPRINT HREF="refactoring_custom-getting-started.html"> <IMG SRC="../../icons/DocsRightArrow.gif" ALT="[next]"></A> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
12 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
13 |
<H1>API for custom code generators and refactorings - installation</H1> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
14 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
15 |
<h2>Requirements</h2> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
16 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
17 |
<p> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
18 |
<b>1. Smalltalk/X</b><br> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
19 |
You need recent <a href="http://swing.fit.cvut.cz/projects/stx-goodies/wiki/SmalltalkX">Smalltalk/X jv-branch</a> downloaded and |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
20 |
installed on your computer. Package is not tested and maintained on official eXept |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
21 |
Smalltalk/X distribution downloaded from <a href="http://www.exept.de">http://www.exept.de</a>. |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
22 |
</p> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
23 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
24 |
<p> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
25 |
<b>2. Package source files</b><br> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
26 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
27 |
You need to download package from Bitbucket repository |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
28 |
<a href="https://bitbucket.org/jnesveda/refactoring_custom">jnesveda/refactoring_custom</a>. |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
29 |
You can download it via |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
30 |
<a href="http://mercurial.selenic.com/">Mercurial</a> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
31 |
command "hg clone url/from/the/link/above" or by clicking on cloud icon in the |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
32 |
left bar titled with "Downloads". |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
33 |
</p> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
34 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
35 |
<h2>Installation</h2> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
36 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
37 |
<p> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
38 |
Add downloaded source files to folder named "jn/refactoring_custom" which needs |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
39 |
to be located under your package path (easiest is to put it just in lib/smalltalkx/6.2.5/packages |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
40 |
where 6.2.5 is STX version). Now run STX, open system browser and click on |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
41 |
top menu items named "View -> Package". You should see new package named |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
42 |
jn/refactoring_custom. Right-click on it and select "Load". |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
43 |
<pre class="code-snippet"> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
44 |
"To see whats you package path write following line somewhere in STX |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
45 |
(code editor,launcher text-box), select it, rigt-click and choose Inspect." |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
46 |
Smalltalk packagePath. |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
47 |
"This will add a folder as package path" |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
48 |
Smalltalk packagePath add: 'C:\path\to\your\packages'. |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
49 |
</pre> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
50 |
</p> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
51 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
52 |
<p> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
53 |
If everything went well then you can select some class in the system browser, |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
54 |
right-click on it and now you should see 2 new menu items "Refactor - Custom", |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
55 |
"Generate - Custom". However, many troubles can happen during package loading. |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
56 |
Subpackage "patches" has to also properly loaded, but can happen that it wont |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
57 |
load with described procedure. There are many other possibilities how to load |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
58 |
classes. You can try one of these if regular way fails (you will see classes marked |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
59 |
as unloaded or you wont see them): |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
60 |
<ul> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
61 |
<li>Load classes one-by-one by double clicking on them</li> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
62 |
<li>Click on View -> Category in the system browser, select category, |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
63 |
right-click on it and click on "Special -> Load"</li> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
64 |
<li>Open file browser, locate the source files, select them, right-click |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
65 |
on it and click on FileIn</li> |
|
823
70eca15a7972
Added one more tip how to load package
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
820
diff
changeset
|
66 |
<li>Paste "Smalltalk loadPackage: 'jn:refactoring_custom'" somewhere (e.g. launcher dialog), |
|
70eca15a7972
Added one more tip how to load package
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
820
diff
changeset
|
67 |
select it, right-click on it and click on "DoIt" in the menu</li> |
|
820
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
68 |
</ul> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
69 |
Finally you can run tests using test runner from launcher to see if everything |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
70 |
works as expected. You can check the test results against the newest STX-JV branch version |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
71 |
in <a href="https://swing.fit.cvut.cz/jenkins/job/custom_refactorings_reports/">Jenkins job</a>, |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
72 |
but this will be most probably removed when this project will be outdated. |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
73 |
</p> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
74 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
75 |
<HR> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
76 |
<P> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
77 |
<IMG NOPRINT ALIGN=middle SRC="../../icons/stx.gif"> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
78 |
|
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
79 |
</BODY> |
|
899b9a25d0c6
Added html documentation
Jakub Nesveda <jakubnesveda@seznam.cz>
parents:
diff
changeset
|
80 |
</HTML> |