Difference between revisions of "GeoGebra Manual:HowTo"

From GeoGebra Manual
Jump to: navigation, search
(Created page with 'This page contains instructions how to perform common task in this wiki. '''If you are searching for tutorials and instructions for GeoGebra itself, please visit the [[Tutorials:...')
 
m (Updated tool names)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This page contains instructions how to perform common task in this wiki. '''If you are searching for tutorials and instructions for GeoGebra itself, please visit the [[Tutorials:Main Page|Tutorial section]].'''
+
{{attention|This page contains instructions how to perform common task in this wiki. '''If you are searching for tutorials and instructions for GeoGebra itself, please visit the [[Tutorial:Main Page|Tutorial section]].'''}}
  
== How to add a new command ==
+
GeoGebra manual consists of two components
  
As said above all command-pages actually consists of two pages. To add a new -official- command to the wiki it's hence necessary to create two pages.  
+
;Manual namespace:Official manual pages that are meant for translation. Their content is created by several users and supervised by developers. You need to ask for the right to edit these pages at [[GeoGebraWiki_Talk:Village Pump]].
 +
;Public space manual:Anybody can contribute to this manual. The Manual namespace page is included into the public one, so all official information is both. Source of each such page begins with <nowiki><!-- DO NOT EDIT -->{{:Manual:{{PAGENAME}}}}<!-- END: DO NOT EDIT --></nowiki>.
  
=== Create the official-version page ===
+
{{example|There is page [[Manual:Point Tool]], which is included into [[Point Tool]].}}
# Create a new page called "Manual:NAME Command". NAME is a placeholder for the name of the command, for e.g. the circle command page will be called "Manual:Circle Command".  
+
== Roadmap ==
# It's recommended to use an existing page like [[Manual:Circle Command]] as a starting point for your own command-page, so copy the source into your new page. The wiki [http://en.wikipedia.org/wiki/Help:List#List_basics definition-list syntax] is used to list the different versions of one command.  
+
# Everybody is welcome to contribute to the public space manual
# This page will contain the official manual and should be blocked by an administrator after creation.
+
# Some volunteers for manual namespace are also welcome.
 +
== How to contribute to public space manual ==
 +
# You will need account on this wiki. There is no way to transfer accounts from old wiki.
 +
# Make sure that your planned contribution is specific for one command / feature. Otherwise consider creating a [[tutorial]].
 +
# Use the Edit link of page you want to edit.
 +
# To make wiki more usable, use [[Help:Link|links]] where it is suitable.
 +
# For writing your contribution use the wiki syntax (see [[Help:Contents]]) and suitable templates. Please have a look at [[:Category:Markup templates]].
 +
# If you think that some content is badly formated, written in poor English, worth deleting/merging and you don't have time or skill to fix it, please use suitable [[:Category:Message templates]] to inform about it. Don't use the generic mbox template.
 +
==How to contribute to manual namespace==
 +
# Ask at [[GeoGebraWiki_Talk:Village Pump]] for the rights.
 +
# Use the conventions mentioned for the public space
 +
# Each Manual namespace page has an [[:Category:Info templates|info template]]. Before editing the template inclusion please read the template's documentation (you shouldn't need to do it though).
 +
# Categories in which the page belongs are given by the ''Info template''. Please see documentation of each template for details.
 +
# If you want some changes to be done in info templates themselves, use talk page of that template.
 +
# Missing pages are listed in [[:Category:Unfinished (4.0)]]
  
=== Create the public page ===
+
==Common Problems==
# Now create a new page called "NAME Command". This page will later be used by the users to view the command's definition and to add own comments, tips, etc.
 
# The text below can be used as a starting point for this page.
 
# Save this page and the command should automatically be added to the list of commands visible in [[:Category:Commands|this category]].
 
  
Starting point for the public page:
+
=== LaTeX ===
 +
LaTeX code containing <code>{{</code> or <code>}}</code> is not working in some situations (e.g. in examples or notes). Make sure you leave a space between two consecutive braces of the same type to avoid this problem.
  
<nowiki><!-- DO NOT EDIT -->{{:Manual:{{PAGENAME}}}}<!-- END: DO NOT EDIT --></nowiki><br /><br />
+
<code><nowiki>{{example|before <math>\sqrt{\frac{\sqrt{x^2} }{2} }</math> after}}</nowiki></code> gives
<nowiki>[[Category:Commands]]</nowiki>
+
{{example|before <math>\sqrt{\frac{\sqrt{x^2} }{2} }</math> after}}
 +
while
 +
<code><nowiki>{{example|before <math>\sqrt{\frac{\sqrt{x^2}}{2}}</math> after}}</nowiki></code>
 +
doesn't work.
 +
Another solution is to replace <code>{</code> with <code>&amp;#123;</code> and <code>}</code> with <code>&amp;#125;</code>.
 +
 
 +
===Outdated category listings, missing page reports etc.===
 +
If you create the public page of Wiki manual first and the manual page after, you have to edit the public page once more (just edit + save, not necessary to do any changes) to ensure the page appears in category given by the used template. Also if you fix broken link in Manual or Template namespace, it may still appear on list of broken links until you edit all pages that use given template / manual page. In case it is matter of one or two pages, please do this "empty edit" yourself. If multiple pages are affected, plese describe the problem to [[User_talk:Bot#Rebuild_requests_4|Bot]] or contact the administrators.

Latest revision as of 23:02, 26 November 2013


GeoGebra manual consists of two components

Manual namespace
Official manual pages that are meant for translation. Their content is created by several users and supervised by developers. You need to ask for the right to edit these pages at GeoGebraWiki_Talk:Village Pump.
Public space manual
Anybody can contribute to this manual. The Manual namespace page is included into the public one, so all official information is both. Source of each such page begins with <!-- DO NOT EDIT -->{{:Manual:{{PAGENAME}}}}<!-- END: DO NOT EDIT -->.
Example: There is page Manual:Point Tool, which is included into Point Tool.

Roadmap

  1. Everybody is welcome to contribute to the public space manual
  2. Some volunteers for manual namespace are also welcome.

How to contribute to public space manual

  1. You will need account on this wiki. There is no way to transfer accounts from old wiki.
  2. Make sure that your planned contribution is specific for one command / feature. Otherwise consider creating a tutorial.
  3. Use the Edit link of page you want to edit.
  4. To make wiki more usable, use links where it is suitable.
  5. For writing your contribution use the wiki syntax (see Help:Contents) and suitable templates. Please have a look at Category:Markup templates.
  6. If you think that some content is badly formated, written in poor English, worth deleting/merging and you don't have time or skill to fix it, please use suitable Category:Message templates to inform about it. Don't use the generic mbox template.

How to contribute to manual namespace

  1. Ask at GeoGebraWiki_Talk:Village Pump for the rights.
  2. Use the conventions mentioned for the public space
  3. Each Manual namespace page has an info template. Before editing the template inclusion please read the template's documentation (you shouldn't need to do it though).
  4. Categories in which the page belongs are given by the Info template. Please see documentation of each template for details.
  5. If you want some changes to be done in info templates themselves, use talk page of that template.
  6. Missing pages are listed in Category:Unfinished (4.0)

Common Problems

LaTeX

LaTeX code containing {{ or }} is not working in some situations (e.g. in examples or notes). Make sure you leave a space between two consecutive braces of the same type to avoid this problem.

{{example|before <math>\sqrt{\frac{\sqrt{x^2} }{2} }</math> after}} gives

Example: before \sqrt{\frac{\sqrt{x^2} }{2} } after

while {{example|before <math>\sqrt{\frac{\sqrt{x^2}}{2}}</math> after}} doesn't work. Another solution is to replace { with &#123; and } with &#125;.

Outdated category listings, missing page reports etc.

If you create the public page of Wiki manual first and the manual page after, you have to edit the public page once more (just edit + save, not necessary to do any changes) to ensure the page appears in category given by the used template. Also if you fix broken link in Manual or Template namespace, it may still appear on list of broken links until you edit all pages that use given template / manual page. In case it is matter of one or two pages, please do this "empty edit" yourself. If multiple pages are affected, plese describe the problem to Bot or contact the administrators.

© 2020 International GeoGebra Institute