JDOC

Come contribuire a Joomla! Documentazione

From Joomla! Documentation

This page is a translated version of the page JDOC:How to Contribute to Joomla! Documentation and the translation is 56% complete.

Other languages:
বাংলা • ‎Deutsch • ‎Ελληνικά • ‎English • ‎español • ‎eesti • ‎فارسی • ‎français • ‎हिन्दी • ‎Bahasa Indonesia • ‎italiano • ‎Nederlands • ‎português • ‎português do Brasil • ‎Türkçe

La documentazione Joomla! è alimentata dallo stesso software usato da Wikipedia. La sua crescita e il suo successo dipende individui come te. Grazie per aver fatto il primo passo per contribuire al progetto Joomla! Questa pagina vi mostrerà come iniziare e diversi modi per aiutare lo sforzo di documentazione.

Come iniziare

Ci sono alcune cose da fare prima.

Leggere la Wiki Policy

È necessario rivedere i documenti di Joomla! Docs Wiki policy prima di iniziare la modifica.

Crea un account utente

TPer modificare il Wiki di documentazione di Joomla, è necessario un account utente. Si può register for one here. Afterwards make sure to confirm your e-mail address. Confirmation of your e-mail address will give you permission to edit any page except for a few that are protected.

Nota: se non si esegue alcuna modifica entro 5 giorni dalla creazione dell'account, l'account verrà automaticamente cancellato per motivi di sicurezza.

Crea una pagina utente

