Loading...
Skip to main content
Navigation and related functionality and content
Features
Requirements
Download
Install
Backup
Upgrade
Help
FAQs
Need Assistance ? Join-us live this Thursday, click for info !
Related content
Find
History: Welcome Authors
View published page
Source of version: 57
(current)
^This page ((needs review))^ ! Welcome Authors Thanks for joining the effort to document the progress of Tiki! !! Getting Started as an Author # [https://tiki.org/tiki-register.php?key=randomstring|Register at tiki.org], then [tiki-login.php|login here]. # Read ((About the Tiki Documentation)). # Read the page on our ((Documentation Lifecycle)). # Learn [Documentation+Status#How To Tag|How to Tag] documentation pages effectively. # Browse the ((Documentation Status)) page. # Choose a page to improve (likely something you need help with yourself!, or look for them at ((stub)), for instance). # If content exists on [http://www.tiki.org|tiki.org (tw.o)], transfer the content to documentation page. Be sure to: ** Correctly format the page (based on the [Documentation+Status#How To Tag|How to Tag] information). ** Link the documentation page to/from the tw.o page. # ((Learn by doing)). Newbies are welcome. # If in doubt, ask in the comments area of each page once you become a contributor to the site !! Sources of wisdom In order to improve the documentation, you need wisdom about how the software works. Here are places to look. # __[http://tiki.org|tiki.org]__ -- If you can't find it here, do a search there first. Tiki.org was formerly the main center for documentation, but much of it is now out of date. # __[http://tiki.org/tiki-forums.php|Tiki.org forums]__ -- Post a question in the appropriate forum. # __[http://doc.tiki.org/Tiki19beta.pdf|The 1.9 documentation]__ -- Check the last comprehensive publication of Tiki documentation, which still provides a good overview and information on many features. # __[http://dev.tiki.org|dev.tiki.org]__ -- Search the Tiki developers site. # __[http://irc.tiki.org|irc.tiki.org]__ -- Developers and other users can often be found on IRC chat, but activity varies according to time of day, etc., so please be patient if you ask a question. !! Becoming an expert If you have read and understand the following pages, you will be well on your way to becoming an expert. * Documentation's ((Tiki Manual of Style)) (including Naming Conventions) * ((Documentation status)) * ((Documentation templates)) !!See also *((Editorial Board)) (obsolete) *((Annexes)) (obsolete) !- ---- END OF NEW CONTENT (old content for refactoring) Please read (and follow) these standards. You should also read about our ((Goals|documentation goals)). -=Basic Tiki concepts=- *__Page__: In the Tiki documentation, the term ''page'' is synonymous with ''wiki page.'' *__Feature__: A ''feature'' is a Tiki component that has a distinctive function, such as image galleries, file galleries, FAQs, banners, forums, or blogs. See ((Features)) for an overview of Tiki features. *__Terminology__: Review the ((Glossary|Tiki Glossary)) for additional standard Tiki terminology. -=Documentation integration=- All documentation pages are integrated into a wiki structure. * __Standards__ + ''For examples, see __((Documentation Templates))__.'' + Every page should uniformly follow the ((Tiki Manual of Style)) as applied in ((Requirements)), for example. * __Status__ + The ((Documentation Status)) is the hardcoded and commented version of the structure. If you add new pages, please add them with a visible indication __TO CREATE__ so they can be added to the structure. Cleaning and page moving will occur frequently. -=Required pages=- Each feature requires ''at least'' four pages of documentation. * __Main Page__ + Example Main Page: ((Blog)) + This is the primary page for the feature and should be named based on the feature. It defines and provides a brief overview of the feature. The page should link to any related resources (internal or external). * __User Help__ + Example User Page: ((Blog User)) + This page is for end-users of the feature, this also includes Admins who use their own sites. Organize the __User__ page by ''tasks'' -- what the user wants to accomplish (such as "Creating a New Blog" or "Preventing Other Users From Posting"). Use lots of screenshots and graphics to convey the information. *__Admin Configuration__ + Example Admin Page: ((Blog Config)) + This page provides information that Admins need in order to enable, configure, maintain, and troubleshoot the feature. Include system requirements information, potential impact to other features, or anything else useful to a system administrator. * __Reference__ + Example Reference Page: ((Blog Ref)) + This is page is for additional reference documentation. It includes the following information: ** Permissions relevant to the feature ** Pertinent database tables ** Administrative configuration options ** User options __ML: This idea can be ok for certain large features, but it's overkill for the vast majority of features that should fit on one page. Let's not create pages artificially to try to fit the content into a structure.__ -=Getting started=- If you're [http://tiki.org/tiki-register.php|registered] and [tiki-login.php|logged in], you can get started: #__Choose a topic or feature__ + From the ((Documentation Status)) page, choose a feature to document. #__Find existing content__ + Review [http://tiki.org] to see if documentation exists for the feature. If so, copy it to this site and ((Tiki Manual of Style|reformat it)), as necessary.%%%You may also want to review the [http://de.tiki.org/tikidocs/|old 1.6 TikiWiki documentation] for additional information. #__Write what is missing__ + Create or update the page so that it conforms to the ((Tiki Manual of Style|formatting standards)). Review the ((Documentation Templates|documentation examples)) for additional information, including sample pages. #__Work collaboratively__ + Update ((Documentation Status)) so that other contributors know what you're working on (and what still needs to be done). {PARAM(name="structure")} {ELSE}{redirect page="{{page}}&structure=HomePage+Author"}{PARAM}
Related content
