Differences

This shows you the differences between two versions of the page.

--- courses:cs335:spring2019:graffiti:documentation [2019/05/16 19:05] – [Map Display in the Search Results] stalnakert
+++ courses:cs335:spring2019:graffiti:documentation [2019/05/17 16:30] (current) – wenz
@@ Line 46: / Line 46: @@
 ==== Map Display in the Search Results ====
-Prior to our work on this project, both the maps for Herculaneum and Pompeii would be displayed for all search results.  This included a search result which yielded no graffiti.  No the map display on the right side of the screen changes dynamically as the user filters their search.  If results from Herculaneum are included in the hits, then that map is displayed.  The same is true for Pompeii.  If the only results are from Smyrna, then no maps are displayed.  Currently, the maps are stationary and do not shift up and down depending on which are displayed.  This could be changed in the future according to the client's wishes.
+Prior to our work on this project, both the maps for Herculaneum and Pompeii would be displayed for all search results.  This included a search result which yielded no graffiti.  No the map display on the right side of the screen changes dynamically as the user filters their search.  If results from Herculaneum are included in the hits, then that map is displayed.  The same is true for Pompeii.  If the only results are from Smyrna, then no maps are displayed.  Currently, the maps are stationary and do not shift up and down depending on which are displayed.  This could be changed in the future according to the client's wishes.  This feature functions because in the graffiti controller we pass a boolean attribute for each mapped city to the webpage, which tells it whether or not that city should be displayed.  The page then saves that into a hidden html field, which is then used by filterSearch.js to produce the desired results.
+==== Updates to the Header / Navigation Bar ====
+Previously, the header bar would collapse after the shrinking window size had already forced the search bar onto its own line.  This was not aesthetically pleasing, and was a bug that needed to be addressed.  By using css's @media property, I was able emulate bootstrap's method for collapsing navigation bars.  This solution achieved the desired result of collapsing the bar before the search bar was forced onto a new line.  However, the formatting is not identical to that of bootstrap's.  This isn't a huge deal in an average use case, but if a user resizes the window while the hamburger menu (the opened version of the collapsed nav-bar) is open, they could potentially see it change style.  This is because Bootstrap's defaults kick in when the window reaches a certain minimum width.
 ==== Loading Data into the Database Through EpiDocs ====
+Loading the data representing the Smyrna graffiti is as easy as clicking a button.  Simply open ReadFromEpidoc.java and run it as a java application.  In the terminal window, you will see output statements detailing the progress of the import.  If there were to be an issue, these outputs are a great resource for the user.  Under the hood, ReadFromEpidoc iterates through all of the files in the smyrna_epidocs directory and parses them.  As it parses it saves key information, such as the graffito's id or its findspot, and saves it in the database.  More specific information on parsing can be found here:  [[https://wlu.app.box.com/notes/191721659898 | EpiDoc Conventions]].  Once all of the new data has been loaded into the database, the user must then run AddInscriptionsToElasticSearch.java as a java application.  This will set up Elastic Search and enable the new graffiti to appear in search results.  With those simple steps, all the EpiDoc-ed graffiti should now be visible on the site.
+==== Updages to the Admin Tools: Ignore List Function ====
+The Ignore List Function (previously refered to as the "black list") has been fully implemented under the Admin Tools tab. In order to access this function, the user will need to first authenticate through the admin login page. The final use case is where the user is able to choose what items can be displayed in the index by simplying selecting items from the Ignore List page and perform corresponding actions. The page layouts shows three boxs (from left to right): items that should be displayed, items that are displayed but still require further review, and items that should be ignore and not displayed. User can move items between tables easily using the buttons implemented. There is also a search bar on top of each table that allow users to access items more easily.
+In order to load up the funciton, simply run modifyIgnoreList.jsp on the server. In order to check the database, use Professor Sprenkle's instruction to access the database on the servo. The JSP sends the query into the database to retrieve the items and sort them in alphabetical order.