Page "Proposals/Formats" was added by olemis Comment: Brief introduction to BEP formats Content: -------8<------8<------8<------8<------8<------8<------8<------8<-------- = BEP Formats and Templates =
There are two ''BEP'' formats available to authors: WikiFormatting and [http://docutils.sourceforge.net/rst.html reStructuredText]. Both are UTF-8-encoded text files. WikiFormatting BEPs are written with the well-known structural markup. [./WikiFormatting WikiFormatting BEP Guidelines] provides instructions to work with a [wiki:PageTemplates/Proposals template] you can use to get started writing your ''BEP'' using WikiFormatting. The contents of both have been strongly influenced by [http://www.python.org/dev/peps/pep-0009 PEP 9]. [http://docutils.sourceforge.net/rst.html ReStructuredText] BEPs allow for rich markup that is still quite easy to read, but might result in much better-looking and more functional HTML . This is particularly true for tables. [./RestructuredText reStructuredText BEP Guidelines] provides instructions to work with a [wiki:PageTemplates/ProposalsRst template] for [http://docutils.sourceforge.net/rst.html reStructuredText] BEPs. The contents of both have been strongly influenced by [http://www.python.org/dev/peps/pep-0009 PEP 12]. The wiki is able to convert both styles of BEPs to HTML for viewing on the web. Parsing and conversion of WikiFormatting BEPs is straightforward. [http://docutils.sourceforge.net/rst.html reStructuredText] BEPs have to be parsed and converted by [http://docutils.sourceforge.net/ Docutils] code via WikiProcessors. Therefore you might need to follow [WikiRestructuredText#Requirements these steps] in order to expand [http://docutils.sourceforge.net/rst.html reStructuredText] markup instead of highlighting its syntax. -------8<------8<------8<------8<------8<------8<------8<------8<-------- -- Page URL: <https://issues.apache.org/bloodhound/wiki/Proposals/Formats> Apache Bloodhound <https://issues.apache.org/bloodhound/> The Apache Bloodhound (incubating) issue tracker This is an automated message. Someone added your email address to be notified of changes on 'Proposals/Formats' page. If it was not you, please report to .
