Interface elements

From Redazione
Jump to navigation Jump to search
Line 11: Line 11:
 
[[File:How it works/Interface elements/UI_detail_4.jpg|thumb|right|picture 8]]
 
[[File:How it works/Interface elements/UI_detail_4.jpg|thumb|right|picture 8]]
  
'''How it works link''' (picture 1), this is a convenience link, on top left of side panel, to access the "How it works" section where it's being used as a reference and to obtain some orientation.
+
'''How it works link''' (picture 1), this is a convenience link, on top left of side panel, to access the "How it works" section where it's being used as a reference and some general orientation.
  
'''My organization section''' (picture 2), it contains (once that you are logged-in, as the links below) a link directing to your organization's page, and a link for its [[How it works/Table of contents]]
+
'''My organization section''' (picture 2), it contains (once that you are logged-in, as the following features) a link directing to your organization's page, and a link for its [[How it works/Table of contents|Table of contents]]
  
'''CI tools section''' (picture 3), it contains the link "Create or edit page" which will bring you to a form where you can search for existing pages to edit, or to create new ones. The input takes into account the organization to which you are affiliated so that you have not to insert the complete path each time. The section also contains the link "Import data", from where you can import multiple records of a given kind (like Articles, News, etc.) from a [https://en.wikipedia.org/wiki/Comma-separated_values csv] or [https://www.w3schools.com/js/js_json_objects.asp json] file: this feature has been created specifically for [[How it works/Private WIKIs]] where for instance you need to import all your organization's contacts or audience, rather than creating them manually one by one.
+
'''CI tools section''' (picture 3), it contains the link "Create or edit page" which will bring you to a form where you can search for existing pages to edit, or to create new ones. The input takes into account the organization to which you are affiliated so that you have not to insert the complete path each time. The section also contains the link "Import data", from where you can import multiple records of a given kind (like Articles, News, etc.) from a [https://en.wikipedia.org/wiki/Comma-separated_values csv] or [https://www.w3schools.com/js/js_json_objects.asp json] file: this feature has been created specifically for [[How it works/Private WIKIs|Private WIKIs]] where for instance you need to import all your organization's contacts or audience, rather than creating them manually one by one.
  
'''Forms panel''' (picture 4), it is the list with all available forms/semantic data in this wiki, that should be considered the starting point for structuring your contents. (and to the limit to ask the redaction new kinds of content if something is missing and it can be of general interest). Once followed one of the link, you will find a notice on top of the form (picture 5)  with the path (that is the full page's title) of the page that will be created upon submitting the form: alternatively, to create a form into an existing page (without a form), just use the following function.
+
'''Forms panel''' (picture 4), it contains the list with all available forms/semantic data of this wiki, that should be considered the starting point for structuring your contents. (and to the limit, to ask the editorial staff new kinds of content if something is missing and it can be of general interest). Once followed one of the link, you will find a notice on top of the form ('''picture 5''')  with the path (that is the full page's title) of the page that will be created upon submitting the form: alternatively, to create a form into an existing page (without a form), just use the following function.
  
'''Forms menu''' (picture 6), it is a dropdown on the menu top (see picture 7) with the same list of forms located in the side panel, which will add a given form in the existing page, rather than creating a new one. This is useful both to assign with semantic data an existing page (like a page with an article, not yet marked as such) and to create "pages with forms" at a different path of that foreseen by the "Create form" function, without of being obliged to rename (move) the page following.
+
'''Forms menu''' (picture 6), it is a dropdown on the top menu (see '''picture 7''') with the same list of forms located in the side panel, which will add a given form in the current page (once that you navigate there) rather than creating a new one. This is useful both to assign with semantic data an existing page (like a page with an article, not yet marked as such) and to create "pages with forms" at a different path of that foreseen by the "Create form" function, without of being obliged to rename (move) the page following.
  
'''Page properties''' (picture 8), it is  
+
'''Page properties''' (picture 8), it directs to a special page where you can set some basic properties of the related page, that is its language (necessary above all when the automatic language detection cannot determine the page's language with an high index of "confidence"), its status (either published or not), and some meta properties intended to search engines ([[How it works/Page status & SEO|SEO]]). Because the initial state of a page is "unpublished" it is necessary to update its state once the page is ready for publishing otherwise visitors will not be able to access it. (the method is not meant to record confidential information, just to behave as described) 
  
  
Line 31: Line 31:
  
 
<!--  inasmuch as they inspire all the data structure that will take the information you will insert or create. Once followed one of the link, you will find a notice on top of the form (picture 2) [[File:How it works/Tips & guidelines/form_header.jpg|thumb|600px|picture 2]] with the path (that is the full title) of the page that will be created upon submitting the form: indeed, the form links on the navigation panel will create a new page, while to add a form to an existing page which does not already contain one, you have to navigate to that page, and then to use the menu on top after "View history" (picture 3). [[File:How it works/Tips & guidelines/menu_top_forms.jpg|thumb|picture 3]] Usually the form does not create the content itself of the page (i.e., the article content, in this case) but it specifies the relevant semantic data of that page, so that it can be accurately cataloged and each of their data retrieved when needed.-->
 
<!--  inasmuch as they inspire all the data structure that will take the information you will insert or create. Once followed one of the link, you will find a notice on top of the form (picture 2) [[File:How it works/Tips & guidelines/form_header.jpg|thumb|600px|picture 2]] with the path (that is the full title) of the page that will be created upon submitting the form: indeed, the form links on the navigation panel will create a new page, while to add a form to an existing page which does not already contain one, you have to navigate to that page, and then to use the menu on top after "View history" (picture 3). [[File:How it works/Tips & guidelines/menu_top_forms.jpg|thumb|picture 3]] Usually the form does not create the content itself of the page (i.e., the article content, in this case) but it specifies the relevant semantic data of that page, so that it can be accurately cataloged and each of their data retrieved when needed.-->
 
  
  

Revision as of 09:38, 28 December 2020

Besides a number of edits in the installed Mediawiki's source code to fit our specific requirements, mainly to achieve an enhanced sub-pages management, Cultura italiana includes a custom extension which adds (nowadays) a large number of functionalities over standard wikis, like automated creation of pages through (in turn enhanced) PageForms, auto-generated TOCs, page's properties (including meta-data), automatic privileges management based on the affiliation of logged-in user, a deep integration with the front-end, magic words, parser functions, [several more entries, either seductive or not], and indeed the following UI elements:


picture 1
picture 2
picture 3
picture 4
picture 5
picture 6
picture 7
picture 8

How it works link (picture 1), this is a convenience link, on top left of side panel, to access the "How it works" section where it's being used as a reference and some general orientation.

My organization section (picture 2), it contains (once that you are logged-in, as the following features) a link directing to your organization's page, and a link for its Table of contents

CI tools section (picture 3), it contains the link "Create or edit page" which will bring you to a form where you can search for existing pages to edit, or to create new ones. The input takes into account the organization to which you are affiliated so that you have not to insert the complete path each time. The section also contains the link "Import data", from where you can import multiple records of a given kind (like Articles, News, etc.) from a csv or json file: this feature has been created specifically for Private WIKIs where for instance you need to import all your organization's contacts or audience, rather than creating them manually one by one.

Forms panel (picture 4), it contains the list with all available forms/semantic data of this wiki, that should be considered the starting point for structuring your contents. (and to the limit, to ask the editorial staff new kinds of content if something is missing and it can be of general interest). Once followed one of the link, you will find a notice on top of the form (picture 5) with the path (that is the full page's title) of the page that will be created upon submitting the form: alternatively, to create a form into an existing page (without a form), just use the following function.

Forms menu (picture 6), it is a dropdown on the top menu (see picture 7) with the same list of forms located in the side panel, which will add a given form in the current page (once that you navigate there) rather than creating a new one. This is useful both to assign with semantic data an existing page (like a page with an article, not yet marked as such) and to create "pages with forms" at a different path of that foreseen by the "Create form" function, without of being obliged to rename (move) the page following.

Page properties (picture 8), it directs to a special page where you can set some basic properties of the related page, that is its language (necessary above all when the automatic language detection cannot determine the page's language with an high index of "confidence"), its status (either published or not), and some meta properties intended to search engines (SEO). Because the initial state of a page is "unpublished" it is necessary to update its state once the page is ready for publishing otherwise visitors will not be able to access it. (the method is not meant to record confidential information, just to behave as described)



the form does not create the content itself of the page (i.e., the article content, in this case) but it specifies the relevant semantic data of that page, so that it can be accurately cataloged and each of their data retrieved when needed




  • Other pieces of the interface to be noted before starting are the link "My organization" still in the left navigation panel (picture 4) and the link "Create or edit page" right below. (picture 5) The first (predictably) will bring you to the main page of your organization, and the second will bring you to a form where you can search for existing pages to edit, or to create new ones. The input takes into account the organization to which you are affiliated so that you have not to insert the complete path each time.
  • Keep looking at the interface. On the top you will find the page-related menu (picture 6) with the button "Edit", through which you can access the Visual Editor of the article, and "Edit source", through which you can edit the wiki text of the article. Of course we expect that you use Visual editor at first since it's the most immediate and avoid you to deal with the intricacy (sometimes) of wiki text. However by accessing the source text of an example page allows you to just copy the elements you are interested in, and then editing them on your page.