Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matafokka/bbcode-converter
Provides a class to effectively convert custom BBCode to HTML
https://github.com/matafokka/bbcode-converter
bbcode bbcode-converter bbcode-parser bbcode-to-html gradle html java java-11 java-8 java-library maven maven-repository
Last synced: 5 days ago
JSON representation
Provides a class to effectively convert custom BBCode to HTML
- Host: GitHub
- URL: https://github.com/matafokka/bbcode-converter
- Owner: matafokka
- License: lgpl-3.0
- Created: 2020-05-04T18:32:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-31T19:24:10.000Z (about 3 years ago)
- Last Synced: 2024-09-25T20:51:12.996Z (8 days ago)
- Topics: bbcode, bbcode-converter, bbcode-parser, bbcode-to-html, gradle, html, java, java-11, java-8, java-library, maven, maven-repository
- Language: Java
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# BBCode Converter
A Java library that provides a class to effectively convert custom BBCode to HTML. Also prevents XSS attacks.
Grab it from maven:
```xml
io.github.matafokka
bbcode-converter
1.0
```
Or for your building system from code [here](https://search.maven.org/artifact/io.github.matafokka/bbcode-converter/1.0/jar).
You can find the documentation [here](https://javadoc.io/doc/io.github.matafokka/bbcode-converter/latest/io/github/matafokka/bbcode_converter/BBCodeConverter.html).
# Intro
First of all, you've got 3 types of so-called "tags":
1. **Simple tags**. These tags contains only one so-called part (string), i.e. "\[B\]", that will be replaced with another string, i.e. "\". These tags shouldn't be closed. Also, this tags contains HTML entities.
1. **Complex tags**. These tags can contain 2 or 3 parts. Check [addComplexTag()](https://javadoc.io/static/io.github.matafokka/bbcode-converter/1.0/io/github/matafokka/bbcode_converter/BBCodeConverter.html#addComplexTag(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)) for more information.
1. **URL entites**. Same as simple tags, but these will be used when parsing text between 1st and 2nd parts of a complex tag.
Next, you need to know these rules:
1. All tags are case-dependent. Don't add all the cases by yourself! Apply a code-style to your project, i.e. all tags should be either in a lower case or in a upper case.
1. BBCodeConverter will escape all necessary HTML and URL entities. You don't need to add it by yourself.
1. Put the output of toHtml() into `` block. This is needed to deal with bad markup.
**List of included tags:**
Click to expand
**Tags added anyways**
**Simple tags:**
```
" => "
' => '
< => <
> => >
```
**URL entities:**
```
" => %22
' => %27
; => %3B
< => %3C
> => %3E
```
**Tags added when addDefaultTags = true**
**Simple tags:**
```
[B] =>
[/B] =>
[I] =>
[/I] =>
[U] =>
[/U] =>
[S] =>
[/S] =>
```
**Complex tags:**
```
[URL="http:// "] [/URL]
V V V
"
[URL="https:// "] [/URL]
V V V
"
[COLOR=" "] [/COLOR]
V V V
```
# How to use
0. Import the project :D
```java
import io.github.matafokka.bbcode_converter.BBCodeConverter
```
1. Make an instance of this class:
```java
// With all default tags included
BBCodeConverter conv = new BBCodeConverter();
BBCodeConverter conv = new BBCodeConverter(true);
// Only with necessary tags (HTML and URL-entities):
BBCodeConverter conv = new BBCodeConverter(false);
````
2. Add your custom tags:
```java
conv.addSimpleTag(...);
conv.addComplexTag(...);
conv.addUrlEntity(...);
```
3. Use your converter:
```java
String output = conv.toHtml(input);
```
4. Put the output to your page or whatever. **DO NOT** escape the output!