Wiki - dictionary. technical reference. Dario Filippini. ITTC WIKI Dictionary. National Research Council. autor

Transcription

1 Pag.1/14 ITTC Wiki - dictionary technical reference autor Dario Filippini pag 1 di 14

2 Pag.2/14 Index preamble the project operational guidance general characteristics Layout main menù name space (NS) proposal trysyntax wiki user and login login edit create/delete page media files plugins considerations sources...15 pag 2 di 14

3 Pag.3/14 preamble The International Towing Tank Conference (ITTC) is a voluntary association of worldwide organizations, whose objectives are addressed to the prediction of hydrodynamic performance of ships and marine equipment, based on results derived from the study of experimental data, mathematical and physical models. From 1932 to present, this collaboration has promoted a series of documents, procedures and guidelines, an easy reference point production processes, research and development, from organizations or institutions of technical and scientific field. Sector managers in charge of documentation referred to above is the Quality Systems Group (QSG) shall also ensure that stimulate, monitor, support and validate the work in the field of all technical and scientific committees. pag 3 di 14

4 Pag.4/14 the project QSG, in order to make available to the scientific community, naval architects, engineers, field technicians, a basic reference, updated and always available, in relation to physical and hydrodynamic characteristics of ships, has stimulated efforts in this direction. After exploring a series of proposals, the QSG has decided to take action by implementing (ITTC News 591) the initiative presented by CTER Dario Filippini. Project has led to the publication of a web portal that allows the dynamics of a consultation ITTC-Dictionary beyond its implementation through contributions from its users. Web portal has active from two years and is available on the web to address: After a first phase that has seen the data collection, study and verification of claims, Cter Dario Filippini has been responsible for procurement of hardware and software resources, setting and substitution of components, installation of the necessary applications. Currently the server is physically located at the headquarters of the Center for Responsibility INSEAN-CNR under direct maintenance and update by the Cter Filippini. operational guidance This documentation is to be considered an integral part of the web accessible to address guide all of which constitutes use. Navigation features and use of online content of the wiki-ittc Dictionary, are based on the general philosophy of the free and collaborative encyclopedia Wikipedia. User has two ways of interaction, accessing the site as a registered user or not. In the latter case his interaction is limited to reading the information, facilitated by the ability to respond dynamically to the references from time to time in the pages and references, both internal and external to the wiki. May likewise have access to certain basic documentation and export sections of interest in ways that will be presented later. pag 4 di 14

5 Pag.5/14 general characteristics hw and sw server hardware PC desktop CPU : AMD Athlon(TM) XP RAM : 1,5 GB HD : 80 GB server software S.O. : Linux Ubuntu CMS : DokuWiki Wiki is developed using the CMS DokuWiki1 (DW). This Content Management System (CMS) is derived from an open source project distributed under GNU GPL and Creative Commons. DW is a CMS based on the management and treatment of text files also as regards the recording of information and data. This feature in addition to not need to implement and manage a database server, allows the installation even on older systems and/or low processing capacity, keeping qualities of reliability and smooth operation. 1 pag 5 di 14

6 Pag.6/14 layout main menù: Navigation of the wiki is available from a main menu, shown in the left sidebar, which lists in alphabetical order, all the basic items and links, including the page "start" which plays the role of "home" site web, being the first to be displayed when you type the internet address of the wiki. In the upper right are some more links which change depending on the type of user who is consulting the wiki. (Figure 1). Box main menù Start: home page Figura 1 name space (NS): There are two main sections which constitute the dictionary proper, organized in "alphabetic dictionary" and "structured dictionary". These sections are called "namesapce". In 'alphabetic entries are listed alphabetically in the structured dictionary, the same items are organized in relation to specific sections of belonging. In head to the two sections is a reference to terms or more applicants Cloud reference (Figura 2). pag 6 di 14

7 Pag.7/14 Cloud reference Figura 2 Inside NS alphabetic a further division into categories of entries. This approach, while not following a strictly alphabetical order, gives a more readable and immediately ordered due to the background source. In the upper right is a "Table of contens" (ToC), which allows you to jump to specific sections of the page displayed, particularly useful when, as in ITTCwiki, the content can occupy several screen pages. Continuing with the entries in the box, we find the main, the NS proposal in turn divided into "Dictionary" and "Symbol List". The needs regarding the introduction of the NS is due to the need to have a means by which to suggest adoption and/or modification of items of terminology and/or symbolic. These proposals could be so exposed and evaluated, in the period between the appointments of three years' ITTC Meeting Conference, by the organs of the technical / scientific bodies, and eventually adopted by the scientific community. Trysyntax" where NS is a user can become familiar with the syntax of the wiki pag 7 di 14

