Changes between Version 29 and Version 30 of Harriot


Ignore:
Timestamp:
Jul 22, 2015, 3:11:26 PM (9 years ago)
Author:
Klaus Thoden
Comment:

Put most of the editing stuff on other page (HarriotWorkflow)

Legend:

Unmodified
Added
Removed
Modified
  • Harriot

    v29 v30  
    11[[PageOutline(1-4,,pullout)]]
     2[wiki:HarriotWorkflow Notes on the workflow]
     3
    24[wiki:HarriotConventions Conventions for editing]
    3 [wiki:HarriotWorkflow Notes on the workflow]
     5
    46= The Harriot online Project =
    57== Project info ==
     
    3840* [http://echo.mpiwg-berlin.mpg.de/ECHOdocuViewfull?url=/mpiwg/online/permanent/library/ND5A7WZT Harriot, Thomas, HMC 241 IX, The moon]
    3941* [http://echo.mpiwg-berlin.mpg.de/ECHOdocuViewfull?url=/mpiwg/online/permanent/library/1B0KX1PP Harriot, Thomas, HMC 241 add., Two folios found amongst the Harriot papers]
    40 == Subversion repository ==
    41 As of September 2012, the project's files are also part of the MPIWG-MPDL Content Project's repository ([source:/trunk/texts/Harriot link]). This will make updating the repository or local copies much easier. The respective branch can be checked out by directing a Subversion client to {{{https://it-dev.mpiwg-berlin.mpg.de/svn/mpdl-project-content/trunk/texts/Harriot}}}. The structure of the repository remains the same:
    42  * [source:/trunk/texts/Harriot/Maps Maps] contains schematic maps of how the folios might be structured thematically
    43  * [source:/trunk/texts/Harriot/Transcripts Transcripts] contains transcriptions in XML files
    44  * [source:/trunk/texts/Harriot/Documents Documents] contains miscellaneous documents, e. g. typing conventions
    45 
    46 == Versioned File Folders (deprecated as of September 2012) ==
    47 At the MPIWG, versioned file folders are used to store maps and transcriptions. Users can download the current version or any older version of a document. If they decide to work on a document, it is recommended to download and lock the respective file so that no other user can work on it in the meantime.
    48  * [http://pythia.mpiwg-berlin.mpg.de/department1/harriotOnline/maps Maps] contains schematic maps of how the folios might be structured thematically
    49  * [http://pythia.mpiwg-berlin.mpg.de/department1/harriotOnline/transcripts Transcripts] contains transcriptions in XML files
    50  * [http://pythia.mpiwg-berlin.mpg.de/department1/harriotOnline/documents Documents] contains miscellaneous documents, e. g. typing conventions
    5142
    5243== Maps ==
    53 The maps are edited with the free (but not open source) editor [http://www.yworks.com/en/products_yed_about.html yEd]. The symbols for the maps are stored in palette (attached to this page), which makes sure that the right symbols are used.
    54 
    55 === Purpose of the maps ===
    5644The present order of the pages in the folios is not correct. The maps serve as a secondary way to group the pages according to topics and to virtually connect pages that belong to the same subject.
    5745
    58 === Export to interactive maps ===
    59 There is also an experimental representation of the maps as an RDF graph ([http://euler.mpiwg-berlin.mpg.de/LodLive/?http://example.org/harriotOnt/HarriotGraph Enter here]). As of now, it is only accessible inside the institute.
    60 
    61 The visualization is made with a tool called [http://blog.lodlive.it/ LodLive]), and it can also be queried by going to the [http://euler.mpiwg-berlin.mpg.de/LodLive/ query page]. Instructions how to use the tool are [https://it-dev.mpiwg-berlin.mpg.de/tracs/mpdl-project-content/raw-attachment/wiki/Harriot/using_lodlive.pdf attached to this page].
    62 
    63 A thorough documentation will soon be available on [http://intern.mpiwg-berlin.mpg.de/digitalhumanities/it-group-projects/harriot/dokumentation Drupal], you can see [https://it-dev.mpiwg-berlin.mpg.de/tracs/metadataprovider/browser/GraphML2RDF%20(PYTHON) the source code] for the conversion script as well as check it out from the Mercurial repository with the command
    64 
    65 {{{
    66 hg clone https://it-dev.mpiwg-berlin.mpg.de/hg/graphML2RDF
    67 }}}
    68 === Export to static maps ===
    69 The maps can be exported to html and a [http://echo.mpiwg-berlin.mpg.de/content/scientific_revolution/harriot/maps/0_TOPICS.pt webpage] exists that displays all the maps and can be browsed.
    70 
    71 Export from yEd has to be done manually for each map (there is no mass exporter), but the settings remain stable per session. The required steps are:
    72  1. Set the export directory (remains stable per session)
    73  1. Export as HTML-Imagemap with the following settings
    74   1. Clipping: Default (leave settings as they are)
    75   1. Image: Choose PNG and Antialiasing
    76   1. HTML: uncheck both boxes (open link in new window, export description as tooltip) and replace the existing template with the following code (adapted to ECHO's Zope environment):
    77 {{{
    78 <html metal:use-macro="here/main_template/macros/page">
    79 <head><title></title>
    80 <!-- insert date here -->
    81 <style type="text/css">
    82 .tooltip {
    83   font-size:10pt;
    84   background-color:#FFFFCC;
    85   border:1px solid black;
    86   padding:2px
    87 }
    88 </style>
    89 </head>
    90 <body>
    91 <span metal:fill-slot="body">
    92 <a target="_blank" href="./index.pt">Index of topics</a>&nbsp;&nbsp;&nbsp;<a target="_blank" href="./legendManuscripts.pt">Legend</a>
    93 
    94 ${DIAGRAM}
    95 </span>
    96 </body>
    97 </html>
    98 }}}
    99   1. The "Sources" section contains links to external sources, describing the persons (Wikipedia, DNB, VIAF &c). A little bit more code has to be kept in the page to make the little menu work that pops up when the name is being clicked:
    100 {{{
    101 <html metal:use-macro="here/main_template/macros/page">
    102   <head>
    103     <title>Empty Title</title>
    104 <!-- insert date here -->
    105   </head>
    106   <body>
    107     <span metal:fill-slot="body">
    108       <style type="text/css">
    109         #authorMenu {display:none
    110         position:absolute;
    111         z-index:200; /* always on top*/
    112         padding-left: 35px;
    113         margin-left: 100px;
    114         margin-top: 12em;
    115         width: 250px;
    116         border: 2px solid rgba(128, 128, 128, 0.5);
    117         border-style: ridge;
    118         border-radius: 10px;
    119         background: rgba(128, 128, 128, 0.5);
    120         <!-- background-color: #777; -->
    121         color: white;
    122         font-size: 0.95em;
    123         }
    124       </style>
    125       <script type="text/javascript">
    126         function showElement(layer){
    127         var myLayer = document.getElementById(layer);
    128         if(myLayer.style.display=="none"){
    129         myLayer.style.display="block";
    130         myLayer.backgroundPosition="top";
    131         } else {
    132         myLayer.style.display="none";
    133         }
    134         }
    135       </script>
    136       <a target="_blank" href="./index.pt">Index of topics</a>&nbsp;&nbsp;&nbsp;<a target="_blank" href="./legendManuscripts.pt">Legend</a>
    137       <!-- insert menu here -->
    138       ${DIAGRAM}
    139     </span>
    140   </body>
    141 </html>
    142 
    143 }}}
    144   1. Furthermore, a different script has to be executed on these maps. It also requires the persons maps to be exported apart from the others (but maybe it would not hurt to have the css and javascript snippets in the other maps as well)
    145   1. Tiling: Do not activate Tiling
    146  1. To export all the maps, it is best to open all the files, start to export the first one (thereby setting above settings) and close that one. After that the following key sequence can be used: {{{Cmd-E, Return, Return, Cmd-W}}}. This will export and close each map.
    147  1. The resulting html files have to be edited, because a link to another map (i. e. another graphml file) will retain the extension graphml in the source code. The python script [source:/trunk/schema/scripts/Harriot/html2pt.py html2pt] takes care of this replacement and renames the files to the extension {{{*.pt}}}. The script can be called in a loop {{{for i in *.html; do echo $i; python /Users/kthoden/XML-ECHO-SVN/trunk/schema/scripts/Harriot/html2pt.py $i;done}}} (adjust path).
    148  1. The persons maps also require another script, because so far the information about the external links is not included. Right now, it resides in the file [source:/trunk/texts/Harriot/Documents/persons.csv persons.csv] which is then evaluated by the script [source:/trunk/schema/scripts/Harriot/menuMaker.py menuMaker].
    149  1. The pt-files have to be copied to {{{tuxserve03:18021/echo_nav/echo_pages/content/scientific_revolution/harriot/maps}}}
    150 
    151 === Index of groups ===
    152 There is now also an index page, generated directly from the graphml-files. This is an alphabetical list of all the group headings. From inside the Maps directory, call the [source:/trunk/schema/scripts/Harriot/makeIndex.py makeIndex] script (at least Python 2.7 required) and copy the resulting {{{index.pt}}} also to {{{tuxserve03:18021/echo_nav/echo_pages/content/scientific_revolution/harriot/maps}}}.
    153 
    15446== Transcriptions ==
    155 Transcriptions are made directly in XML according to the ECHO schema ([wiki:echo-schema Documentation] (mostly German)). A beginner's guide will be online here soon. We also recommend the use of text editors that offer autocompletion in connection with the Schema which facilitates the editing. Attached is an XSD version of the schema which can be used while editing texts in Eclipse. To make it work properly, the following line has to be added to the {{{echo}}}-Tag at the top of the document:
     47Transcriptions are made directly in XML according to the ECHO schema ([wiki:echo-schema Documentation] (mostly German)). We also recommend the use of text editors that offer autocompletion in connection with the Schema which facilitates the editing. Attached is an XSD version of the schema which can be used while editing texts in Eclipse. To make it work properly, the following line has to be added to the {{{echo}}}-Tag at the top of the document:
    15648{{{
    15749xsi:schemaLocation="http://www.mpiwg-berlin.mpg.de/ns/echo/1.0/ harriot_xsd/echo.xsd "
     
    16052As for formulas, it possible to use LaTeX markup. There is a script that converts that code into MathML ([https://it-dev.mpiwg-berlin.mpg.de/svn/digitizing-tools/scripts/mathml/ link]).
    16153
    162 == Editing ==
    163 Scholars working on the Edition at the moment use either Emacs or XeMeL, an Eclipse-based XML editor with SVN client.
    164 
    165 === Upgrading XeMeL ===
    166 As of 2015, the repository uses Subversion 1.7 which means that also local working copies have to be upgraded (by issuing {{{svn upgrade}}} on the command line). But also existing copies of XeMeL would need to be updated. A new version is located at http://ocropus.mpiwg-berlin.mpg.de/~kthoden/XeMeL.zip. If you want to update the copy yourself, you need to download http://subclipse.tigris.org/files/documents/906/49280/site-1.8.22.zip and http://www.svnkit.com/org.tmatesoft.svn_1.7.14.src.zip and extracted in the root folder of XeMeL (so that things are written in the {{{plugins}}} directory and so on). Also, in the preferences of XeMeL, the correct SVN interface has to be chosen: SVNKit (PureJava).
    167 
    168 === Macros ===
    169 For both Eclipse and Emacs, a template has been created to quickly insert Commentaries and Translations. As this will later be fed into the annotation system, date and username are also inserted. Unfortunately, in Eclipse the date format is dependant on your machine's language settings. Both template files are in the SVN repository.