利用者:Mindrones/Wiki/Proposals/2009/Ref
目次
Structure
Actual situation
Calling a "branch" the first pseudo-folder in urls, these are the bigger branches in wiki's "Main" namespace. This is quite flat, since there aren't sub-levels other than these (except for Scripts that is quite structured):
Tutorials (many languages) Manual (many languages) BSoD (many languages) Reference (many languages) Release notes (some languages) Scripts BlenderDev Requests (many languages - should be under BlenderDev) Hackers Guide (should be under BlenderDev) GameEngine GameEngineDev Yafraydev (small) Bf-documentation Bf-institute Books Competitive analysis Sandbox Meta
There are many others, but they "contain" a few pages.
Ton's proposal
This is what Ton proposed in bf-docboard mailing list:
See also 2.3: http://download.blender.org/documentation/htmlI/ http://download.blender.org/documentation/htmlII/ Her's my raw picture how to classify documents; - Learning Blender - general workflow tutorials (creating projects) - feature related tutorials (i.e. texturing) - Manual (descriptive overviews by feature) - UI conventions - Blender files - Modeling - Materials/shaders - Game engine - Python overview - etc - Reference (editors, buttons, menus, hotkeys etc) - Installation - User presets - Screens/areas - 3D window - Ipo window - etc - Extending Blender - Python - Plugins - Contributions - stuff to be reviewed - feature proposals - case studies - and everything that's not classifyable, or opiniated, or too personal :)
Here we have the chapters structure in the old manual.
PART I
I. Introduction to Blender 1. Introduction 2. Installation 3. Understanding the interface Blender's Interface Concept Navigating in 3D Space The vital functions 4. Your first animation in 30 + 30 minutes II. Modelling, Materials and Lights 5. ObjectMode 6. Basic Mesh Modelling 7. Advanced Mesh Modelling 8. Meta Objects 9. Curves and Surfaces 10. Materials and Textures 11. Textures 12. Lighting 13. The World and The Universe III. Animation 14. Animation of Undeformed Objects 15. Animation of Deformations 16. Character Animation IV. Rendering 17. Rendering 18. Radiosity 19. Raytracing V. Advanced Tools 20. Particles 21. Other Effects 22. Special modelling techniques 23. Soft bodies 24. Volumetric Effects 25. Sequence Editor VI. Extending Blender 26. Python Scripting 27. Blender's Plugins System VII. Beyond Blender 28. Yafray as an Integrated External Renderer 29. From Blender to YafRay Using YableX 30. YafRay Glossary
PART II
I. Reference Blender windows - general introduction HotKeys In-depth Reference Windows Reference Buttons Reference Command Line Arguments II. Appendices Hotkeys Reference Supported videocards The Licenses The Blender Documentation Project Troubleshooting (-)
テンプレート:Meta:Bots/Python/mwclient
テンプレート:Meta:Bots/Python/mwclient/wiki tree graph
Useful wiki extensions
ImageMap
http://www.mediawiki.org/wiki/Extension:ImageMap
Captcha
- http://www.mediawiki.org/wiki/Extension:ReCAPTCHA
problema: si deve loggare a loro, se i loro server sono giù tu non ti logghi, e forse neanche vedi la pagina - http://www.mediawiki.org/wiki/Extension:VisualMathCaptcha
TagAsCategory
- http://www.mediawiki.org/wiki/Extension:TagAsCategory
<<We also recommend changing the "Categories" label to "Tags". This can be done by going to the "Special:Allmessages" page, and changing the value of "pagecategories" from "Categories" to "Tags".>>
VERY USEFUL TO LET PEOPLE ADD CATEGORIES WITHOUT EDITING THE SOURCE CODE - http://www.mediawiki.org/wiki/Extension:ManageCategories
Useful to see all categories, might serve well to avoid reposting similar categories
DOESN'T WORK HERE ATM
Todo_Tasks
http://www.mediawiki.org/wiki/Extension:Todo_Tasks
DynamicPageList
http://www.mediawiki.org/wiki/Extension:DynamicPageList
CodeTag
http://www.mediawiki.org/wiki/Extension:GeSHiCodeTag
Workflow
- workflow
http://www.mediawiki.org/wiki/Extension:Workflow
useful for release notes to wiki and for establishing tasks like draft/forapproval/final etc - comments system
http://www.mediawiki.org/wiki/Extension:WordPress_Comments
useful for not using the talk page anymore, not familiar to all the users
http://www.mediawiki.org/wiki/Extension:ArticleComments
testing..
Comment systems
- http://www.mediawiki.org/wiki/Extension:ArticleComments
ADD COMMENTS DIRECTLY IN THE TALK PAGE, WITH AUTHOR AND DATE, THIS IS A BIG PROBLEM INDEED IN WIKI, CAUSE YOU HAVE TO PUT YOUR DETAILS BY HAND
SUPER COOL :) - http://www.mediawiki.org/wiki/Extension:CommentPages
I'VE TRIED THIS, IT WORKS BUT IT DEPENDS ON WHETER PEOPLE UNDERSTAND THE DIFFERENCE BETWEEN TALKPAGE AND COMMENTPAGE. Commented a line because it gives an error.[1] - http://www.mediawiki.org/wiki/Extension:WordPress_Comments
useful for not using the talk page anymore, not familiar to all the users
Rating and reviewing systems
- have to test this but this sounds useful since ii's commenting +rating+captcha
- this is fine if you try this on suggested websites that use it
Searching engines
- Sphinx
- Google_Custom_Search_Engine
- Lucene
(more complex to install than a simple extensions)
Site map
http://www.mediawiki.org/wiki/Extension:ManualSitemap useful to help searching from outside the wiki
Blogging via mail
Retrieving categories and tags via python/xmlrpc
Since WordPress uses an XML-RPC interface, we can setup a simple script to retrieve categories and tags from a blog. This is a very simple example I made for a blog I admin:
#! /usr/bin/env python import xmlrpclib from pprint import pprint server = xmlrpclib.ServerProxy("http://dirittianimali.wordpress.com/xmlrpc.php") user = 'USERNAME' pwd = 'PASSWORD' print '\nCATEGORIES:\n'+'='*50 pprint(server.wp.getCategories('',user,pwd)) print '\nTAGS:\n'+'='*50 pprint(server.wp.getTags('',user,pwd))
It outputs data as lists of dictionaries (here I print them of course) so we might use them for adding categories to wiki pages with mwclient for example:
CATEGORIES: [{'categoryDescription': '', 'categoryId': '13514905', 'categoryName': 'adottati', 'description': 'adottati', 'htmlUrl': 'http://dirittianimali.wordpress.com/category/adozioni/adottati/', 'parentId': '750835', 'rssUrl': 'http://dirittianimali.wordpress.com/category/adozioni/adottati/feed/'}, ... {'categoryDescription': '', 'categoryId': '13620180', 'categoryName': 'gatti da adottare', 'description': 'gatti da adottare', 'htmlUrl': 'http://dirittianimali.wordpress.com/category/adozioni/gatti-da-adottare/', 'parentId': '750835', 'rssUrl': 'http://dirittianimali.wordpress.com/category/adozioni/gatti-da-adottare/feed/'}] TAGS: [{'count': '1', 'html_url': 'http://dirittianimali.wordpress.com/tag/ba-bari/', 'name': '(BA) Bari', 'rss_url': 'http://dirittianimali.wordpress.com/tag/ba-bari/feed/', 'slug': 'ba-bari', 'tag_id': '14327151'}, ... {'count': '22', 'html_url': 'http://dirittianimali.wordpress.com/tag/cane/', 'name': 'cane', 'rss_url': 'http://dirittianimali.wordpress.com/tag/cane/feed/', 'slug': 'cane', 'tag_id': '19453'}, ... {'count': '9', 'html_url': 'http://dirittianimali.wordpress.com/tag/gatto/', 'name': 'gatto', 'rss_url': 'http://dirittianimali.wordpress.com/tag/gatto/feed/', 'slug': 'gatto', 'tag_id': '512148'}, ...]
Apart form the obvious benefit of having the application for managing tags already in place, we might also benefit from having RSS feeds of categories and tags. Documenters would only have to read the feed with their RSS feed aggregator of choice (Mozilla Thunderbird for example) to receive commits well categorized.
Example of a "cani-da-adottare" Category page and of a "cani-da-adottare" Category feed.
Example of a "cane" Tag page and of a "cane" Tag feed.
Parsing wikitext
From here, here and here we can extract a list of python scripts that let you convert from wikitext to structures/html/xml/... After a brief look I've chosen these:
- wikimarkup
- mwparser
- SpiffWikiMarkup
- textwiki
- mwlib mwlib
- mw2html (depends on htmldata
- python-markdown2
- pyparsing
With some time at hand we should review them and see what can be useful for our purposes.
See also
External links
discussion in mailing list
- doc-board thread (1)
- doc-board thread (2)
mediawiki
- mediawiki API
- mediawiki API query list
- mwclient (mediawiki bot)
- all wiki extensions matrix
wiki structure graph
- big image of the wiki structure (warning: it's 30MB)
wordpress xmlrpc interface