Skip to content

Commit

Permalink
LEOS Prototype v3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@kaushikvijay
kaushikvijay committed Jul 7, 2018
1 parent b12f1a3 commit de246ef
Show file tree
Hide file tree
Showing 10,662 changed files with 116,249 additions and 325,699 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
4 changes: 4 additions & 0 deletions .mvn/jvm.config
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
-Xms256m
-Xmx512m
-XX:MaxPermSize=256m
-Djava.awt.headless=true
1 change: 1 addition & 0 deletions .mvn/maven.config
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
-V
2 changes: 1 addition & 1 deletion NOTICE.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2015 European Commission
Copyright 2016 European Commission

Licensed under the EUPL, Version 1.1 or – as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence");
You may not use this work except in compliance with the Licence.
Expand Down
23 changes: 18 additions & 5 deletions README.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
PROJECT: LEOS
Joinup Release: 2.0.0-SNAPSHOT
Date: 2015-11-20
Joinup Release: 3.0.0-SNAPSHOT
Date: 2016-06-17

INTRODUCTION
============
Expand All @@ -21,8 +21,7 @@ DEPENDENCIES
============

To compile the supplied source files and run the generated WAR the following software should be configured:
* Java SDK version 7+
(Java 8 is recommended due to better memory performance)
* Java SDK version 8.0
* Maven version 3.0.5+
(Maven runtime memory might need to be set: MAVEN_OPTS=-Xms256m -Xmx512m)
(Maven settings, proxy and mirrors, might need to be adjusted to your environment and internet access requirements)
Expand Down Expand Up @@ -109,7 +108,7 @@ Note: database and repository must already be running.

You must run LEOS on the command line.

1) Traverse to folder {LEOS}\modules\web
1) Traverse to folder {LEOS}\modules\web-os
2) Execute the following command:
mvn jetty:run-war

Expand All @@ -123,6 +122,20 @@ There might be bugs or incomplete features present in this version as it is a pr
CHANGE LOG
==========

3.0.0 (Prototype)
-----------------
* Updated HOWTO documentation
* Document Viewer
- Document changes pane
- Version selector
- Change markers
- Change navigation
* Editor
- New inline edition
- Improved user comments
* Updated dependencies (frameworks and libraries)
* Technical improvements, updated module structure and bug fixes

2.0.0 (Prototype)
-----------------
* New HOWTO documentation
Expand Down
38 changes: 24 additions & 14 deletions docs/HOWTO/00_Index.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,36 @@

DOCUMENT VIEWER
--------------------------------------------------------------------------------
8. Edit document
8a.Edit Citations
08. Document viewer
- refer to Document Viewer HOWTO
09. Edit table of contents
- refer to Table of Content HOWTO
10. Document changes Pane
- refer to Document Changes Pane HOWTO
11. Edit document
11a.Edit Citations
- refer to CITATION EDITION in Leos Editor HOWTO
8b. Edit Recitals
11b. Edit Recitals
- refer to RECITAL EDITION in Leos Editor HOWTO
8c. Edit Articles
11c. Edit Articles
- refer to ARTICLE EDITION in Leos Editor HOWTO
9. Insert and delete Articles
12. Insert and delete Articles
- refer to Articles HOWTO
10. Preview document as HTML/PDF
13. Preview document as HTML/PDF
- refer to Preview document HOWTO
11. Compare two versions
- refer to Compare two versions HOWTO
12. Edit metadata
14. Edit metadata
- refer to Edit metadata HOWTO
13. Edit table of contents
- refer to Table of Content HOWTO
14. Collaborative editing
15. Compare two versions
- refer to Compare two versions HOWTO
16. Collaborative editing
- refer to Collaborative editing HOWTO

COMMENTS VIEWER
--------------------------------------------------------------------------------
15. Insert, edit and delete comments
- refer to Comments viewer HOWTO
17. Insert, edit and delete comments
- refer to Comments viewer HOWTO

