 Actions

Difference between revisions of "Documentors"

From Joomla! Documentation

m
Line 1: Line 1:
 
{{Documentor profile}}
 
{{Documentor profile}}
 +
==General==
 +
Please be aware that the official language of the project is British/Australian English.  There is a tendency for American spellings to creep into the documentation; feel free to correct these wherever you see them.
  
* If you are new to MediaWiki then you should consult the '''[http://meta.wikimedia.org/wiki/Help:Contents User's Guide]''' for information on using the wiki software.
+
The following material is important for documentators working on all areas of the Joomla! project.
* List of '''[[local wiki templates]]''' that can be used in your wiki pages.  Templates reduce repetition and are the basis of modular documentation.
+
* List of '''[[local wiki extensions]]''' that have been installed on this wiki.  Extensions provide additionally functionality to the wiki such as '''syntax highlighting''' and conditional expressions.
+
* List of '''[[local interwiki links]]''' that are available on this wiki.  These provide useful shortcuts to creating URLs to other websites including the Joomla! forum, help screens and issue tracker; as well as links to the [http://php.net/manual PHP documentation] or [[wikipedia:Main_Page|Wikipedia]].
+
 
* Please read the '''[http://help.joomla.org/workshop/documents/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]'''.
 
* Please read the '''[http://help.joomla.org/workshop/documents/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]'''.
 
* [[Project:Words to watch|Words to watch]]
 
* [[Project:Words to watch|Words to watch]]
* requested but yet [[Special:Wantedpages|empty pages]]
+
 
* [[:Category:Articles that require a review]] also awaiting a copy editor
+
==Documentation wiki==
* [[:Category:Landing Pages|Landing pages in this wiki]]
+
{{:Documentation wiki}}
* Pages that define terms can be added to the [[:Category:Glossary|Glossary]] category by adding <nowiki>[[Category:Glossary]]</nowiki> at the end of the page.
+
==Help screens==
* [[Project:MediaWiki setup notes|MediaWiki setup notes]]
+
The [[Documentation Working Group]] is responsible for writing and maintaining the official help screens.  For Joomla! versions up to and including 1.5.x the help screens must be hosted on a Joomla! instance.  From Joomla! 1.6 onwards the help screens will be hosted on this wiki.
* [[Cookie jar]]
+
* [[Help screens|Joomla! 1.5.x help screens]] are created on this wiki before being moved to [http://help.joomla.org/content/section/42/278/ help.joomla.org]
* [[Creating a Joomla! 1.5 help screens SQL dump]]
+
 
* [[Setting up a local help server]]
 
* [[Setting up a local help server]]
 +
* [http://joomlacode.org/gf/project/joomla/docman/?subdir=6 Help screens SQL dump files] for Joomla! versions up to 1.5.x.

Revision as of 15:09, 12 July 2008

<translate> As a documentor you have the unenviable task of creating material for a wide range of readers from beginning users to advanced professional developers. You will need to know how to use various tools (such as this wiki) and you will need to read guidelines and other meta documents. You will probably need to update those documents over time too.</translate>


General

Please be aware that the official language of the project is British/Australian English. There is a tendency for American spellings to creep into the documentation; feel free to correct these wherever you see them.

The following material is important for documentators working on all areas of the Joomla! project.

Documentation wiki

<translate> The bulk of the documentation effort now revolves around this wiki. </translate> <translate>

  • Please refer to the Docs Wiki Roadmap for a complete overview of tasks.
  • If you are new to MediaWiki then you should consult the User's Guide for information on using the wiki software.
  • There are some conventions for making sure the Wiki remains organized.

</translate> <translate>

</translate> <translate>

  • You might want to take a look at

</translate> <translate>

</translate> <translate>

</translate> <translate>

  • Pages that define terms can be added to the Glossary, but not by adding [[Category:Glossary]] to the page. Please see Talk:Glossary for more information.

</translate> <translate>

Internal References

</translate> {{JDOC:Local wiki references/<translate> en</translate>}}


Help screens

The Documentation Working Group is responsible for writing and maintaining the official help screens. For Joomla! versions up to and including 1.5.x the help screens must be hosted on a Joomla! instance. From Joomla! 1.6 onwards the help screens will be hosted on this wiki.
https://docs.joomla.org/index.php?title=Documentors&diff=9140&oldid=9002
docs.joomla.org
crawl=CC-MAIN-2016-07
41974
application/http; msgtype=response
sha1:5C4TVLRQPHQJM3BNRF6ZGV7XQ2KHBYMG
<urn:uuid:fc94c1d8-d17d-4cab-b339-46ccb2ffcfcc>
2016-02-10T04:08:46Z
72.29.124.152
sha1:5UEF4ABL4GBWPYIQACSJ4XRCZWLIHVK6
<urn:uuid:1eb87d57-ba36-47db-899c-75500f28db8d>
https://docs.joomla.org/index.php?title=Documentors&diff=9140&oldid=9002
length
response
<urn:uuid:8c4f76e2-6fcd-4628-bc48-633ad7fa6f01>
robots: classic
hostname: ip-10-236-182-209.ec2.internal
software: Nutch 1.6 (CC)/CC WarcExport 1.0
isPartOf: CC-MAIN-2016-07
operator: CommonCrawl Admin
description: Wide crawl of the web for February 2016
publisher: CommonCrawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf