Difference to Scholarly Markdown

[orschiro]

Hi @smathot,

Many thanks for your academicmarkdown. I am currently trying to figuring out how to effectively use Markdown to write my Master thesis in the field of sustainability studies.

Both Word/LibreOffice as well as LaTeX are no option for me. Thus I was looking into Markdown which I use for many other documents already. So far I only came across Scholarly Markdown which is lead by Martin Fenner under the Common Mark idea.

Could you explain me a little bit more where the differences between Scholarly Markdown and Academic Markdown lie, whether you would recommend me to write my thesis with either of the two and how I can best get started in terms of structuring the required files & folders my thesis as well as best setting up my environment to work in (Arch Linux, Sublime Text, Zotero).

Any tips are very much appreciated!

Robert

[smathot]

Hi Robert,

From what I understand, Scholarly Markdown is more of a think-thank than an actual implementation. So it's not something that can be used right now, except maybe in the sense that you can cherry-pick some of their ideas. In contrast, academicmarkdown is a functional markdown preprocessor that adds some much needed functionality, such as integration with Zotero, figures that you can refer to, etc.

Whether it's a good idea to use academicmarkdown for your thesis depends on how much you enjoy hacking. It works well for me, but I use it in quite specific situations, and it hasn't been tested extensively elsewhere.

Cheers!
Sebastiaan

[orschiro]

Thanks for your opinion Sebastiaan!

I will try to create a package for python-academicmarkdown for Arch
Linux and play around with it to see whether it fits my workflow.

Robert

On 09.12.2014 14:55, Sebastiaan Mathot wrote:

Hi Robert,

From what I understand, Scholarly Markdown is more of a think-thank
than an actual implementation. So it's not something that can be used
right now, except maybe in the sense that you can cherry-pick some of
their ideas. In contrast, |academicmarkdown| is a functional markdown
preprocessor that adds some much needed functionality, such as
integration with Zotero, figures that you can refer to, etc.

Whether it's a good idea to use |academicmarkdown| for your thesis
depends on how much you enjoy hacking. It works well for me, but I use
it in quite specific situations, and it hasn't been tested extensively
elsewhere.

Cheers!
Sebastiaan

—
Reply to this email directly or view it on GitHub
#1 (comment).

Sharing my passion & inspiration for

#sustasty lifestyles #transitions
#OpenSource #Sufficiency
#ResourceEfficiency

Flying is old-school and the
world cannot be saved part-time

Co-Creator of @MindfulMeerkats

www.robert.orzanna.de
twitter.com/@orschiro

[orschiro]

I am currently trying to create a package. I am missing one dependency that I cannot find a package for:

==> Starting package()...
Traceback (most recent call last):
  File "setup.py", line 21, in <module>
    from academicmarkdown import version
  File "/home/orschiro/VCS/PKGBUILD/python-academicmarkdown/src/academicmarkdown-release-0.8.1/academicmarkdown/__init__.py", line 267, in <module>
    from _BaseParser import BaseParser
ImportError: No module named '_BaseParser'
==> ERROR: A failure occurred in package().
    Aborting...

Can you please tell me from which package the BaseParser module comes from?

Thanks!

[orschiro]

Never mind. I found out that academicmarkdown does only work with python2 but not with python3.

You might want to add a link to the Arch Linux package under the installation section of the README:

python2-academicmarkdown

Merry Christmas!

Robert

[smathot]

Hi Robert,

That's awesome, thank you! I'll update the readme shortly.

(And, yes, Python 2 only I'm afraid.)

Cheers,
Sebastiaan

[orschiro]

Great!

You also might want to change the following sentence:

- Academic Markdown is a Python module for generating 
+ Academic Markdown is a Python 2 module for generating 

[ashwinvis]

Some quick questions to @smathot :

And, yes, Python 2 only I'm afraid.

1. I am planning to use this, I might have some energy to port it to Python 3. Is it just syntax which stops Python 3 adoption or some dependencies?

2. Just to be clear, academicmarkdown convert md->html and pandoc does the html->pdf part. Is that how it works? Can it handle LaTeX template classes then?

3. You mention zoteromarkdown in the license docstrings. That was the old name and I guess you forgot to change it?

[smathot]

@ashwinvis Thanks for your interest. I haven't actively developed this in a while (and don't have time to do so), so if you want to work on this, you will have to be fairly self-sufficient! But to answer your questions:

I am planning to use this, I might have some energy to port it to Python 3. Is it just syntax which stops Python 3 adoption or some dependencies?

It is compatible with Python 3 now.

Just to be clear, academicmarkdown convert md->html and pandoc does the html->pdf part. Is that how it works? Can it handle LaTeX template classes then?

AcademicMarkdown preprocesses the md file, which is then converted further by python markdown (to HTML) or pandoc (to PDF).

You mention zoteromarkdown in the license docstrings. That was the old name and I guess you forgot to change it?

Indeed it was!