[Plone-docs] Practical problems when writing developer documentation in plone.org

[Mikko Ohtamaa]

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

[Israel Saeta Pérez]

Post by Mikko Ohtamaa
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

Me too.

Post by Mikko Ohtamaa
* How to visualize function names in text like MyClass.function() -
currently I do not use any formatting

I use <code> </code>, but to do this I have to switch to the HTML view,
which is awkward and slow.

Post by Mikko Ohtamaa
* 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

Me too. :)

-- israel