Tips & guidelines

From Redazione
Jump to navigation Jump to search
 
(10 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
*Thus Mediawiki and [https://en.wikipedia.org/wiki/Help:Wikitext wiki text] are not precisely user-friendly (for a legitimate reason, that is precisely to encourage the creation of quality contents) we have provided this platform with all the tools to make the creation and editing of contents as easy and profitable as possible, in such a way that supposedly any member of a center of Italian culture and language with an average IT literacy, will be able to create and edit all the required information, and to address himself or herself either to the IT department of their organization or to the editorial staff of this platform, only to enhance the general structure of their pages, or to fix some issue.
 
*Thus Mediawiki and [https://en.wikipedia.org/wiki/Help:Wikitext wiki text] are not precisely user-friendly (for a legitimate reason, that is precisely to encourage the creation of quality contents) we have provided this platform with all the tools to make the creation and editing of contents as easy and profitable as possible, in such a way that supposedly any member of a center of Italian culture and language with an average IT literacy, will be able to create and edit all the required information, and to address himself or herself either to the IT department of their organization or to the editorial staff of this platform, only to enhance the general structure of their pages, or to fix some issue.
<noinclude>
+
<noinclude><!--On a first stage, edits or creation of your pages will be moderated. That means that once an administrator does not grant you with the role of "moderator", your edits or created pages will be not publicly visible until they are not approved by an administrator. Usually we expect that the contents have to be moderated until a registered user of a center of Italian language and culture shows a sufficient expertise (however this is achieved), or their set of pages reaches a certain degree of completeness: after that, all the affiliated users of that center will be assigned to the role of "moderator" and their edits will not be required of being approved anymore.-->
<!--On a first stage, edits or creation of your pages will be moderated. That means that once an administrator does not grant you with the role of "moderator", your edits or created pages will be not publicly visible until they are not approved by an administrator. Usually we expect that the contents have to be moderated until a registered user of a center of Italian language and culture shows a sufficient expertise (however this is achieved), or their set of pages reaches a certain degree of completeness: after that, all the affiliated users of that center will be assigned to the role of "moderator" and their edits will not be required of being approved anymore.-->
+
*Privileges for editing and accessing pages throughout this platform are automatically handled. Typically, an account managed by a given center of Italian culture and language, can edit only the pages of the organization to which it is affiliated, and can create contents of public interest (like [[Opportunities]], [[Reading suggestions]], [[Digital_library/Authors|open source books]]) as long as they are being created through a form (see picture 1, which displays a list visible in the side panel once logged-in) or as long they have been created using the same account.
  
*Privileges for editing and accessing pages throughout this platform are automatically handled. Typically, an account managed by a given center of Italian culture and language, can edit only the pages of the organization to which it is affiliated, and can create contents of public interest (like [[Opportunities]], [[Reading suggestions]], [[Digital_library/Authors|open source books]]) as long as they are being created through a form (see picture 1, which displays a list visible in the side panel once logged-in) or as long they have been created using the same account.
 
 
*After signing up, your organization's page and sub-pages will be only accessible and editable by your staff and the administrators of {{CI inline logo}} and they will not yet be visible to the general audience. Once that your organization's page and its related pages will reach a sufficient level of completeness, they will be "enabled" by site-administrators and from that moment you, as organization, will be fully responsible of your pages, and any page that you create/edit/delete/move (within your "domain") will be not anymore moderated in any way.
 
*After signing up, your organization's page and sub-pages will be only accessible and editable by your staff and the administrators of {{CI inline logo}} and they will not yet be visible to the general audience. Once that your organization's page and its related pages will reach a sufficient level of completeness, they will be "enabled" by site-administrators and from that moment you, as organization, will be fully responsible of your pages, and any page that you create/edit/delete/move (within your "domain") will be not anymore moderated in any way.
*Any new additional page that you create is automatically set as "draft", that is, it has an unpublished state. Please check [[How_it_works/Page status & SEO|Page status & SEO]] to find out more about that feature: you can publish it as soon as is ready for that and even to set some meta information intended to search engines.
+
 
*Once it has been created, the page of your organization contains a standard content model, that is a predefined set a sections (like Abstract, Location, Gallery, Courses, etc.) that you can use to organize your contents. Of course they are so just as an example, and everything can be reorganized as you think it's better. However, contents/pages created using available forms (like [[Special:FormEdit/Post|Post]], [[Special:FormEdit/Article|Article]], and so on – check [[How_it_works/Forms_&_semantic_data|Forms & semantic data]] for all available kind of contents) will be saved at a specific path, like [your organization]/Articles/[article name] and the intermediate pages (in this case the page "Articles") will be created as well if not existing, and filled-in with with an [https://www.semantic-mediawiki.org/wiki/Help:Inline_queries ask query] to display a table of related contents. Of course this is done for convenience, but again contents created, either automatically or not, can be edited/rearranged in whatever way.<!-- Following we will add the possibility to include an arbitrary path -->
+
*Any new additional page that you create is automatically set as "draft", that is, it gets an unpublished state. Please check [[How_it_works/Page status & SEO|Page status & SEO]] to find out more about that feature: you can publish it as soon as is ready for that and even to set some meta information intended to search engines.
 +
 
 +
*Once it has been created, the page of your organization contains a standard content model, that is a predefined set a sections (like Abstract, Location, Gallery, Courses, etc.) that you can use to organize your contents. Of course they are so just as an example, and everything can be reorganized as you think it's better. However, contents/pages created using available forms (like [[Special:FormEdit/Post|Post]], [[Special:FormEdit/Article|Article]], and so on – check [[How_it_works/Semantic_forms_and_structured_data|Semantic forms and structured data]] for all available kind of contents) will be saved at a specific path, like [your organization]/Articles/[article name] and the intermediate pages (in this case the page "Articles") will be created as well if not existing, and filled-in with with an [https://www.semantic-mediawiki.org/wiki/Help:Inline_queries ask query] to display a table of related contents. Of course this is done for convenience, but again contents created, either automatically or not, can be edited/rearranged in whatever way.<!-- Following we will add the possibility to include an arbitrary path -->
 
<!--
 
<!--
 
Upon sign-up, either that your main organization page will be created by our staff, or directly by you through the [[Special:FormEdit/Organization|appropriate form]], the form itself will create a predefined page model, so you can just fill-in the related sections, provided that your page and its sub-pages can be organized how do you think it is better: the model is to be considered just as a suggestion. Also, each time that you create a content through the related form (for instance an article, a "post", a language course, etc.) and that kind of content is being created for the first time, our platform will automatically create the related intermediate pages, with a list of relevant contents within them: again, these contents are created for convenience, and they can be used as a reference to organize your data in the proper way, but finally all that can be deleted or replaced with contents entirely created **comment start**a formatting entirely decided**comment end** by you. -->
 
Upon sign-up, either that your main organization page will be created by our staff, or directly by you through the [[Special:FormEdit/Organization|appropriate form]], the form itself will create a predefined page model, so you can just fill-in the related sections, provided that your page and its sub-pages can be organized how do you think it is better: the model is to be considered just as a suggestion. Also, each time that you create a content through the related form (for instance an article, a "post", a language course, etc.) and that kind of content is being created for the first time, our platform will automatically create the related intermediate pages, with a list of relevant contents within them: again, these contents are created for convenience, and they can be used as a reference to organize your data in the proper way, but finally all that can be deleted or replaced with contents entirely created **comment start**a formatting entirely decided**comment end** by you. -->
Line 17: Line 18:
 
Create your contents in the language which usually you adopt dealing with your audience. That could be the official language of your hosting country, English (if not all the members of your team are fluent with the local language) or Italian itself. If the main language of your contents is not English or Italian, we require that you create an alternate page in English or Italian at least for the primary pages: otherwise, a generic audience will not be able to access those pages, given that the main purpose of this platform is precisely the interrelation among organizations and their audience.-->
 
Create your contents in the language which usually you adopt dealing with your audience. That could be the official language of your hosting country, English (if not all the members of your team are fluent with the local language) or Italian itself. If the main language of your contents is not English or Italian, we require that you create an alternate page in English or Italian at least for the primary pages: otherwise, a generic audience will not be able to access those pages, given that the main purpose of this platform is precisely the interrelation among organizations and their audience.-->
  
 
+
*If you don't have an IT department, and you need a bit of time to get used with a Mediawiki system, just send your website (the main page and the set of sub-pages representing your organization) to the editorial staff as a collection of "Word" or, preferably, Open Office/LibreOffice documents, with placeholders for pictures (to be attached separately), tables, and other rich content within them, and the editorial staff will create all your organization's pages on your behalf. (as a courtesy).<br> By doing so, just check the following [[Istituto_cultura_italiana_(NGO)|organization's page]] as a reference of a possible "site" structure, and the set of forms to be found [[How_it_works/Forms_%26_semantic_data|here]] in order to put together a meaningful set of data. For instance, once that you know that the form "article", is structured [[Special:FormEdit/Article|this way]], you can just create an Open Office/LibreOffice document for each article, post, or "news", with all the required information, so that the editorial staff will not have to get back to you with further requirements. The same applies for all the forms which can be found in the [[How it works/Forms & semantic data|same page]]. (to be noted that the example organization does not use yet all the available forms)
===Interface overview===
 
 
 
 
 
*Check the list of forms on the side panel on the left (picture 1) [[File:How it works/Tips & guidelines/panel_forms.jpg|thumb|picture 1]] 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.
 
 
 
*Other pieces of the interface to be noted before starting are the link "My organization" still in the left navigation panel (picture 4) [[File:How it works/Tips & guidelines/panel_my_organization.jpg|thumb|picture 4]] and the link "Create or edit page" right below. (picture 5) [[File:How it works/Tips & guidelines/panel_create_or_edit_page.jpg|thumb|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) [[File:How_it_works/Tips_&_guidelines/Wiki_top_menu.jpg|alt=|thumb|422x422px|picture 6]] with the button "Edit", through which you can access the [https://en.wikipedia.org/wiki/Wikipedia:VisualEditor 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.
 
 
 
 
 
 
 
 
 
 
 
  
 
<!--
 
<!--
  
 
*By contrast to what you would expect, '''wiki is not user-friendly'''. This, indeed, at first may hurt you, but actually that is the requisite to create not only quality contents, but also contents not constrained in a specific formatting standard. For this reason, we strongly encourage you to initiate a cooperation with your IT (information technology) department to send forth and back to it your contents, in order to reach the desired results shortly. Of course, also your students with some IT skill might be involved in that work. However, inasmuch as they are typically good, their expertise could be not sufficient, and the final revision of your pages should be always reviewed by professionals.
 
*By contrast to what you would expect, '''wiki is not user-friendly'''. This, indeed, at first may hurt you, but actually that is the requisite to create not only quality contents, but also contents not constrained in a specific formatting standard. For this reason, we strongly encourage you to initiate a cooperation with your IT (information technology) department to send forth and back to it your contents, in order to reach the desired results shortly. Of course, also your students with some IT skill might be involved in that work. However, inasmuch as they are typically good, their expertise could be not sufficient, and the final revision of your pages should be always reviewed by professionals.
<noinclude>
+
 
 
*Because the point above, <html><span style="font-size: 32px;line-height: 1em;padding-right: 6px" class="BroadcastMatter">Cultura italiana</span></html> foresees that you can send such contents to the email address <span style="color:blue;background:#f5f5f5">redazione@culturaitaliana.org</span> and the editorial staff will create for you your organization's pages, for free. However, this is not the best solution on the long term since by this way you will be prevented to structure your pages in an autonomous way and the editorial staff will be required to ask you all the necessary information via email, and you will have to address continuously to them for any non-minor editing.
 
*Because the point above, <html><span style="font-size: 32px;line-height: 1em;padding-right: 6px" class="BroadcastMatter">Cultura italiana</span></html> foresees that you can send such contents to the email address <span style="color:blue;background:#f5f5f5">redazione@culturaitaliana.org</span> and the editorial staff will create for you your organization's pages, for free. However, this is not the best solution on the long term since by this way you will be prevented to structure your pages in an autonomous way and the editorial staff will be required to ask you all the necessary information via email, and you will have to address continuously to them for any non-minor editing.
  

Latest revision as of 08:17, 18 July 2021

Once that you are provided with an account, and consequently with the privileges to edit your organization's page and sub-pages, just keep in mind the following principles and guidelines.

  • Thus Mediawiki and wiki text are not precisely user-friendly (for a legitimate reason, that is precisely to encourage the creation of quality contents) we have provided this platform with all the tools to make the creation and editing of contents as easy and profitable as possible, in such a way that supposedly any member of a center of Italian culture and language with an average IT literacy, will be able to create and edit all the required information, and to address himself or herself either to the IT department of their organization or to the editorial staff of this platform, only to enhance the general structure of their pages, or to fix some issue.
  • Privileges for editing and accessing pages throughout this platform are automatically handled. Typically, an account managed by a given center of Italian culture and language, can edit only the pages of the organization to which it is affiliated, and can create contents of public interest (like Opportunities, Reading suggestions, open source books) as long as they are being created through a form (see picture 1, which displays a list visible in the side panel once logged-in) or as long they have been created using the same account.
  • After signing up, your organization's page and sub-pages will be only accessible and editable by your staff and the administrators of Cultura italiana and they will not yet be visible to the general audience. Once that your organization's page and its related pages will reach a sufficient level of completeness, they will be "enabled" by site-administrators and from that moment you, as organization, will be fully responsible of your pages, and any page that you create/edit/delete/move (within your "domain") will be not anymore moderated in any way.
  • Any new additional page that you create is automatically set as "draft", that is, it gets an unpublished state. Please check Page status & SEO to find out more about that feature: you can publish it as soon as is ready for that and even to set some meta information intended to search engines.
  • Once it has been created, the page of your organization contains a standard content model, that is a predefined set a sections (like Abstract, Location, Gallery, Courses, etc.) that you can use to organize your contents. Of course they are so just as an example, and everything can be reorganized as you think it's better. However, contents/pages created using available forms (like Post, Article, and so on – check Semantic forms and structured data for all available kind of contents) will be saved at a specific path, like [your organization]/Articles/[article name] and the intermediate pages (in this case the page "Articles") will be created as well if not existing, and filled-in with with an ask query to display a table of related contents. Of course this is done for convenience, but again contents created, either automatically or not, can be edited/rearranged in whatever way.
  • In a first time, please create all your organization's contents either in English or Italian, inasmuch as the contents of this platform are not only addressed to your specific audience, but to other organizations as well (or in the first place), so they can be accessible by a common language, or "lingua franca" (English for the international community, and the national language for the related community. In a second time you can create pages also in the official language of your hosting country, and the internationalization for each of them (i.e., the page's language) will be either automatically determined by our platform, or manually inserted/adjusted by you, in order to show on the front-end pages in a language fitted to visitors.
    Currently (December 2020) we have not yet implemented a method to handle internationalization of the main organization's page itself, inasmuch that should be done on the basis of specific feedback and requirements by organizations interested in that feature.
  • If you don't have an IT department, and you need a bit of time to get used with a Mediawiki system, just send your website (the main page and the set of sub-pages representing your organization) to the editorial staff as a collection of "Word" or, preferably, Open Office/LibreOffice documents, with placeholders for pictures (to be attached separately), tables, and other rich content within them, and the editorial staff will create all your organization's pages on your behalf. (as a courtesy).
    By doing so, just check the following organization's page as a reference of a possible "site" structure, and the set of forms to be found here in order to put together a meaningful set of data. For instance, once that you know that the form "article", is structured this way, you can just create an Open Office/LibreOffice document for each article, post, or "news", with all the required information, so that the editorial staff will not have to get back to you with further requirements. The same applies for all the forms which can be found in the same page. (to be noted that the example organization does not use yet all the available forms)

(to be continued!)