Skip to content

Commit

Permalink
Add docs fix win32 installer
Browse files Browse the repository at this point in the history
  • Loading branch information
Vitaliy-Yakovchuk committed Nov 18, 2017
1 parent 45fc18d commit 66b14dc
Show file tree
Hide file tree
Showing 130 changed files with 30,419 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ crashlytics-build.properties
### Gradle ###
.gradle
build/
dist/full
dest/full

# Ignore Gradle GUI config
gradle-app.setting
Expand Down
10 changes: 9 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,15 @@ task moveStartup{
doLast{
mkdir('dest/full/bin')
file('dest/full/lib/ramus/startup-1.0-SNAPSHOT.jar')
.renameTo('dest/full/bin/startup.jar')
.renameTo('dest/full/bin/ramus-startup.jar')
//delete not needed files
file('dest/full/lib/ramus/chart-common-1.0-SNAPSHOT.jar').delete()
file('dest/full/lib/ramus/chart-core-1.0-SNAPSHOT.jar').delete()
file('dest/full/lib/ramus/chart-gui-1.0-SNAPSHOT.jar').delete()
file('dest/full/lib/ramus/client-1.0-SNAPSHOT.jar').delete()
file('dest/full/lib/ramus/local-client-1.0-SNAPSHOT.jar').delete()
file('dest/full/lib/ramus/net-common-1.0-SNAPSHOT.jar').delete()
file('dest/full/lib/ramus/server-1.0-SNAPSHOT.jar').delete()
}
}

Expand Down
Binary file added dest/doc/en/Enterprise activity.rsf
Binary file not shown.
Binary file added dest/doc/en/Ramus-Help.odt
Binary file not shown.
Binary file added dest/doc/ru/Model example.rsf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added dest/doc/ru/Пример модели.rsf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added dest/doc/ru/Технология JSSP.pdf
Binary file not shown.
Binary file not shown.
23 changes: 11 additions & 12 deletions dest/ramus-setup.nsi
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ Var javawPath

# Installer languages
!insertmacro MUI_LANGUAGE English
!insertmacro MUI_LANGUAGE Russian
!insertmacro MUI_LANGUAGE Ukrainian
;!insertmacro MUI_LANGUAGE Russian
;!insertmacro MUI_LANGUAGE Ukrainian

; License Language
LicenseLangString MUILicense ${LANG_ENGLISH} "../LICENSE"
Expand Down Expand Up @@ -201,7 +201,7 @@ RmDir /r $INSTDIR
SetOverwrite on
File /r doc\*

SetOutPath "$INSTDIR\doc"
SetOutPath "$INSTDIR\lib"
SetOverwrite on
File /r full\lib\*

Expand All @@ -226,15 +226,14 @@ RmDir /r $INSTDIR
CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Ramus Web Navigator.lnk" "$javawPath" '-cp "$INSTDIR\bin\ramus-startup.jar" com.ramussoft.Startup --close-startup com.ramussoft.navigator.ProjectNavigator' "$INSTDIR\bin\navigator.ico" "0"



IntCmp $LANGUAGE ${LANG_UKRAINIAN} 0 nukr nukr
CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Èíñòðóêöèÿ ïîëüçîâàòåëÿ.lnk" '"$INSTDIR\doc\ru\Èíñòðóêöèÿ ïîëüçîâàòåëÿ.pdf"'
CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Òåõíîëîãèÿ JSSP.lnk" '"$INSTDIR\doc\ru\Òåõíîëîãèÿ JSSP.pdf"'
nukr:
IntCmp $LANGUAGE ${LANG_RUSSIAN} 0 nrus nrus
CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Èíñòðóêöèÿ ïîëüçîâàòåëÿ.lnk" '"$INSTDIR\doc\ru\Èíñòðóêöèÿ ïîëüçîâàòåëÿ.pdf"'
CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Òåõíîëîãèÿ JSSP.lnk" '"$INSTDIR\doc\ru\Òåõíîëîãèÿ JSSP.pdf"'
nrus:
;IntCmp $LANGUAGE ${LANG_UKRAINIAN} 0 nukr nukr
; CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Инструкция пользователя.lnk" '"$INSTDIR\doc\ru\Инструкция пользователя.pdf"'
; CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Технология JSSP.lnk" '"$INSTDIR\doc\ru\Технология JSSP.pdf"'
;nukr:
;IntCmp $LANGUAGE ${LANG_RUSSIAN} 0 nrus nrus
; CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Инструкция пользователя.lnk" '"$INSTDIR\doc\ru\Инструкция пользователя.pdf"'
; CreateShortcut "$SMPROGRAMS\$StartMenuGroup\Технология JSSP.lnk" '"$INSTDIR\doc\ru\Технология JSSP.pdf"'
;nrus:


