Skip to content

Eagles2F/HelpGen4Android

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

-- HelpGen4Android 0.3.5 --

Author: Evan Lee(Yifan Li)
Email: thueeliyifan@gmail.com

Mentor: Florin B. Manolache
[Purpose]
This software is trying to help android App developers to automatically generate wiki based help pages in their apps.

[Prerequisite]
BeatifulSoup library 4.2.0 is required
Your wiki must be mediawiki powered

[Github]
https://github.com/Eagles2F/HelpGen4Android

[Manual]
     1. Make sure your mediawiki site has a template page like this:
          https://www.timecat.info/wiki/index.php/TimeCat:Doc:Help

     2. Import HelpGen4Android in your python script:
	from HelpGen4Android.config import configure
	from HelpGen4Android.helpGen import helpGen

     3. Make sure you configure fistly:  
           configure(url='https://www.timecat.info/wiki/index.php/TimeCat:Doc:Help',
			outputDir='Timecat')
     4. Then you could download the help files by:
	   helpGen()	   

[Known Issues]:
	1. Right now, the tool only works with Mediawiki beacause our parsing is specialized designed for mediawiki

[Bug Report]:
	Any bug or documentation error you found , please submit an issue on github parge: https://github.com/Eagles2F/HelpGen4Android

License: 

The MIT License (MIT)

Copyright (c) 2015