GeoGebra Manual

GeoGebra manual is contained in the wiki: ​http://wiki.geogebra.org/en/Manual:Main_Page

Information for translators & contributors is contained in following pages

• ​http://wiki.geogebra.org/en/GeoGebraWiki:Translation
• ​http://wiki.geogebra.org/en/GeoGebraWiki:HowTo

This trac page is meant to contain information about the more technical things that may be important for developers and wiki administrators.

Accessing manual from GeoGebra projects

Instead of hardocoding whole URLs, it is better to use redirects (see examples below). These are meant to

1. be working regardless any changes in the wiki
2. give you the wiki page in desired language when possible or in a fallback language (English in most cases, de_DE for de_AT)

Examples

• http://www.geogebra.org/help/de/command/Point -- takes you to the german page about Point command
• http://www.geogebra.org/help/fr/tool/New_Point -- takes you to the french page about New Point tool
• http://www.geogebra.org/help/zh_TW/article/Main_Page -- takes you to the chinese main page

How it works

These are routed via .htaccess to the script /help/search2.php which uses wiki's API to give you the correct page. The script first checks the English page, checks interwiki links from there and takes you to the target wiki. If the translation is not present or is not linked from English wiki, English wiki is opened. The script also uses files in /help/redirect_cache for en_AU => en_US, en_GB => en_US, de_AT => de_DE redirects. The folder is named "cache", but currently it is created manually.

Entry points in GeoGebra

Entry points (other than command / tool pages) are defined in Application

        public static final String WIKI_OPERATORS = "Predefined Functions and Operators";
	public static final String WIKI_MANUAL = "Manual:Main Page";
	public static final String WIKI_TUTORIAL = "Tutorial:Main Page";
	public static final String WIKI_EXPORT_WORKSHEET = "Export_Worksheet_Dialog";
	public static final String WIKI_ADVANCED = "Advanced Features";
	public static final String WIKI_TEXT_TOOL = "Insert Text Tool";

The WIKI_ADVANCED is (currently)not used. To access help from a button, you may use geogebra.util.HelpAction:

helpAction = new HelpAction(app, app.getImageIcon("help.png"),app.getMenu("Help"), Application.WIKI_EXPORT_WORKSHEET);
helpButton.setAction(helpAction);

You may also use openHelp / openCommandHelp / openToolHelp methods of GuiManger directly.

Starting a new wiki

• Check out wiki branch from SVN: ​http://geogebra.org/svn/branches/wiki, you may need to sync properties from trunk
• Edit geogebra.wiki.ReadyLocales to cantain the locales for wikis you want to start (say we are adding Interlingua (ia) wiki)
• Run geogebra.wiki.ImportGenerator to obtain import_ia.xml,LocalSettings-ia.php, data_ia.sql, list_ia.txt
• Copy LocalSettings-ia.php and import_ia.xml to /wiki on the server
• Run data_ia as SQL command on the server
• Edit LocalSettings.php and add ia to allowedLocales array
• Run following commands in the /wiki folder:

  php maintanence/importDump.php internationalDump.xml -w=ia
  php maintanence/importDump.php import_ia.xml -w=ia
  php maintenance/rebuildall.php -w=ia
  rm import_ia.xml
  

Adding interwiki links

You will need to download pywikipedia bot, enter the Bot's credentials and run interwiki script. You will need to specify list of articles you want the bot to crawl -- use list_ia.txt file produced in previous step for that.

PDF Manual

• ​http://wiki.geogebra.org/en/Manual:Book contains list of included pages (generated by BookGenerator in wiki branch)
• by clicking the links in the upper part you can create PDF or ODT manual
• problem: math. <math> works (although not nicely) in PDF, but is missing in ODT; \(...\) (which is used in most cases) is transcribed as is, no math rendering.
• index, TOC: in PDF we have no index, but we have TOC. In ODT we should be able to generate both.

Manual for 5.0

Comming soon :)