mirror of
https://github.com/overleaf/overleaf.git
synced 2024-12-12 10:53:34 -05:00
903c1110e0
[learn] sanitize the wiki content GitOrigin-RevId: c114bbd94479e926c0621953fe9c03f6d380a19d
32 lines
1.6 KiB
Markdown
32 lines
1.6 KiB
Markdown
# Usage
|
|
|
|
```
|
|
node scripts/learn/checkSanitize https://LEARN_WIKI
|
|
```
|
|
|
|
## Bulk export
|
|
|
|
There is a bulk export for media wiki pages, but it produces different
|
|
html escaping compared to the regular parse API we use in web.
|
|
|
|
The bulk export does not escape all the placeholder HTML-like elements,
|
|
like `<project-id` or `<document goes here>`.
|
|
|
|
## Example output
|
|
|
|
Here is how a missing tag gets flagged:
|
|
|
|
```
|
|
---
|
|
page : MediaWiki markup for the Overleaf support team
|
|
title : MediaWiki markup for the Overleaf support team
|
|
match : false
|
|
toText : false
|
|
text : "Overleaf</strong></td>\n </tr>\n <tr><td>Kb/<strong>TITLE_SLUG</strong></td><td><nowiki>https://www.overleaf.com/learn/how-to/</nowiki><strong>TITLE_SLUG</strong></td>\n </"
|
|
sanitized : "Overleaf</strong></td>\n </tr>\n <tr><td>Kb/<strong>TITLE_SLUG</strong></td><td><nowiki>https://www.overleaf.com/learn/how-to/</nowiki><strong>TITLE_SLUG</strong></td>\n "
|
|
textToText : " \n \n \n \n MediaWiki page\n Maps to on Overleaf\n \n Kb/TITLE_SLUGhttps://www.overleaf.com/learn/how-to/TITLE_SLUG\n "
|
|
sanitizedToText: " \n \n \n \n MediaWiki page\n Maps to on Overleaf\n \n Kb/TITLE_SLUG<nowiki>https://www.overleaf.com/learn/how-to/</nowiki>TITLE"
|
|
```
|
|
|
|
Note the hidden/escaped `<nowiki>` element.
|
|
In addition to the side-by-side comparison of HTML you will see a plain-text diff.
|