WriteRegStr HKLM "Software\Classes\Ramusfile0" "" '"Ramus File"'
Expand Down
36 changes: 36 additions & 0 deletions idef0-common/src/main/resources/com/ramussoft/en/0.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head><body>
<H1 CLASS="western">Annotation</H1>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">Ramus is a software for
providing projects, where Business Process Analysis or (and)
Classification Systems are needed.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">Ramus supports function
modeling methodology IDEF0 and DFD, and has many additional features,
that can be useful for developers of management systems.
</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">Ramus lets to create
graphical models of business processes according to the rights of
IDEF0 syntax. Furthermore, Ramus lets to create classification
systems of different objects, and to use these objects with graphical
models.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">Ramus has flexible
features to create reports according to the graphical models and
according to the classification systems. These features let to create
a documentation, which specifies an organization activities. For
example: a process and a duty regulation. Herewith, as the
documentation is automatically generated from the graphical models,
the documentation will be solid, consistent and systematical. It is
critically important for building a quality management systems of an
organization.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">It is very important,
that Ramus lets to provide an information throw a web interface. This
feature simplifies communication between developers of the management
systems.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">Ramus uses a management
terminology of a process approach. This instruction gives definitions
of main terms of the terminology, but it is recommend to meet with
others issues, that are relative to this topic. To work with
graphical models, knowledge of function modeling methodology IDEF0 is
needed too [1].</P>
</body></html>
38 changes: 38 additions & 0 deletions idef0-common/src/main/resources/com/ramussoft/en/1.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head><body>
<H1 CLASS="western" STYLE="page-break-before: always">1. Beginning of
work</H1>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">Just after a start of
the application, “Ramus File Launcher” window will be shown. In
this window you can choose “Create New File” item to create a new
file. In this window you can choose “Open File” item to open
already existing file. It is important to notice, that you can also
open any file later. In the window, you can select “Use this as
default and do not ask again” item, if you want the application
automatically opens or creates a file next time you will start the
application.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">If you choose “Create
New File” item, the application shows a master of creation a new
project. You can close the master and fill all needed information
later, but it is highly recommend to do all steps of creation a new
project. If you decided to use the master of a project, then:</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">On the first step, fill
an information about an author, a project name and a model name, and
select a type of notation: IDEF0 or DFD.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">On the second step, fill
an organization name, where the project is provided.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">On the third step, you
can give a short definition of the project.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">On the forth step, you
can create a few main qualifiers, for example: documents, roles,
etc... You can live all these fields empty and create any qualifiers
later.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">On the fifth step, if
you fill any fields on the forth step, you can set qualifiers, that
will be used as owners on IDEF0 models. You can select qualifiers,
which will be used as owners later.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">To finish work of the
master, press Finish button and the application will open a workspace
Diagrams, where you can start editing a context diagram[1].</P>
</body></html>
25 changes: 25 additions & 0 deletions idef0-common/src/main/resources/com/ramussoft/en/2.1.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head><body>
<H2 CLASS="western">2.1. File menu</H2>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">File menu contains
commands, many of these commands can be executed with a tool bar too.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>New project”</B>
is a command to create a new project. This command is available on
the tool bar, too.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Open”</B> is a
command to create an existing project. This command is available on
the tool bar, too.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Save”</B> is a
command to save current project.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Save As”</B> is
a command to save current project and specify a name of the file
where you want to store project.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Open in new
window”</B> is a command to open a new window, where you can work
with current project. The command can be useful if you work with two
monitors, for example. There is no File menu, in a new window.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Exit”</B> is a
command to close current project. If the project is changed, Ramus
will ask you for saving changes to a file.</P>
</body></html>
11 changes: 11 additions & 0 deletions idef0-common/src/main/resources/com/ramussoft/en/2.2.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head><body>
<H2 CLASS="western">2.2. Edit menu</H2>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Undo”</B> is a
command to undo last done action. This command is available on the
tool bar, too.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Redo”</B> is a
command to redo last undone action. This command is available on the
tool bar, too.</P>
</body></html>
102 changes: 102 additions & 0 deletions idef0-common/src/main/resources/com/ramussoft/en/2.3.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head><body>
<H2 CLASS="western">2.3. Diagram menu</H2>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Page setup”</B>
is a command to open a dialog, where you can setup page printing.
This command is available on the tool bar, too.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Page preview”</B>
is a command to open a dialog, where you can see sketches of pages
that will be printed. This command is available on the tool bar, too.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Print”</B> is a
command to open a dialog where you can select a printer and other
parameters that are needed to print diagrams or pages from project
navigator. This command is available on the tool bar, too.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Cursor Tool”</B>
is a main tool for working with diagrams. This tool lets you to make
manipulations with objects of the diagrams: to move, to change a
size, to connect and to disconnect arrows to activity boxes, borders
or other arrows. Cursor Tool can be selected by pressing “Z”
button, clicking a right mouse button on any empty place on a diagram
or by pressing a relevant button on the tool bar.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Activity Box Tool”</B>
is a tool for creating activity boxes on diagrams. To create a new
activity box, select Activity Box Tool and click the left mouse
button on the diagram. Activity Box Tool can be selected by pressing
“X” button or by pressing a relevant button on the tool bar.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Arrow Tool”</B>
is a tool for creating arrows on diagrams. Arrow Tool can be selected
by pressing “C” button or by pressing a relevant button on the
tool bar.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Squiggle Tool”</B>
is a tool for creating squiggles on diagrams. The squiggles show a
connection between an arrow and its inscription. To create a new
squiggle, select Squiggle Tool and click the left mouse button on an
arrow. To remove squiggle, click right button on the arrow and
disable selection of Squiggle command. Squiggle Tool can be selected
by pressing “V” button or by pressing a relevant button on the
tool bar.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Text Tool”</B>
is a tool for creating text labels on diagrams. Text Tool can be
selected by pressing “B” button or by pressing a relevant button
on the tool bar.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>External Reference
Tool”</B> is a tool for creating external references on DFD
diagrams. External Reference Tool can be selected by pressing a
relevant button on the tool bar. The tool available only for DFD
diagrams.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Data Store Tool”</B>
is a tool for creating data stores on DFD diagrams. Data Store Tool
can be selected by pressing a relevant button on the tool bar. The
tool available only for DFD diagrams.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Net”</B> is a
command to show net on diagrams. Net can be selected by pressing “N”
button or by pressing a relevant button on the tool bar.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Go to Parent
Diagram”</B> is a command to change an active diagram by its parent
diagram (see methodology IDEF0 [1]). The command can be selected by
pressing a relevant button on the tool bar. An other way to go to the
parent diagram is to press Ctrl button on the keyboard and click the
left mouse button on an empty place in the diagram.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Go to Child
Diagram”</B> is a command to change an active diagram by its
decomposition diagrams (see methodology IDEF0 [1]). To go on
decomposition diagram select an activity box first, if the activity
box does not have a decomposition, the application will ask you for
creating a new diagram. The command can be selected by pressing a
relevant button on the tool bar. An other way to go to the
decomposition diagram is to press Ctrl button on the keyboard and to
click the left mouse button on the activity box on diagram.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Center All Arrows”</B>
is a command to center all arrows on an active diagram comparatively
to all activity boxes.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Load model(s) from
file”</B> is a command to attach a graphical model or models from
an other file. This command opens an Open file dialog, ofter opening
a file, an other window will be opened, where you should select a
models, which will be added to the current project. If an “Import
all qualifiers” item will be selected, all qualifiers will be added
to the current project, independently of their usage on the graphical
model or models.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Model properties”</B>
is a command to open a dialog, where you can setup current graphical
model. On the dialog you can set a list of attributes for diagram's
activity boxes, set an order of the attributes, set an attribute,
which will be used as an activity box's names, change project name,
project author, organization name where the model is used, change a
short definition of the model. The dialog can be opened from pop-up
menu on the top of an active diagram, too.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Diagram
properties”</B> is a command to open a dialog where you can setup
an active graphical diagram. You can set an author, a creating date,
a revision date, a status of the diagram. The dialog can be opened
from a pop-up menu on the top of the active diagram, too.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Export to images”</B>
is a command to export a current model to images.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Export to IDL”</B>
is a command to export a current model to an IDL file. This file can
be opened by others similar applications.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Import from IDL”</B>
is a command to import model from IDL file. This file can be created
by others similar applications.</P>
</body></html>
14 changes: 14 additions & 0 deletions idef0-common/src/main/resources/com/ramussoft/en/2.4.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head><body>
<H2 CLASS="western">2.4. Windows menu</H2>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Show window”</B>
is a group to show a static window. Such windows as elements or
diagram editors are not present in the group. To show many windows,
it is more preferred to change active workspace.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Workspace”</B>
is a group of available workspaces. You can also switch a workspace
by pressing a button on a right top corner of the main window.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Look And Feel”</B>
is a group of switch a look of the application.</P>
</body></html>
55 changes: 55 additions & 0 deletions idef0-common/src/main/resources/com/ramussoft/en/2.5.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head><body>
<H2 CLASS="western">2.5. Tools menu</H2>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Open current
project in a web browser”</B> is a command to start a web browser,
where you can work with a web interface of the application. How to
work with a project in a web browser will be explained below.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Add Diagram
Template”</B> is a command to save a current diagram as a template,
which can be used later to create a new diagram with similar
structure. The command opens a dialog where you should set a name of
the template.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Diagram Templates”</B>
is a command to open a dialog where you can edit already saved
templates.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Project
preferences”</B> is a command to open a dialog where you an set
different preferences of a current project. This dialog contains
preferences:</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">On a tab “Spelling”
you can enable or disable spell checking and set a language of a
project.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">On a tab “Auto add
attributes” you can set a list of attributes, which will be present
in just created qualifiers. On this tab you can also set a text
attribute, which will be used as a default name of an element.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">On a tab “Owner
qualifiers” you can find a list of qualifiers, which can be used
as owners of processes.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Application
preferences”</B> is a command to open a dialog, where you can set
different preferences of the application. The dialog has tabs.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">There are three check
boxes on a tab “Main preferences”.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">If a box “Save
application in the memory” is checked, then application will be
started much more faster second and next times throw one session of
an operation system, but the application will take some memory all
the time, even if no files are open.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">If a box “Show startup
launcher” is checked, then, just before a start of the application,
a dialog will be shown where you can setup an automatic open of some
file, or open last opened files.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">If a box “Check for
updates” is checked, then sometimes the application will connect to
the site <A HREF="http://ramussoft.co.cc/">http://ramussoft.co.cc/</A>
and will check for the application's updates. If a new update is
available, then a dialog with update message will be shown. The box
is not present in corporate and in client versions of the
application.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in">On a tab “Model view
properties” you can set a default look of IDEF0 and DFD objects
(colors and fonts).</P>
</body></html>
15 changes: 15 additions & 0 deletions idef0-common/src/main/resources/com/ramussoft/en/2.6.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head><body>
<H2 CLASS="western">2.6. Help menu</H2>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Help Contents”</B>
is a command to open this help contents.</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>About...”</B> is
a command to open a dialog with main summery of the application (its
authors, etc...).</P>
<P ALIGN=JUSTIFY STYLE="text-indent: 0.38in"><B>Register this copy
of the application”</B> is a command to open a dialog where you can
enter a registered name and a serial number of your copy of the
application. The command is not available in corporate and in client
versions of the application.</P>
</body></html>
Loading

0 comments on commit 66b14dc

Please sign in to comment.