Previous discussion: CDDSCLab/Database-Optimization/issues/7

hi, @PiotrNewt, @ehds
@huge-melon init a repo to hold the weekly group meeting topic, paper list and brief summary. There is already one about database transaction shared by him.

• Usually there are more than one paper at a time, so we present it by topic. The topic is organized by shared time currently, as sharing increases, we might consider adding categories by topic and might archived them by semester or year.
• We put the papers list into the summary doc rather than README to make the README concise.
• The summary doc is in Chinese now to reduce written time, we also hope we can use pure English in the future.

Any suggesion and discussion are appreciate.

PR format discussion

discussion are welcome.

Preview

Summary of talk

Date:

Topic:

Keywords:

Format check List

• Conforming to English specifications especially in README.md.
• Capitalize the first letter.
• Use English punctuation with appropriate space.
• ...
• Remember to add links to reference papers.
• Make sure the link is accessible.
• Use - to connect filename rather than , the latter will casue dead link.
• Make sure latex formulas display normally, more can be found in.

Key points

Dispaly latex formulas in github flavored markdown

1. Github has supported mathematical expressions in markdown , more information please refer to this blog. 🎉🎉🎉

2. readme2tex.

3. rendor latex formula to image with Github official service.
   https://render.githubusercontent.com/render/math?math=

   • Vscode extension math to image.

   • Use a scripts, a simple example in python, style ref is math to image, code ref repo.
     Save as python script and run python3 script-filename.py target-markdown-filename.md.

   import sys
   import re
   from urllib.parse import quote
   # $$
   # formula
   # $$
   interline_tag = '\n<img src="https://render.githubusercontent.com/render/math?math={}" class="ee_img tr_noresize" eeimg="1">\n'
   interline_pattern = '\$\$\n*((.|\n)*?)\n*\$\$' # (.|\n) . or \n
   # $formula$
   inline_tag = '<img src="https://render.githubusercontent.com/render/math?math={}" class="ee_img tr_noresize" eeimg="1">'
   inline_pattern = '\$\n*(.*?)\n*\$'
   
   def replace_tex(content):
   	def dashrepl_quote(matchobj, tag):
   		formular = matchobj.group(1)
                   # quote & to %26 etc in $$ x&= a+1$$, otherwise, thers will be error when render with githubusercontent.com
   		formular = quote(formular) 
   		return tag.format(formular, formular)
   
   	content = re.sub(interline_pattern, lambda mo: dashrepl_quote(mo, interline_tag), content)
   	content = re.sub(inline_pattern, lambda mo: dashrepl_quote(mo, inline_tag), content)
   
   	return content
   
   if __name__=='__main__':
   	assert len(sys.argv) > 1, "Error: need filename as a argument"
   	filename = sys.argv[1]
   	with open(filename, mode='r',encoding='utf-8') as f:
   		content = f.read()
   	with open(filename, mode='w',encoding='utf-8') as f:
   		f.write(replace_tex(content))

   Rendering multi-line formula example with githubusercontent:

   $$
   \begin{align}
   x = v_0\cos\theta t\\
   y = v_0\sin\theta t - \frac{1}{2}gt^2
   \end{align}
   $$

   

   $$
   \begin{align}
   x &= v_0\cos\theta t\\
   y &= v_0\sin\theta t - \frac{1}{2}gt^2
   \end{align}
   $$

   

   $$
   x = v_0\cos\theta t\\
   y = v_0\sin\theta t - \frac{1}{2}gt^2
   $$

   

   Please use \begin{align} to display in rows.
   More discussion in stackoveflow.