Dopo aver creato un account, confermato il proprio indirizzo e-mail ed effettuato il login, è necessario creare una pagina utente. Un trucco veloce per avviare la tua pagina utente:
  • Nel menu utente, vai alla tua pagina Nome utente (o usa la prima voce del menu all'estrema destra a discesa)
  • Fare clic sul pulsante a discesa delle azioni
    JDOCS-actions-create-page-en.png
  • Fare clic su Crea
  • Aggiungi il codice all'editor {{subst:Newuser}}
  • Fill in summary (e.g. This is my new user page)
    JDOCS-summary-form-input-en.png
  • Fai clic sul pulsante Salva

Iscriviti alla mailing list della documentazione

Dovresti iscriverti alla Docs mail list. Non è necessario, ma ci sono discussioni che ti mancherebbero e che sono rilevanti per la documentazione.

Cosa dovrei fare prima?

Esistono diverse aree di documentazione che richiedono sempre attenzione. Puoi iniziare scegliendo quello che ti è più comodo su cui lavorare o potresti essere più coinvolto lavorando su diversi alla volta. Una volta che hai un account wiki, sei libero di lavorare su qualsiasi aspetto della documentazione che ti piaccia. Anche i contributi più semplici come correzioni ortografiche e correzioni di grammatica sono di enorme aiuto!

  1. Aiuto con il contenuto della documentazione.
  2. Attività di manutenzione.
  3. Partecipa o avvia il progetto di documentazione.
  4. Aiuta con le schermate di aiuto.

Aiuta a gestire i nostri contenuti

  1. Editing, rewriting and reorganising pages. Check our Needs pages for areas needing immediate help. They are called 'Needs pages' because they are in need of small tasks to complete them. Some of them are as simple as reviewing content or adding an image. Others require more content or improvements. Pick a few, give them a little love. This is a tremendous help to Joomla! users who rely on our documentation.
  2. Have some fun and browse for articles which are redundant, out of version(i.e. 1.0 and 1.5), or need to be split up because of version specific information. Then feel free to make use of the {{delete}}, {{merge}} or {{JSplit}} templates on the articles. Click the previous template links to see how to use and apply them to articles you think need these marker templates. Add them to the very top of a page and the page is marked.
  3. Create a new page or tutorial. If you want to start a new page, do some extensive research first. Try not to create a new article if one already exists. Use the search feature of the Docs Wiki to see if your topic is already in an article. Duplication will be merged and/or deleted. Don't be afraid to modify, reformat or improve someone else's work on the Joomla! Docs Wiki! This is a collaborative documentation wiki, just make sure you are following our policy and guidelines.
    1. Using wikilinks. It's very easy to link pages using a standard syntax. If you create a link to an article that doesn't exist yet, the link will be colored red.Clicking a red link will take you to the edit page for the new article. Simply type your text, click save and the new page will be created. Once the page has been created, the link will change from red to blue indicating that the article now exists.
    2. Using the URL. To use when you want to create a page from scratch. You can use the wiki's URL for creating a new page. The URL to an article of the wiki is usually something like this: https://docs.joomla.org/YOURTITLE. If you replace YOURTITLE with the name of the page you wish to create, you will be taken to a blank page which indicates that no article of that name exists yet. Clicking the Create this page link will take you to the edit page for that article, where you can create the new page by typing your text, and clicking Submit.
  4. Help update images in articles. Check the category Needs image updating for a list of pages which need their images updated. Our suggested guidelines to help you are found in the article, Image naming guidelines.

Wiki Maintenance

Maintaining a wiki and keeping it organised takes a lot of continuous work on the part of administrators, editors and users. There are always tasks needing attention such as: Categorisation, attending to pages with needs, that are under construction, or by marking pages for deletion, merging or splitting. For all maintenance tasks and ideas of how you can help, please visit our Documentation Maintenance page.

Documentazione di progetti

  • Il team di docs sta lavorando su Beginner Tutorials. Il nostro obiettivo è quello di renderli facili da capire e da navigare, qualcosa che un principiante può seguire facilmente e imparare i concetti di base. Ripensa a quando eri nuovo a Joomla e aggiungi alla pagina un argomento su qualcosa con cui hai lottato come principiante. Meglio ancora, unisciti al Beginner Tutorials Project.
  • Unisciti al Developer Tutorials Project e condividi le tue conoscenze. Firma il tuo nome usando 4 tildes ( ~~~~ ) sulla pagina Developer Tutorials Project ed elenca ciò che potresti essere in grado di fare. Sentitevi liberi di aggiungere alcuni Topics|tutorial Tutorials Project alla lista degli argomenti suggeriti.

Schermate di aiuto

Unknown to many, all Help Screen pages are created and served to every Joomla! Installation worldwide from this wiki! They are necessary for beginners and even those with intermediate knowledge of Joomla!

The Joomla! 4.x Help Screens need to be completely created. Any contributtion you give to them will be appreciated by many users worldwide and we're looking for volunteers to help with this important task. A matrix needs to be put in place as well as an action plan.

Things to Remember

Here are a few things to remember as a Joomla! Docs contributor.

  • Don't be afraid to break a page, if you do and something has gone really wrong, revert your edit. Click the page's View History tab and you will see links to undo and revert.
  • Write articles with a sense they will be translated to another language. Using slang or local dialect may not translate to another language or its inferences be understood. Find out more about Translating Joomla Documentation.
  • Don't be afraid to download and read the general Joomla! en-GB User Interface Text Guidelines that applies to all Joomla! Documentation. There are helpful hints on how to write for Joomla! Documentation.
  • Words to watch when writing, read the full guideline … or for instant feedback use Google Chrome or Mozilla Firefox browsers. They both have built-in spell checking which underlines a misspelled word.
  • Don't forget to add the {{inuse}} template to an article you are going to be working on it for a long period of time, more than a minute. It helps to prevent editing conflicts.


Help, I don't know Wiki Markup!

Se siete nuovi all'uso di Wikis e del semplice markup per la creazione di pagine, allora potete usare quanto segue come aiuto.

  • Il nuovo WikiEditor contiene pulsanti e collegamenti rapidi per facilitare la costruzione delle pagine. Cliccare la parola 'Advanced' per un menu a tendina con altri pulsanti e link di formattazione rapida.
  • Usa il JDOC's Wiki Cheatsheet per imparare i comandi di base della sintassi. C'è anche un drop down del markup comune nell'editor. Basta cliccare una volta sulla parola 'Help' e apparirà.
  • Still afraid? Try these tools to help you create great wiki pages.
  • Microsoft Word Add-on for Wiki Markup, save Word Docs in Wiki Markup.
  • OpenOffice.org versions 2.4 and later have a MediaWiki export filter built in. Just open a Writer document and click File - Export. Then, change File format to MediaWiki.
  • Here is a list of tools available to convert other formats to wiki markup, e.g. HTML, Excel, CSV. Some of them are online converters, cut and paste HTML for an output in wiki markup.
  • Get help on Glip (we have 2 groups there: one for the Jdocs Translation Group and one for the JDocs Working group).
  • Post a question on an administrator's or editor's talk page.