Practical problems when writing developer documentation in plone.org
Mikko Ohtamaa <mikko+plone-75aZqqp77KCaMPzRcYMCawC/[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.documentation |
|---|---|
| Message-ID | <[email protected]> |
Hi, Here are some things which keep bugging me and I hope some "standards" should be used - preferably both HTML and reST compatible formatting * How to visualize filenames in text, like profiles/default/portal_languages.xml - currently I use italics * How to visualize function names in text like MyClass.function() - currently I do not use any formatting * When talking about packages I link to the package PyPi page and in the case it is useless I link to some useful folder in SVN trunk -Mikko ------------------------------------------------------------------------------ Return on Information: Google Enterprise Search pays you back Get the facts. http://p.sf.net/sfu/google-dev2dev