8 Pag.8/14 and try to use it having immediate feedback, without going to affect the main data. When editing individual sections of its ToC can better understand how they can be implemented in the various "plugins" available in the wiki. wiki essentially contains summaries of topics on the website of the DW project and an excerpt from the main syntax. Other references in the main box are: alphabet : refer to the main page of alphabetical index of the dictionary structured : refer to the main page of structured index contact : application form contact document : currently contains the basic documents that are referenced on the wiki. Here may be inserted other documentation you want to make available to all or part of users. todo : Displays a table with a list of things to do. At present it is a quick reference to the items that remain outstanding, to correct and quant 'other is to implement these classifications. pag 8 di 14

9 Pag.9/14 User and login In the menu at the top right, in addition to references to "Sitemap" and "Profile" is the place I refer to recent changes Recent changes (Figura 3). Old revision Show difference Figura 3 In this section you can see when and which items have been added or modified and what the change consisted, in addition to which user has done. Clicking on the glasses (show difference) you get a view of what runs on the item of interest. pag 9 di 14

10 Pag.10/14 Clicking on the page (revision Old) leads to list of revisions and changes. Interestingly the latter list is to be able to select any two versions and check points of difference. (Figura 4) Figura 4 Login: In addition to the features described above, user can contribute to the development and implementation of the dictionary in full philosophy "wiki" by registering and accessing the site. (Figura 5) pag 10 di 14

11 Pag.11/14 Figura 5 The system will send to the address, a link to the activating and possible new account Password forgotten after the login credentials. Edit: Once logged, user is able to edit entries and sections using a modifier key Edit. (Figura 6) Figura 6 Going into editing mode are proposed a number of typographical and functional tools that help the less experienced user of the syntax to perform basic manipulations of the text. (see figure below) We can distinguish tools for formatting text, paragraphs and for the management of TOC, for the creation of internal and external references to the wiki. Some plug-ins to provide added items to the toolbar, when installed in the wiki. You will notice that there are no classic buttons for creating / opening page / document, this is because the management of the creation / deletion of pages in the wiki is done in ways that we can define "direct": crete/delete page: deleting the contents of a page you get the automatic cancellation of the same. To create a new one, you simply insert a "page name" in the address bar of pag 11 di 14

12 Pag.12/14 your browser and the system proposes the creation. In image below has been requested a nonexistent page named "newpage" in NS "playground", the system proposes the link to create the page not found. Another method is to insert in the editing stage, an internal reference to a new page whose creation will be required as soon as we click on the link. (See figure below) bottom left page link create page browser address bar For a comprehensive explanation of the syntax you can refer to the official guide on the project site DW2, show in the page syntax in wiki section of the main menù which constitutes an integral part of this relationship. Media files: In Edit mode you can manage media files by running the upload and/or identifying those to be included specifically. By selecting icon to the "frame" in the toolbar, it opens a window pop up that allows you to browse files / documents contained in each NS. (see figure below) icona media manager Window is divided into two sections: on the left is a list of NS and the right documents, files contained in it, and if the user has privileges at the top may notice the boxes and buttons for the upload the files in NS selected on the left (Figure 7). 2 pag 12 di 14

13 Pag.13/14 Figura 7 Plugins: The wiki is supplied to user with a series of additional features implemented by a series of plugins whose management is entrusted to user 'admin'. General feature lies in the simplicity of use through specific tags along with the basic syntax of DW. For those most relevant to the needs of user 3 base, provides a brief description in the section "trysintax" among these may be mentioned: math 4: to write scientific formulas gallery: to construct an image gallery of files present in a given NS ODT export: allows the export of the page displayed, open document format (see Figure 6) discussion: through it you can enter the discussion sections similar to "mini forum" with lots of topics and user responses, relative to parts / sections of the page where the functionality is activated 3 take a look periodically to the "trysintax" for news about tools activated by 'administrator and new features of the wiki. 4 pag 13 di 14

14 Pag.14/14 considerations: The effectiveness of the "tool" ITTC wiki dictionary, is in complete interactivity with the web community that provides all content updates. The system control and moderation of the wiki is entrusted to ensure that Cter Dario Filippini, which must now, to align the platform to release technical and security made available by the developer community. sources: pag 14 di 14