Cloud-based Rapid Elastic MAnufacturing
WP2 – Project Management, Quality Assurance & Reporting
D2.5.1 State of the Art Wiki Setup
Deliverable Lead: DFKI
Contributing Partners: TUV, ASC
Delivery Date: 06/2015
Dissemination Level: Public
Version 1.1
This document describes the functional requirements, initial architecture, user interface, content structure and handling of the CREMA State of the Art (SotA) wiki. Both content and functionality of the CREMA CREMA SotA Wiki will be updated, when appropriate, in order to ensure that all CREMA partners are well aware of the latest methodologies and technologies in fields that are relevant for the research and development in CREMA. The CREMA CREMA SotA Wiki is publically available to enable interested parties to share and use its content. CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Document Status
Deliverable Lead Matthias Klusch (DFKI)
Internal Reviewer 1 Olena Skarlat (TUV)
Internal Reviewer 2 Tim Dellas (ASC)
Type Deliverable
Work Package WP2: Project Management, Quality Assurance & Reporting
ID D2.5.1: State of the Art Wiki Setup and Updates
Due Date 30.06.2015
Delivery Date 30.06.2015
Status For Review
Document History
V0.1, DFKI, 19.05.2015, Document initiation V0.2, DFKI, 11.06.2015, First draft Contributions V1.0, DFKI, 22.06.2015, Version for internal review V1.1, DFKI, TUV, ASC, 29.06.2015, Revised version for submission
Final Version V1.1
Note This deliverable is subject to final acceptance by the European Commission.
Disclaimer The views represented in this document only reflect the views of the authors and not the views of the European Union. The European Union is not liable for any use that may be made of the information contained in this document. Furthermore, the information is provided “as is” and no guarantee or warranty is given that the information is fit for any particular purpose. The user of the information uses it at its sole risk and liability.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 2 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Project Partners
DotNET IT, United Kingdom Ascora GmbH, Germany
Technology Application Network Limited, Technische Universität Wien, Austria United Kingdom
German Research Center for Artificial Intelligence, Germany IKERLAN S. Coop., Spain
Ubisense, United Kingdom Tenneco-Walker (U.K.) Limited, United Kingdom
FAGOR ARRESATE S. Coop., Spain Goizper, Spain
ICE, United Kingdom
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 3 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Executive Summary This deliverable describes the aim and functional requirements of the CREMA SotA Wiki, the comparative analysis of available wiki software, the final selection and customization of the wiki software that was required to implement a solution matching the requirements, as well as the initial state of this wiki with respect to its functionality and content. The CREMA SotA Wiki is intended to provide a common wiki-based source for sharing relevant information with interested parties on the state of the art in fields that are relevant for research and development in the project. For this purpose, the CREMA SotA Wiki content is hierarchically structured into topic categories. Each CREMA SotA Wiki topic page provides information about the topic in general, articles, software, and projects related to that topic. Except for project partners, any content contribution is pending approval by the central editor of the CREMA SotA Wiki. Navigation within the CREMA SotA Wiki can be done via its site tree, usage path, and keyword search. The CREMA SotA Wiki 1.0 has been implemented with the MediaWiki software that has been customized and extended by DFKI to meet all functional requirements upon which the project partners agreed for the CREMA SotA Wiki. The CREMA SotA Wiki was first made publicly available in June 2015 at the URL http://www.dfki.de/crema-sota-wiki, and is accessible from the CREMA project web page. Ongoing work on the CREMA SotA Wiki is concerned with an update of the initially provided content, as well as a refinement of the functions such as the basic search, the addition of an interactive tag cloud, and generation of tailored reports on the CREMA SotA Wiki usage statistics for internal reviewing. In general, the subsequent deliverables D2.5.2 at 12/2015 on the CREMA SotA Wiki version 2.0 and D2.5.3 at 06/2015 on the CREMA SotA Wiki version 3.0 will extend the CREMA SotA Wiki with further topics or deepen the existing topics. Thus, the CREMA project will possess an actual description of the state of the art at all times.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 4 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Table of Contents
1 Introduction ...... 7 CREMA Project Overview ...... 7 Deliverable Purpose, Scope and Context ...... 7 Document Status and Target Audience ...... 7 Abbreviations and Glossary ...... 8 Document Structure ...... 8 2 CREMA SotA Wiki Requirements ...... 9 General requirements ...... 9 Functional requirements ...... 9 2.2.1 CREMA SotA Wiki Content ...... 9 2.2.2 Contribution model ...... 10 2.2.3 Content Search and Usage Statistics ...... 11 Non-functional Requirements ...... 12 3 Wiki Software Analysis and Selection ...... 13 Zotero ...... 14 WordPress ...... 15 MediaWiki ...... 17 Summary ...... 20 4 CREMA SotA Wiki Implementation ...... 22 Overview ...... 22 Customization and Extension ...... 22 CREMA SotA Wiki Content: Structure and Status ...... 25 5 Using the CREMA SotA Wiki ...... 26 User Accounts ...... 26 Entry Points ...... 27 Search Functions ...... 28 Viewing of Topic Pages ...... 29 Contributions to CREMA SotA Wiki Content ...... 31 5.5.1 CKEditor...... 33 5.5.2 Adding and Changing References ...... 36 5.5.3 Creating Topic Pages ...... 38 6 Summary ...... 40 References ...... 42
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 5 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
List of Figures and Tables
List of Figures
Figure 1: The Zotero directory structure for topics of the Adventure project……………….14 Figure 2: Zotero displaying a note (SIMPLI-CITY project)……………………………………15 Figure 3: WordPress WYSIWYG editor and standard skin………………………………..…16 Figure 4: The WordPress Capability Manager……………………………………………..….16 Figure 5: Main page of the SAM SotA Wiki…………………………………………………....17 Figure 6: Output of the Cite extension in the SAM SotA Wiki……………………….…….…18 Figure 7: Tabbed view of article pages and talk pages in MediaWiki……………….……...18 Figure 8: Excerpt from the list recent changes to the CREMA SotA Wiki…………….……19 Figure 9: Histogram generated by StatMediWiki…………………………………………..….20 Figure 10: Skin and extensions used by the CREMA SotA Wiki (package diagram)…..…22 Figure 11: The CREMA skin next to the standard skin……………………………………….23 Figure 12: Tabbed view and entry form for references……………………………………….23 Figure 13: The same content in CKEditor and WikiEditor……………………………….…...24 Figure 14: The forms for log-in and account creation……………………………………...... 26 Figure 15: Entry points for accessing the wiki content…………………………………….....27 Figure 16: Result of a search for software and projects on “distributed computing”………28 Figure 17: The “General” tab of the topic page about Semantic Services………………….29 Figure 18: The “Projects” tab of the topic page about Cloud Manufacturing……………….30 Figure 19: Usage path (“breadcrumb trail”) on top of a topic page………………………….30 Figure 20: The approval workflow in the CREMA SotA Wiki…………………………………32 Figure 21: Confirmation page for deleting a topic page………………………………………33 Figure 22: Controls of CKEditor…………………………………………………………………33 Figure 23: The dialogue for inserting images ………………………………………………....34 Figure 24: Dialogue for placing a link…………………………………………………………..35 Figure 25: The citation dialogue………………………………………………………………...36 Figure 26: Editing references as wikitext……………………………………………………….37 Figure 27: Form for entering references………………………………………………………..38 Figure 28: Creating a topic page from the search result page…………………………….…39 Figure 29: Creation of a topic page………………………………………………………….….39 Figure 30: A field for entering a comment (currently disabled)………………………………40 Figure 31: Revision history of the topic page for semantic services………………………...41
List of Tables
Table 1: User roles and activities ...... 11 Table 2: Requirements met by the final selection of wiki applications ...... 21
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 6 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
1 Introduction CREMA – Cloud-based Rapid Elastic MAnufacturing – is a project funded by the Horizon 2020 Programme of the European Commission under Grant Agreement No. 637066. In the following, we describe the functional requirements of the CREMA State-of-the-Art (SotA) wiki upon which the project consortium agreed, the respective analysis and selection of appropriate wiki software and how it has been used to setup a CREMA SotA Wiki, as well as its current state, user manual, and ongoing work. Both content and functionality of the CREMA SotA Wiki will be updated, when appropriate, in order to ensure that all CREMA partners are well aware of the latest methodologies and technologies in fields that are relevant for the research and development in CREMA. The CREMA SotA Wiki is publically available to enable interested parties to share and use the content provided in it. CREMA Project Overview CREMA aims at simplifying the establishment, management, adaptation, and monitoring of dynamic, cross-organisational manufacturing processes following Cloud manufacturing principles. CREMA will also provide the means to integrate data from distributed locations as if the complete manufacturing was carried out on the same shop floor, by integrating extra- and inter-plant manufacturing assets and making them “mobile”. CREMA will be built upon concepts and methods from the fields of Virtual Factories, Service- oriented Computing, Ubiquitous Computing, CPS, the Internet of Things and the Internet of Services, and naturally and most importantly Cloud computing. To achieve its goals, the project will define tools and approaches in these areas: Manufacturing Virtualization & Interoperability Cloud Manufacturing Process and Optimisation Framework Cloud Manufacturing Collaboration, Knowledge and Stakeholder Interaction Framework Thus, to achieve its goals, CREMA conducts original research and applies technologies from the fields of full end-to-end integration of cloud manufacturing, integration of manufacturing assets and corresponding data sources, the design and execution of manufacturing processes, to AI and semantic technologies for intelligent process service coordination and optimisation, to the end user support via collaboration and interaction tools. For more information, please refer to the project Website at http://www.crema-project.eu/. Deliverable Purpose, Scope and Context This document describes the reasoning behind the setup and initiation of a particular way of dealing with the collection and provision of state of the art in CREMA. Document Status and Target Audience This document is listed in the description of action DoA (and in the grant agreement GA, Appendix 1, p.84) as “public”. The CREMA SotA Wiki allows keeping track with current developments and technologies that tackle similar challenges as CREMA does. Furthermore, the corresponding findings should be provided as well to an interested external audience, like researchers or practitioners active in the same domain. This deliverable is to be used by all
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 7 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup participating project members. It will help them to keep track of current methodologies and technologies that might be applied during the CREMA project. Furthermore, the CREMA SotA Wiki will provide external parties insights into the foundations and technologies that CREMA is based on and allows them to benefit and contribute to this wiki. Abbreviations and Glossary A glossary of common terms and roles related to the realisation of CREMA as well as a list of abbreviations is provided as an online glossary1 / abbreviations list2. Document Structure This deliverable is broken down into the following sections: Section 2 describes the main requirements for the implementation and set up of the CREMA SotA Wiki software, followed by in Section 3. The implementation of the wiki is briefly presented in Section 4, while its functionality for practical use is described in Section 5. We conclude the document in Section 6.
1 http://crema-project.eu/glossary 2 http://crema-project.eu/abbreviations Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 8 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
2 CREMA SotA Wiki Requirements The CREMA SotA Wiki is intended to enable people who are interested in the CREMA project to get informed and contribute knowledge on the state of the art in fields which are relevant for research and development carried out in the project. In particular, the CREMA SotA Wiki aims to serve the following purposes: Allow CREMA project partners (a) to collect, edit and share state of the art information and thoughts about it in their respective fields of expertise relevant for the project; and (b) to use this information as a basis for not only writing deliverables, technical reports, and scientific papers but for keeping up with and comment on relevant progress in research and development elsewhere. In this respect, the CREMA SotA Wiki exists not only as means to statically store information, but to allow the project partners to actively share and discuss relevant information for their research and development. General requirements The project partners agreed on the following set of general requirements of the CREMA SotA Wiki functionality and content. State of the art information in relevant fields shall be described and presented in a structured form, style and with media types similar to what many people are used to for this purpose in Wikipedia. In particular, any CREMA related topic shall be described in terms of summary information on this topic in general and its relation to CREMA, and a list of related articles, software and projects shall be included. The CREMA SotA Wiki does not implement a mere bibliographic library or repository with sources or copies of articles and software but shall only provide links to their external storage locations, if appropriate and legit. Contributors may comment on knowledge assets in the CREMA SotA Wiki (general info, links to articles, software, projects) like in Wikipedia. It should be possible to provide article abstracts as well as individual comments on articles. For reasons of quality control, all contributions to the CREMA SotA Wiki shall be regularly checked by a central editor with respect to relevance and appropriateness, and the links for validity. In the following, the functional and non-functional requirements of the CREMA SotA Wiki are described in more detail. The requirements are numbered from R1 to R14 for later reference. Functional requirements
2.2.1 CREMA SotA Wiki Content The CREMA SotA Wiki should contain the following types of content: References to scientific articles, software packages and research projects. The references should take the form of bibliographic data, hyperlinks and abstracts. All
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 9 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
bibliographic entries shall be provided by the contributors manually in plain text in Springer3 format for which an example entry shall be presented to the user. Summaries and descriptions written by the CREMA SotA Wiki users. Those are an introductory text about each topic covered by the CREMA SotA Wiki, possibly a glossary of terms and commentary on individual references and their relevance to CREMA. Comments pointing out errors or omissions, or expressing praise or criticism. That is, the CREMA SotA Wiki should contain references to prior work and original content. These two types of content have distinct needs: References should be entered and stored in a structured way, and the bibliographic data should be separated from the citation style. References to articles should be kept separate from references to software and projects respectively. The original content requires a rich-text editor with support for basic typography and embedded images. Moreover, authors need to be able to mix the two types of content by including references in the original content, for example, through footnotes. Summary: (R1) Reference management; (R2) Rich-text editing; (R3) User comments
2.2.2 Contribution model To encourage participation from interested researchers outside of CREMA, changes to the CREMA SotA Wiki should not be limited to project partners. In an open wiki, where everyone can contribute anonymously or under pseudonym, users cannot generally be trusted. Contributions by untrusted users may be malicious, or they may not meet the project’s quality standards or policies. One way to address this problem is to supervise the CREMA SotA Wiki closely and repair damage as it happens. This may be feasible for highly frequented wikis like Wikipedia. That said, the German Wikipedia project, for example, keeps changes pending until approved by trusted users.4 An approval process for the CREMA SotA Wiki is outlined in the following. Of the user roles listed in Table 1, authors, editors and admins are considered as trusted. These roles are exclusive to the project partners. The distinction between readers and contributors is not crucial. Contributions could presuppose the registration of a user account, but an account should not be necessary for viewing the CREMA SotA Wiki content. It is also conceivable to let all project partners approve untrusted contributions; then, the author role would be unnecessary. The role of an editor should be distinct from that of an admin for security reasons.
3 http://www.springer.com 4 “Wikipedia: FlaggedRevisions,” Feb 2015. [Online]. Available: https://en.wikipedia.org/wiki/Wikipedia:Flagged_revisions. [Accessed June 2015]. Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 10 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Table 1: User roles and activities
Reader Contributor Author Editor Admin Read Pages yes yes yes yes yes
Create Pages pending yes yes Edit Pages approval yes yes Approve Changes yes Manage Wiki yes Write Comments yes yes yes yes
Approval workflow. When an untrusted user submits a change to the CREMA SotA Wiki, the change should be immediately stored in the CREMA SotA Wiki, but remain invisible until approved by an editor. Editors should be notified about pending changes, or, at least, there should be a list of pending changes that the editors can check regularly. After reviewing a change, the editor may reject the change entirely, rewrite it, or approve it as it is. Ideally, the untrusted user should be able follow up on the approval process. When a user attempts to change content for which there is already a change pending, the user should arguably be able to see the pending change. This could avoid conflicting or redundant changes. Untrusted users should be able to publish comments without prior review. A comment is clearly attributed to a single user, and, thus, separate from the primary CREMA SotA Wiki content. Therefore, comments have less potential for damaging the CREMA SotA Wiki than changes to the primary content. Still, comments will have to be reviewed by the editors shortly after publication (say, within 24 hours), not least of all, for legal reasons. Since trusted user accounts could be compromised by malware on the client side, a revision control system is required in addition to the approval system. A revision control system maintains a log of changes (audit trail), and allows editors to revert changes. Summary: (R4) Revision control; (R5) Approval workflow
2.2.3 Content Search and Usage Statistics Search. The search index should include introductory texts, references and the associated abstracts and comments. Advanced search queries should allow excluding certain types of references (articles, projects or software). Other project SotA wikis have contained less than 500 references.5 6 7 For a bibliography of this size, sophisticated queries, such as a range of publication dates, are dispensable. Search results should distinguish references from introductory texts. More generally, the users should be able to navigate quickly between search results, introductory texts and references. For example, listing references below an introductory text is not ideal because
5 Adventure Wiki: http://www.fp7-adventure.eu/wiki/index.html 6 SIMPLI-CITY SotA: http://simpli-city.eu/sota/index.php 7 SAM Wiki: http://wiki.socialisingaroundmedia.com/ Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 11 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup a user who is interested solely in the references would have to scroll past the introductory text. A tabbed view that can switch between prose and references is preferable. The topics covered by the wiki lend themselves to a tree structure (see section 4.3). In addition to the (unstructured) search function, there should be a tree view of the topics that can be easily browsed by the user. In addition, another popular form of searching shall be offered by means of a linked tag cloud which should highlight popular and important content, whereas a list of recent changes allows regular users to keep up with changes. Alternatively, a system of subscriptions and update notifications would serve the same purpose. Usage statistics. Accesses to the CREMA SotA Wiki need to be tracked for quality control. The total number of visits to the CREMA SotA Wiki could always be obtained from the log files of the underlying web server. In addition to that, however, it is desirable to track the number of visits and changes per page over time, and to collect statistics aggregated per country (geolocation). Statistics should be collected in an anonymized way that respects the privacy of the users. Summary: (R6) Search; (R7) Tree view; (R8) Tag cloud; (R9) News; (R10) Statistics
Non-functional Requirements Writing custom software from scratch is infeasible given the scope of the functional requirements. A proprietary solution would have to be modestly priced and allow access to its source code. More specifically, the wiki software should be preferably available for free (and open-source) for professional use. In addition, the software has to be customizable and extensible. This tends to be the case when the architecture is plugin-based, when the design and implementation are well documented, and when there is support from an active community of developers (in the case of free software) or professional support (in the case of proprietary software). Security is a requirement for the core software off the shelf, but, to a lesser degree, also for any third-party extensions required by the CREMA, and extensions that are developed within CREMA. The core has to be mature – a beta version would pose a risk. As new exploits could be discovered over the course of the project, the software needs to be actively developed and easy to update. Passwords must not be stored in plain text. The volume of spam in an open wiki is difficult to gauge; the software should include anti-spam measures to be on the safe side. Usability. The wiki is not to be used exclusively by IT professionals; therefore, the user interface needs to be intuitive for users without much technical knowledge. Text editing should ideally happen in a WYSIWYG editor. Summary: (R11) Price; (R12) Extensibility; (R13) Security; (R14) Ease of use
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 12 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
3 Wiki Software Analysis and Selection Wikimatrix.org8 lists more than a hundred wiki applications. Only 16 of these are mature and have had a release within the last two years. Of these 16, six are aimed at individuals or small groups, and lack functions required for a public wiki. Four more, namely BoltWire, JSPWiki, LynxWiki, and MoinMoin, were ruled out because they offer no support for approval workflows. Early wikis have focused on quick and easy participation, and wikis with approval workflows are still rare. Wikipedia, for example, has only gradually implemented barriers on participation (including an approval system) [G10]. The candidates with approval workflow are Confluence9, DokuWiki10, Foswiki11, MediaWiki12, Tiki13 and XWiki14. Approval of contributions is more typical of general-purpose web content management systems (CMS). Most of these systems do not have sufficient revision control functions for a wiki, but it appears that WordPress15 could theoretically act as a wiki. None of the applications above have strong support for reference management. Dedicated reference management systems have been taken into consideration, but none were found that could function as a proper wiki. See section 3.1 for an exemplary discussion of one system (Zotero). Tiki prides itself to be “the Free/Libre/Open Source Web Application with the most built-in features”16, and the full name is “Tiki Wiki CMS Groupware”. The developer documentation concedes that the code “has been evolving organically”, that abstraction is used sparingly, and that the quality of the code and documentation varies17. This makes Tiki daunting to modify, and, despite a large number of (bundled) modules, some modifications seem inevitable. Interestingly, there is a module that integrates Tiki with Zotero. Confluence, DokuWiki, FosWiki, and XWiki strongly resemble MediaWiki. They were ruled out early in the analysis, mainly, because they lack substantial benefits over MediaWiki – that is, as far as the CREMA SotA Wiki is concerned. All things being equal, MediaWiki is a better choice because of its larger developer community and the familiarity to Wikipedia users. For a discussion of MediaWiki and WordPress, see sections 3.3 and 3.2. About Confluence and DokuWiki, there were also some specific concerns: Confluence is proprietary software, however, the source code is made available upon purchase. A commercial license can be obtained for 600 dollars a year, although this limits the number of user accounts to 25, meaning that external visitors could only contribute anonymously.
8 WikiMatrix: http://www.wikimatrix.org/ 9 Confluence, Atlassian: https://www.atlassian.com/software/confluence 10 DokuWiki: https://www.dokuwiki.org/ 11 Foswiki: http://www.foswiki.org/ 12 MediaWiki: https://www.mediawiki.org/ 13 Tiki Wiki CMS Groupware: http://info.tiki.org/ 14 XWiki Enterprise: http://www.xwiki.org/ 15 WordPress.com, Automatic: https://wordpress.com/ 16 Tiki Wiki CMS Groupware: http://info.tiki.org/ 17 Tiki developers' documentation: https://dev.tiki.org/Hello+World Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 13 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
DokuWiki has a lean application core, and relies heavily on plugins18. With its plugins, DokuWiki covers the CREMA requirements about as well as MediaWiki, however, the quality of some of the plugins is doubtful. In particular, the “Publish” plugin for approval workflows has serious unaddressed issues. (A re-implementation called “Approve” has only become available by mid of February 2015.) Moreover, the core development appears to hinge on a single person, which raises concerns about the sustained security of DokuWiki. Zotero Zotero is an open-source tool for managing bibliographic references19 among a group of researchers. References can be imported from BibTeX and various digital libraries, and exported in a configurable citation style, for example, to HTML. References can be tagged and arranged in a category tree (see Figure 1). It is possible to search for titles, authors and years of publication. Zotero offers pre-configured hosting for a negligible price. Two recent research projects have integrated Zotero into their SotA wikis: Adventure (2011 – 2014)20, and SIMPLI-CITY (since 2012, set to conclude this fall)21.
Figure 1: The Zotero directory structure for topics of the Adventure project
Zotero is primarily a repository for bibliographic references. Summaries and comments can be included in the form of notes (see Figure 2). However, a note in Zotero cannot take the important role of an introduction to a topic. When a topic is selected from the directory tree, any notes are listed merely in alphabetic order along with the associated references. There is no referable summary text on the selected topic, and no complementary and structured information on articles, projects and software. That appears to be quite inconvenient for getting quickly informed and collaboratively writing
18 Some wikis use the term “plugin”, others use “extension”. As each wiki is described, this document switches between the two terms in order to match the terminology of the respective wiki. 19 Zotero: https://www.zotero.org/ 20 Adventure Wiki: http://www.fp7-adventure.eu/wiki/index.html 21 SIMPLI-CITY SotA: http://simpli-city.eu/sota/index.php Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 14 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup about the topic in a general way like users know from, for example, Wikipedia for knowledge sharing. In addition, these notes do not have revision histories. That is, a user can change a note created by another user, but the change is not attributed to the first user and cannot be reverted. As mentioned above, the following two projects are using Zotero as follows: Apart from the bibliography, the SIMPLI-CITY wiki contains one introductory text per category. The texts are stored as notes within Zotero, and a nightly HTML export generates a webpage for each category [TUD13]. The introduction texts appear on the top of the page, followed by the references. The collaboration takes place exclusively within the Zotero group; the wiki webpage itself is non-interactive. Knowledge sharing in the style of Wikipedia is quite limited. Adventure uses a lightweight custom-made wiki for a glossary and internal discussions alongside a web export of Zotero bibliography. That is, the bibliography is not intertwined with any original content, and the glossary does not refer to the bibliography. The project partners had to be familiar with both Zotero and the custom wiki, and maintain user accounts for both.
Figure 2: Zotero displaying a note (SIMPLI-CITY project)
Both projects have drawn favourable conclusions about Zotero [Bur14] [Man13]. Pros: Reference management, search functions Cons: Collaborative editing, revision control, approval workflow, statistics WordPress WordPress is a web CMS that places special importance on the ease of use. WordPress is used by millions of websites, especially as a blogging system [Coa12]. In particular, the CREMA project page is based on WordPress. The usability is not necessarily better than that of MediaWiki and similar wiki software, but it is closer to the requirements of the CREMA SotA Wiki. In particular, a WYSIWYG editor is part of the core package (see Figure 3). The
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 15 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup desired approval workflow can be realized through a plugin called “Revisionary”, which appears to be well maintained and stable. The core program gathers statistics per country. There is an outdated plugin called “Enhanced BibliPlug” that adds a repository for bibliographic references to WordPress22. The plugin also has a function for synchronizing the repository with a Zotero group. It is difficult to estimate how functional the plugin is. Other than that, there are only the usual plugins for references in footnotes.
Figure 3: WordPress WYSIWYG editor and standard skin
A commercial plugin called Wiki Pro23 hints at the possibility of using WordPress as a wiki. That said, the plugin appears to be scarcely used if at all. The principle change should be to grant users the right to change pages created by other users (see Figure 4).
Figure 4: The WordPress Capability Manager
22 WordPress Enhanced BibliPlug: https://wordpress.org/plugins/enhanced-bibliplug/ 23 WordPress Wiki Pro: https://premium.wpmudev.org/project/wordpress-wiki/ Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 16 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
The WordPress revision history should, theoretically, be able to handle this setting, but, without having tested WordPress as a wiki, one cannot be certain. Moreover, WordPress might turn out to lack some easy-to-miss wiki functions. For example, WordPress does not support links to pages that do not (yet) exist (see “red links” in section 0). Pros: Ease of use, approval workflow, extensibility, statistics, comments Cons: Revision control, reference management
MediaWiki MediaWiki is the world’s most widely used wiki, and best known from Wikipedia. The European research project SAM24 (ongoing since 2013) uses MediaWiki for its SotA Wiki (see Figure 5), and the CREMA SotA Wiki has been implemented based on MediaWiki. In the following, MediaWiki is checked against the requirements from chapter 2.
Figure 5: Main page of the SAM SotA Wiki
R1: Reference management. An extension called Cite is bundled with MediaWiki. Cite allows the placement of footnotes (see Figure 6). Cite cannot enforce a citation style because each reference is entered as a single string. No comments or abstracts can be entered along with the references. There is an unmaintained extension for outputting BibTeX-formatted references. (Req. not met) R2: Rich-text editing. MediaWiki offers all the basic typography functions and supports the inclusion of images. (Req. met)
24 SAM Wiki: http://wiki.socialisingaroundmedia.com/ Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 17 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 6: Output of the Cite extension in the SAM SotA Wiki
Figure 7: Tabbed view of article pages and talk pages in MediaWiki
R3: User comments. MediaWiki uses talk pages instead of comment threads. Each article page25 has an associated talk page. In the standard skin, users can switch between article page and talk page through a tab (see Figure 7). Talk pages are consistent with MediaWiki’s “everything is a wiki page” paradigm; however, they are less familiar and, arguably, also less intuitive to use than comments.
25 MediaWiki refers to pages with primary content as article pages. In the context of the CREMA SotA Wiki, this is confusing because citations can also refer to (scientific) articles. Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 18 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
There is extension for comments26, but it is currently not maintained, lacks spam protection and has few options for customization. (Req. partly met)
R4: Revision control. MediaWiki has a robust revision control system, proven and tested in Wikipedia. (Req. met)
R5: Approval workflow. FlaggedRevs is a stable extension for approval workflows FlaggedRevs is used in the SAM SotA Wiki and, partly, in Wikipedia. Authorized users can assign ratings, such as “accurate”, to pending changes. There is a lightweight alternative called ApprovedRevs without ratings. (Req. met)
R6: Search. The search engine returns only exact matches of the search term, however, there are third-party search engines that also return near matches. Search queries can be restricted to certain namespaces. Articles and talk pages have separate namespaces, and uploaded files have their own namespace. References entered through the Cite extension reside in the namespace for articles, that is, there is no targeted search for references. (Req. met – the problem lies with R1)
R7: Tree view. Article pages do not have a hierarchical structure, but category pages do. Article pages can be included in category pages, and there is an extension for visualizing category trees. (Req. met)
R8: Tag cloud. There are extensions for tag clouds that could serve as a starting point, in particular CategoryCloud, but none that can be configured to produce a tag cloud as per the requirements. (Req. not met)
R9: News. MediaWiki maintains a list of recent changes, but it is too verbose to serve as an entry point to the wiki; see Figure 8. This (minor) problem only became apparent during development. (Req. partly met)
Figure 8: Excerpt from the list recent changes to the CREMA SotA Wiki
R10: Statistics. Extensive statistics are collected about Wikipedia, however, this is done through a tailor-made, non-portable statistics module. There does not appear to be a MediaWiki extension for geolocation. MediaWiki keeps track of the number of views and edits per wiki page. This could suffice for the CREMA SotA Wiki. Additionally, there is a tool
26 MediaWiki Extension:Comments: https://www.mediawiki.org/wiki/Extension:Comments Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 19 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup called StatMediaWiki27 that evaluates the MediaWiki revision history to visualize the views and edits per time interval; see Figure 9. (Req. met)
Figure 9: Histogram generated by StatMediWiki showing the per-month views of an individual wiki page
R11: Price. Free and open-source software under the GNU GPL (Req. met) R12: Extensibility. The software is designed to be extensible (see section 4.1). More than 2,000 extensions have been developed for MediaWiki28. As it turned out during development, the code is reasonably well structured and documented. (Req. met) R13: Security. Through Wikipedia, the software has been thoroughly tested against real- world adversaries. A blacklist of suspicious terms is the primary anti-spam measure. There are extensions for CAPTCHAs. (Req. met) R14: Ease of use. There are two WYSIWYG editors that can be integrated with MediaWiki, however, both are still in development. MediaWiki is optimized for large wikis like Wikipedia that require extensive usage policies. For a small wiki, warnings tend to be more frequent and verbose than necessary. Some functions, such as watchlists and user pages, are not needed for the CREMA SotA Wiki, and cannot be easily disabled. (Req. partly met) Pros: Revision control, approval workflow Cons: Reference management
Summary MediaWiki, WordPress and Zotero have been taken into close consideration. See Table 2 for a side-by-side comparison of these three. The comparison might be biased against MediaWiki because some issues have only become evident during development and usage. Of the three projects that have been examined, two have employed Zotero (Adventure, SIMPLI-CITY), and one MediaWiki (SAM).
27 StatMediaWiki, Universidad de Cádiz, Spain: http://statmediawiki.forja.rediris.es/ 28 MediaWiki: All extensions: https://www.mediawiki.org/wiki/Category:All_extensions Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 20 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Table 2: Requirements met by the final selection of wiki applications
MediaWiki WordPress Zotero R1 Reference Management Limited (only footnotes) Limited (only footnotes) yes R2 Rich-Text Editing yes yes partly R3 User Comments yes (extension) yes no R4 Revision Control yes partly no R5 Approval Workflow yes (extension) yes (plugin) no R6 Search yes yes yes R7 Tree View yes (extension) yes (plugin) yes R8 Tag Cloud no (not suitable) no (not suitable) no (not suitable) R9 News partly yes yes R10 Statistics yes (basics) yes (via plugin) no R11 Price free free free R12 Extensibility plugin-based plugin-based plugin-based R13 Security yes yes yes R14 Ease of Use medium high medium
From our point of view, it is easier to dispense with full reference management functions than the core wiki functions for interactive knowledge sharing with revision control. The lack of a precedent for a professional SotA Wiki based on WordPress makes WordPress a rather risky choice, whereas MediaWiki has also been demonstrated to be usable as a SotA Wiki in the European project SAM.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 21 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
4 CREMA SotA Wiki Implementation
Overview The design of MediaWiki allows for custom skins and extension modules; see Figure 10. When a web browser requests a wiki page from the web server, PHP scripts obtain the contents of the requested page from the underlying database. These contents are stored in the wikitext markup language. The obtained wikitext is translated to HTML code. The database access and HTML code generation happen within the MediaWiki core. The task of the skin is to add GUI elements such as headers, footers and sidebars to the HTML content. To facilitate the creation of custom skins, MediaWiki defines a base class called SkinTemplate from which, for example, the default skin Vector is derived. Extensions are implemented through an observer pattern. Each extension registers with one or several “hooks” defined in the core code. For example, the ArticleDeleteComplete hook notifies the registered extensions whenever a wiki page is successfully deleted. There are also a number of global variables that the extensions can access.
Figure 10: Skin and extensions used by the CREMA SotA Wiki (package diagram)
The Extensions package shows all extensions that are used by the CREMA SotA Wiki. Thick frames indicate extensions that have been adapted for CREMA. The two blue boxes represent a custom extension and skin written from scratch. Customization and Extension Custom skin. The CREMA skin shows only the GUI elements that are needed to meet the requirements from chapter 2. Starting from the bare SkinTemplate class turned out to be faster than working backwards from an established skin. The CategoryTree extension was adapted for generating a tree view of the topic pages – the original extension only works for category pages, that is, pages that group together other pages. Figure 11 shows the CREMA skin and the skin used by Wikipedia side by side.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 22 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 11: The CREMA skin next to the standard skin (Vector)
Enhanced support for references. The CREMA extension module is responsible for displaying introductory texts and bibliographies in separate tabs. Moreover, it allows users to enter references through a form (based on the experimental Form extension [25]) along with a URL, a comment and an abstract (see Figure 12).
Figure 12: Tabbed view and entry form for references
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 23 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
The entry form does not have individual fields for data like author or date of publication – this was judged as too costly to implement, and potentially inconvenient to use. Filters for types of references have been added to the search function, and search results distinguish between topic pages and references. See section 0 for details. CKEditor is an open source WYSIWYG editor that integrates with several web content management systems. The integration into MediaWiki is in the beta stage. [26] CKEditor has some shortcomings such as an unintuitive dialogue for inserting hyperlinks and the lack of a useful macro-based mode. That said, a flawed WYSIWYG editor still seems preferable to a mature macro-based editor that displays markup code to the user. See Figure 13 for a side-by-side comparison. As a third alternative, VisualEditor [27] could be tested. This is a WYSIWYG editor developed specifically for MediaWiki. VisualEditor is also still in the beta stage.
Figure 13: The same content in CKEditor (WYSIWYG; on the top), and WikiEditor (macro- based; on the bottom)
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 24 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
CREMA SotA Wiki Content: Structure and Status The initial content of the CREMA SotA Wiki is hierarchically structured into the following 22 topics. Those topic for which content is available as of June 2015 are marked in bold:
B2B Marketplaces Big Data Cloud Manufacturing Cloud RAID Infrastructures Condition Monitoring Cyber-Physical Systems o Sensor Technologies Elastic Processes Process Optimisation Semantic Interoperability o Semantic Data Harmonization o Semantic Data Models Semantic Services o Semantic Service Composition o Semantic Service Description o Semantic Service Discovery Stream Reasoning o Semantic Stream Processing o Stream Processing User Interfaces o Dual Reality Dashboards o Smart Glasses
Refinements, restructuring, and new contributions to this initial CREMA SotA Wiki will be made for the deliverable D2.5.2.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 25 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
5 Using the CREMA SotA Wiki
User Accounts The wiki can be viewed without a user account, that is, except for some internal pages like the list of registered users. In the future, unregistered users should be allowed to leave comments, however, comments have not been fully implemented yet. At this point, comments are disabled for all users, meaning that unregistered users cannot make any changes to the wiki. Users that have an account can log in through the “Log in” link at the bottom of the sidebar (see Figure 14). The log-in form also leads unregistered users to the account creation form. Any user can create an account by choosing a user name and a password. An email address can be provided, but is not mandatory and not confirmed by the wiki software. Users who do provide an email address can use it to reset their password in case they forget. For password problems or any other support requests, there is also a “Contact” link on the sidebar. Users who create their own accounts are considered as not trusted. Such users can create and change topic pages, but their contributions remain invisible until approved by a user with editor rights. For all project partners, editor accounts have been created. Changes by editors become visible right away, and editors are able to view unapproved changes. Unlike untrusted users, editors can also upload image files and delete topics and references.
Figure 14: The forms for log-in and account creation
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 26 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Entry Points The wiki content can be accessed in the following ways (see Figure 15): The topic tree is located on the sidebar. Topics that have sub-topics can be expanded by clicking on the blue arrows. A full-text search field is in the centre of the main page and on top of the sidebar on any other page (see section 0). The main page lists those articles that have recently been created or extended. The list of changes is manually updated by the CREMA SotA Wiki editor to ensure that minor changes are excluded. A tag cloud with hyperlinks is to appear on the main page once implemented. An empty glossary page is accessible from the sidebar; it is still to be decided if the CREMA glossary should be included in the CREMA SotA Wiki.
Figure 15: Entry points for accessing the wiki content
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 27 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Search Functions By default, search queries include all types of references: articles, software and projects (see Figure 16). Any of these types can be excluded by unchecking the checkboxes below the search field. Introductory texts are always included in the search. The “CREMA only” option limits the search to references that are tagged as CREMA results. There are no CREMA results in the CREMA SotA Wiki yet, and the function for tagging them is not implemented either.
Figure 16: Result of a search for software and projects involving “distributed computing”
The result page shows links to topic pages and direct links to individual references. The topic pages are ordered by the number of associated references in which the search terms occur. (The preview snippets generally only show the first occurrence of one of the terms.) For example, the results shown in Figure 16 include all four topics that contain both words: “distributed” and “computing”. It is also possible to search for phrases, e.g. “distributed computing”; this requires quotation marks. The first search result is the topic “Cloud
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 28 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Manufacturing”, which contains the search terms in its introductory text and in two references to articles. References to articles have been excluded from the search, therefore, only a link to the topic page is shown. “Stream Processing” has a match in one of its software references; a link to that reference is shown indented as part of the second search result. Caveat: Currently the search only finds the exact matches, for example, occurrences of “distribute” are ignored when searching for “distributed”. The search is not case-sensitive though. Viewing of Topic Pages
Figure 17: The “General” tab of the topic page about Semantic Services
The “General” tab (Figure 17) shows the introductory text that summarizes the topic and explains its relation to CREMA. The “General Links” section contains references that are relevant to the topic, but not to CREMA specifically. These references are only recommended for gaining a general understanding of the topic. The other three tabs list all references associated with the topic. Each reference can have an abstract and a comment. The comment should explain how that specific reference relates to CREMA, but can also contain miscellaneous information about the reference.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 29 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 18: The “Projects” tab of the topic page about Cloud Manufacturing
When viewing a topic, the sidebar shows only the children and siblings of that topic in the topic tree. The parent topic and the main page are accessible through a usage path on the upper left of the page.
Figure 19: Usage path (“breadcrumb trail”) on top of a topic page
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 30 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Contributions to CREMA SotA Wiki Content
When viewing a topic page, the selection of “Edit” in the sidebar switches the wiki to the editing mode. To view the page again, the user can press “Cancel” on the bottom of the “General” tab. When editing a topic, that topic’s position in the topic tree can be changed through the “Sub- topic of” field in the “General” tab. In the future, it should be possible to change the title of a topic in the same way. For now, users will have to ask the CREMA SotA Wiki editor (through the “Contact” link) to change titles. Upon pressing “Save changes” in the “General” tab, any changes to the introductory text and the “Sub-topic of” field are submitted to the CREMA SotA Wiki editor for approval. If changes to the same topic have been submitted by a second user in the meantime, a conflict resolution page is shown, which assists the user to merge the two versions. Users are informed about concurrent changes when pressing the “Preview” button. It is highly recommended to preview a contribution by pressing the “Preview” button before finally submitting it to the editor for approval by pressing the “Save changes” button. The approval workflow is exemplified in Figure 20. In the topmost screenshot, an untrusted user is about to submit a change for approval. The middle screenshot shows the confirmation message and the empty page template – the change is submitted, but not yet visible to the public. The last screenshot is from the perspective of the editor who reviews the change.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 31 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 20: The approval workflow in the CREMA SotA Wiki
The “Delete” link leads to a confirmation page (see Figure 21). The deletion of a topic implies the deletion of all associated references. All changes can easily be undone by a user with the Editor rights, even deletions. In the future, any registered user should be able to revert changes through the revision history page. This page has not yet been integrated into the user interface of the CREMA SotA Wiki. The revision history also attributes changes to users. It is therefore not necessary to indicate authorship explicitly; that information is recorded and will eventually be traceable for registered users.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 32 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 21: Confirmation page for deleting a topic page
5.5.1 CKEditor While editing a topic, the “General” tab shows the topic’s introductory text inside a WYSIWYG editor.
Figure 22: Controls of CKEditor; highlighted: images, tables, special characters and block quotations
Typography. CKEditor has controls for basic typography such as font selection, lists, indentation, emphasis, colours and text orientation (see Figure 22). Sections can be added by selecting a heading style from the “Styles” menu. There are buttons for inserting tables, block quotations and special characters. The image button allows external images to be embedded. Trusted users can also upload images to the wiki (see Figure 23).
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 33 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 23: The dialogue for inserting images
The “Source” button allows users to enter wikitext directly. All the essential typesetting should be available in the WYSIWYG mode though. Writing wikitext in CKEditor is inconvenient because CKEditor does not have macro buttons; the user needs to know or look up the syntax of the wikitext markup language or existing entries as an example.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 34 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 24: Dialogue for placing a link
Hyperlinks. The “Link” button brings up a dialogue where a link target is to be entered (seeFigure 24). That can be the URL of an external resource or the title of a CREMA SotA Wiki page. An auto-complete function suggests titles. Any text that is selected within the editor before opening the “Link” dialogue is used as the link text. If no text is selected, the link target is used as the link text. The “Redirect to target page” option can be used to create a topic page that serves as an alias to another topic page. It is possible to create links to topic pages that do not exist. MediaWiki displays such links in red, and following a red link causes the missing page to be created. Red links are a convenient way to create new topic pages, or to indicate topic pages that are supposed to be created by other users.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 35 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 25: The citation dialogue
Footnotes can be inserted by pressing the “
5.5.2 Adding and Changing References In the three tabs containing references, there is an “Edit” link shown next to each reference. These links are only visible to the users who have logged in. “Editing” a reference also allows deleting that reference. References can only be edited as wikitext. The syntax “description=”, “abstract=” (see Figure 26) should be sufficiently intuitive. While special formatting of text can be used in references, it should not be necessary, and the respective macro buttons have been removed from the text editor. “Save changes” takes the user back to the topic page that the reference belongs to.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 36 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 26: Editing references as wikitext
For adding references, there is an entry form on each of the references tabs. In viewing mode, that form appears below the references, in editing mode before the references (see Figure 27). URL, abstract and comment are optional. Entering an abstract makes the reference easier to find through the search function because the abstracts are included in the search. Copying an abstract from an original publication or a digital library is legal in Germany [28], however, laws in other countries may differ.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 37 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 27: Form for entering references
5.5.3 Creation of Topic Pages A topic page can be created through the following two methods: Use the “Create” button under the topic tree in the sidebar Add a red link to an existing topic (see the paragraph on hyperlinks in section 5.5.1) Search for the desired topic title, and follow the red link at the bottom of the result page. This method also helps ensure that a similar topic does not already exist (See Figure 28).
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 38 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 28: Creating a topic page from the search result page
The introductory text of the newly created topic is preloaded with the recommended sections (see Figure 29). Additional top-level sections are discouraged. That said, at this point, there is nothing to prevent users from adding or removing sections. The “
Figure 29: Creation of a topic page
If the user does not change the “Sub-topic of” field, the parent topic will be “Home”, meaning that the new topic is attached to the (invisible) root of the topic tree. An editor or any other user can easily find the new topic in that spot, and attach it to a more suitable parent if there is one.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 39 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
6 Summary
Initial deployment and usage.The CREMA SotA Wiki was first deployed on a DFKI webserver on May 8, 2015; it has been accessible from the CREMA project page since 11.5.2015. The beta test phase has lasted from 11.5.2015 until 26.6.2015. Within that time, 22 topic pages have been created by the project partners and about 100 references to articles, software, and projects. Many of these references are already provided with useful comments. Ongoing work. As mentioned above and in the DoA, the CREMA SotA Wiki will be updated in subsequent deliverables D2.5.2 in June 2016 and D2.5.3 in June 2017. This concerns the adding of new related content by external and project partners, as well as the regular editorial of the contributed content for reasons of quality control by the project partner DFKI. Moreover, the following functions are planned to be realized for the upcoming versions of this wiki by DFKI (in the order of priority). Implement a method for linking to individual references, in particular, through footnotes. Without this, the introductory texts cannot refer to the bibliographies. Topics currently cannot be easily renamed Allow references to be entered in the BibTeX format, and use the Bibtex extension to render BibTeX references. Enable user comments (currently disabled) (see Figure 30). The respective extension is installed, but conflicts with the WYSIWYG editor.
Figure 30: A field for entering a comment (currently disabled) Show a linked tag cloud on the main page. The tags should be topics, and the size of the tags should be a function of the number of sub-topics, references and (possibly) edits of the topic. This will require a suitable third-party tool. Install a better search engine such as Sphinx or Lucene. The standard search finds only the exact matches. Simplify the revision history and add a link to it to the user interface. See the screenshot in Figure 31 for the present state of the revision history. The tabbed view does not yet work for revision histories (not shown in the screenshot).
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 40 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
Figure 31: Revision history of the topic page for semantic services
Allow users to tag references as CREMA results. Then, the “CREMA only” search filter can be used to find (only) references to CREMA results. Add a printer-friendly view; the tabbed view makes it difficult to print topic pages.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 41 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066
CREMA WP2 Public D2.5.1 - State of the Art Wiki Setup
References
[G10] E. Goldman, “Wikipedia's labor squeeze and its consequences,” Journal on Telecommunications and High Technology Law, vol. 8, no. 1, pp. 157-183, 2010. [TUD13] TU Darmstadt, “Deliverable 2.4.1: State of the Art Wiki Setup and Initiation,” 2013. [Bur14] D. Burgstahler, “SIMPLI-CITY State of the Art Wiki Update II,” 2014. [Man13] T. H. Juergen Mangler, “Adventure State of the Art Wiki Update,” 2013. [Coa12] J. Coalo, “With 60 Million Websites, WordPress Rules The Web. So Where's The Money?,” Forbes, September 2012. Available: http://www.forbes.com/sites/jjcolao/2012/09/05/the-internets-mother-tongue/. [Accessed June 2015]. [Klu13] S. F. Klutentreter, “Die Migration eines Wiki-Systems von TWiki nach Foswiki,” Freie Universität Berlin, 2013.
Document Date: Page: D2.5.1 - State of the Art Wiki Setup Status: For Approval Version: 1.1 2015-07-06 42 / 42 http://www.crema-project.eu Copyright © CREMA Project Consortium. All Rights Reserved. Grant Agreement No.: 637066