Dbpedia History

dump/src/test/scala/org/dbpedia/extraction/dump/ExtractionTestAbstract.md

@@ -3,14 +3,26 @@
 designed for testing abstracts extractors
 ## Before all
 
-* Delete tag @DoNotDiscover of ExtractionTestAbstract
-* add the tag @DoNotDiscover to other test class
+* Delete tag `@DoNotDiscover` of `ExtractionTestAbstract`
+* add tag `@DoNotDiscover` to other test class
 
-## Procedure :
+## Procedure
 1. Clean your target directory with `mvn clean` in the root directory of DIEF
-1. Go to bash scripts via `cd /dump/src/test/bash`
-1. OPTIONAL: Create a new Wikipedia minidump sample with `bash create_custom_sample.sh -n $numberOfPage -l $lang -d $optionalDate`
-1. Process sample of Wikipedia pages `bash Minidump_custom_sample.sh -f $filename/lst`
+1. Go to bash scripts via
+   ```shell
+   cd /dump/src/test/bash
+   ```
+1. OPTIONAL: Create a new Wikipedia minidump sample with
+   ```shell
+   bash create_custom_sample.sh -n $numberOfPage -l $lang -d $optionalDate
+   ```
+1. Process sample of Wikipedia pages
+   ```shell
+   bash Minidump_custom_sample.sh -f $filename/lst
+   ```
 1. Update the extraction language parameter for your minidump sample in [`extraction.nif.abstracts.properties`](https://github.com/datalogism/extraction-framework/blob/gsoc-celian/dump/src/test/resources/extraction-configs/extraction.nif.abstracts.properties) and in [`extraction.plain.abstracts.properties`](https://github.com/datalogism/extraction-framework/blob/gsoc-celian/dump/src/test/resources/extraction-configs/extraction.plain.abstracts.properties)
 1. Change the name of your log in the [`ExtractionTestAbstract.scala`](https://github.com/datalogism/extraction-framework/blob/gsoc-celian/dump/src/test/scala/org/dbpedia/extraction/dump/ExtractionTestAbstract.scala) file
-1. Rebuild the app with `mvn install`, or just test it with `mvn test -Dtest="ExtractionTestAbstract2"`
+1. Rebuild the app with `mvn install`, or just test it with
+   ```shell
+   mvn test -Dtest="ExtractionTestAbstract2"
+   ```

history/ReadMe.md

@@ -5,7 +5,7 @@ DBpedia History enables the history of a Wikipedia chapter to be extracted into
 
 ## Previous work
 
-This DBpedia App is a scala/java version of the first work conducted by the French Chapter : https://github.com/dbpedia/Historic/ 
+This DBpedia App is a Scala/Java version of the first work conducted by the French Chapter, <https://github.com/dbpedia/Historic/>.
 
 Fabien Gandon, Raphael Boyer, Olivier Corby, Alexandre Monnin. Wikipedia editing history in DBpedia: extracting and publishing the encyclopedia editing activity as linked data. IEEE/WIC/ACM International Joint Conference on Web Intelligence (WI' 16), Oct 2016, Omaha, United States. <hal-01359575>
 https://hal.inria.fr/hal-01359575
@@ -15,26 +15,26 @@ https://hal.inria.fr/hal-01359583
 
 ## A first working prototype
 
-This prototype is not optimized, during its development of it we were faced with the WikiPage type checking constraints that are checked in almost every module of the DBpedia pipeline.
-We hardly copy/paste and renamed all the classes and objects we needed for running the extractors.
-This conception could be easily improved by making WikiPage and WikiPageWithRevision objects inherit from the same abstract object.
-But as a first step, we wanted to touch the less possible DBpedia core module.
+This prototype is not optimized. During its development, we were faced with the WikiPage type-checking constraints that are checked in almost every module of the DBpedia pipeline.
+We basically copy/pasted and renamed all the classes and objects we needed for running the extractors.
+This conception could be easily improved by making `WikiPage` and `WikiPageWithRevision` objects inherit from the same abstract object.
+But as a first step, we didn't want to impact the core module.
 
-Some other improvements that could be conducted:
+Some other improvements that could be made:
 * Scala version
-* Being able to use a historic namespace taking into account the DBpedia chapter language
-* Being able to follow if a revision impacts an infobox content
+* Enabling use of a historic namespace, taking into account the DBpedia chapter language
+* Enabling following when a revision impacts content of an `infobox`
 
 ## Main Class
 
-* [WikipediaDumpParserHistory.java](src/main/java/org/dbpedia/extraction/sources/WikipediaDumpParserHistory.java) : for parsing of the history dumps
-* [RevisionNode.scala](src/main/scala/org/dbpedia/extraction/wikiparser/RevisionNode.scala)  : define revision node object
-* [WikiPageWithRevision](src/main/scala/org/dbpedia/extraction/wikiparser/WikiPageWithRevisions.scala) : define wikipage with revision list object 
+* [WikipediaDumpParserHistory.java](src/main/java/org/dbpedia/extraction/sources/WikipediaDumpParserHistory.java) — for parsing the history dumps
+* [RevisionNode.scala](src/main/scala/org/dbpedia/extraction/wikiparser/RevisionNode.scala) — define revision of node object
+* [WikiPageWithRevision](src/main/scala/org/dbpedia/extraction/wikiparser/WikiPageWithRevisions.scala) — define `wikipage` with revision list object 
 
 ## Extractors 
 
-* [HistoryPageExtractor.scala](src/main/scala/org/dbpedia/extraction/mappings/HistoryPageExtractor.scala): Extract all the revision of every wikipedia pages
-* [HistoryStatsExtractor.scala](src/main/scala/org/dbpedia/extraction/mappings/HistoryStatsExtractor.scala) : Extract statistics about the revision activity for every page of Wikipedia
+* [HistoryPageExtractor.scala](src/main/scala/org/dbpedia/extraction/mappings/HistoryPageExtractor.scala) — Extract all revisions of every Wikipedia page
+* [HistoryStatsExtractor.scala](src/main/scala/org/dbpedia/extraction/mappings/HistoryStatsExtractor.scala) — Extract statistics about revision activity for every page of Wikipedia
 
 ## How to run it ? 
 
@@ -48,4 +48,4 @@ Some other improvements that could be conducted:
 * configure the [extraction.properties](extraction.properties) file
 * and run  ```../run run extraction.properties```
 
-* Test it with : mvn test (need to have a containing file frwiki-[YYYYMMDD]-download-complete empty flag file into the base-dir defined into the extraction-properties file )
+* Test it with `mvn test` (need to have a containing file, `frwiki-[YYYYMMDD]-download-complete` empty flag file into the `base-dir` defined into the `extraction-properties` file)

history/src/main/scala/org/dbpedia/extraction/dump/extract/ConfigLoader2.scala

@@ -280,7 +280,7 @@ class ConfigLoader2(config: Config2)
   /**
    * Loads the configuration and creates extraction jobs for all configured languages.
    *
-   * @return Non-strict Traversable over all configured extraction jobs i.e. an extractions job will not be created until it is explicitly requested.
+   * @return Non-strict Traversable over all configured extraction jobs, i.e., an extraction job will not be created until it is explicitly requested.
    */
   def getExtractionJobs: Traversable[ExtractionJob2] =
   {

history/src/main/scala/org/dbpedia/extraction/dump/extract/ExtractionJob2.scala

@@ -14,7 +14,7 @@ import org.dbpedia.extraction.wikiparser.{Namespace, WikiPage, WikiPageWithRevis
   * @param source The extraction source
   * @param namespaces Only extract pages in these namespaces
   * @param destination The extraction destination. Will be closed after the extraction has been finished.
-  * @param language the language of this extraction.
+  * @param language The language of this extraction.
   */
 class ExtractionJob2(
                       extractor: WikiPageWithRevisionsExtractor,
@@ -44,7 +44,7 @@ class ExtractionJob2(
         println(graph.toString())
         destination.write(graph)
       }
-      //if the internal extraction process of this extractor yielded extraction records (e.g. non critical errors etc.), those will be forwarded to the ExtractionRecorder, else a new record is produced
+      //if the internal extraction process of this extractor yielded extraction records (e.g., non-critical errors, etc.), those will be forwarded to the ExtractionRecorder; else, a new record is produced
       val records = page.getExtractionRecords() match{
         case seq :Seq[RecordEntry2[WikiPageWithRevisions]] if seq.nonEmpty => seq
         case _ => Seq(new RecordEntry2[WikiPageWithRevisions](page, page.uri, RecordSeverity.Info, page.title.language))