MISCELLANEOUS
--------------------------------------------------------------------------------
18. User Roles
- refer to User Roles HOWTO
24 changes: 24 additions & 0 deletions docs/HOWTO/08_Document_Viewer.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
DOCUMENT VIEWER - HOWTO
--------------------------------------------------------------------------------

1. Document Viewer is the main screen of the system through which a user can
draft a legislative document. It contains several tools to facilitate easy
editing.

2. Document viewer is divided into two sections. The top section consists of
document title and menu. Menu bar contains following buttons -
Close - closes the document.
Metadata - refer to Edit metadata HOWTO
Download - download the LEG format file(disabled)
Settings - configuration of document viewer columns
Locks - allows user to release his acquired locks
Development features - allows downloading of akomaNtoso xml file.

3. Lower section of the viewer is divided into columns. By default, first column
is the document pane and the other column consists of table of content.
The document pane is further divided into document toolbar and document
content.

4. Document toolbar provides quick links to document level features.

5. Document content is main area in which a user can do content drafting.
184 changes: 0 additions & 184 deletions docs/HOWTO/08_Leos_editor.txt
View file

This file was deleted.

33 changes: 33 additions & 0 deletions docs/HOWTO/09_Document_Table_of_Content.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
TABLE OF CONTENT - HOWTO
--------------------------------------------------------------------------------

1. By Default, document viewer is divided into two columns. Left-hand side is
document area and right-hand side is table of content. The table of content
is a tree consists of hierarchical structure of the document.

2. The tool-bar of the table of content consists of three buttons -
- The expand/collapse button to expand or collapse the tree.
- The edit button to edit the tree structure.
- The refresh button to refresh the table of content.

3. To edit the table of content, click on the icon with label 'Edit'. A dialog
will open with title 'Edit table of content'.

4. The dialog is divided into 3 parts, left-hand side is the table of content
displays the document tree, right-hand side consists of the elements that
can be added to the tree using 'drag n drop' and the bottom area consists of
meta-data of the selected element in the tree.

5. The meta-data section consists of three fields: Type, Number and Heading.
The 'Heading' field is editable and the rest are read-only. On selection of
an element from the table of content, these fields are populated. A 'Delete'
button is also provided to delete an element from the tree if possible.

6. New elements can be added to the tree from the right-hand side column using
'drag n drop'.This feature is bounded by the rules of the document structure,
so the elements can only be added at a valid level in the hierarchy.

7. After the edition, click on the 'Save' button to save the changes. To close
the dialog click on 'Close', the dialog will be closed and the changes will
be reflected in the Table of Content and document.

29 changes: 29 additions & 0 deletions docs/HOWTO/10_Document_Changes_Pane.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
DOCUMENT CHANGES - HOWTO
--------------------------------------------------------------------------------

1. An additional column can be enabled in document viewer by clicking on
Menu Bar> Setting menu> "Change ON". On enabling via sub menu, a column
appears on left side of document viewer called changes pane. The changes
pane contains a tool-bar and document content with highlighted changes.

2. The tool-bar of the changes pane consists of following -
- A popup button to select versions to compare.
- Navigation buttons to move to previous/next change
- Button to reset/hide the changes pane

3. On click of popup button, it opens a window which contains a slider and
a checkbox. Slider can be used to select versions to show changes between
two versions. If the checkbox is selected, it maintains second version at
latest available version.

4. When slider is moved and two different versions are selected, the content
reflects the changes between two versions. Removed content is marked with red
and added content is marked with green colour. Changes are also marked on the
scroll-bar.

5. Navigation Buttons on toolbar are for easy navigation between changes. Click
on 'Next' button scroll the content to next change. Changes can also be
navigated through the markers placed on scroll bar.

6. The right most button on toolbar, hides the changes pane which can be
restored by leftmost button on document area.
Loading

0 comments on commit de246ef

Please sign in to comment.