Pelican style Markdown metadata (Issue #1923) #2805

ralsina · 2017-05-28T23:43:43Z

This uses the markdown "meta" extension to read metadata in a manner compatible with Pelican (Issue #1923)

It still presents a few problems:

Performance: file is read and converted twice.
This doesn't really support translated sources, same problem is present in ipynb plugin, because it uses
source_path instead of translated_source_path. OTOH, translated_source_path doesn't work yet at this stage :-P

Kwpolska · 2017-05-29T14:02:56Z

nikola/plugins/compile/markdown/__init__.py

+        if lang is None:
+            lang = LocaleBorg().current_lang
+        # FIXME: what about translations????
+        source = post.source_path


post.translated_source_path(lang)

Also, note that Pelican uses Title-Cased metadata fields, and has some different names.

translated_source_path sort of crashes, I need to debug that. Code in ipynb plugin has the same problem.

I'll probably lower-case the keys then.

…o md-metadata

ralsina · 2017-05-29T20:29:51Z

From invariance results, it seems this is taking priority over actual explicit metadata (at least for title) which is not good, I think.

Kwpolska · 2017-05-30T10:41:15Z

nikola/plugins/compile/rest/__init__.py

+            lang = LocaleBorg().current_lang
+        source = post.translated_source_path(lang)
+
+        with io.open(source, 'r', encoding='utf-8') as inf:


There should be a way to globally disable this.

Good point.

Kwpolska · 2017-05-30T10:43:47Z

docs/manual.txt

+   title: How to make money
+   slug: how-to-make-money
+   date: 2012-09-15 19:52:05 UTC
+


needs docs for reST thing (here and in changelog)

Kwpolska · 2017-05-30T11:10:35Z

nikola/post.py

        for lang in self.translations:
-            if os.path.isfile(get_translation_candidate(self.config, self.source_path, lang)):
-                self.translated_to.add(lang)


Perhaps we should add a fallback to get_translation_candiate if self.translated_to is empty? There also seems to be a lang != self.default_lang case that will return the source path (shouldn’t it be flipped?)

Not really sure. I'll try to take a harder look.

Kwpolska · 2017-05-30T11:14:27Z

nikola/plugins/compile/rest/__init__.py

+        source = post.translated_source_path(lang)
+
+        with io.open(source, 'r', encoding='utf-8') as inf:
+            document = docutils.core.publish_doctree(


I’m not a reST expert, but perhaps there is a way to make this reusable and store it for compile_string?

Also, we might need to remove field lists from the output, if metadata is imported.

Yeah to both things. We can probably keep the doctree somewhere in the Post object and reuse it if it's there.

Same about markdown, actually.

Kwpolska · 2017-05-30T11:15:52Z

.gitignore

@@ -195,5 +195,5 @@ Session.vim
 *~

 # Demo for Bagguette


this should be at the top, before the gitignore.io template starts

Ok, changing it.

Kwpolska · 2017-05-30T11:20:52Z

-<meta property="article:published_time" content="2012-03-30T23:00:00-03:00">
+<meta property="article:published_time" content="2013-12-31T23:59:59Z">

Somehow, the .. date: from Nikola comment metadata is ignored and replaced by the invariant date (over here).

Kwpolska · 2017-05-30T11:48:26Z

Sites using post-list crash:

  File "/Users/kwpolska/git/nikola/nikola/plugins/compile/rest/post_list.py", line 181, in run
    filename = self.state.document.settings._nikola_source_path
AttributeError: 'Values' object has no attribute '_nikola_source_path'

Possible fixes: set that attribute in the metadata thing; disable directives in the metadata thing; make that line failsafe. (@ralsina, you decide)

Kwpolska

LGTM, but you may want to squash before merging.

Kwpolska · 2017-06-02T09:20:05Z

CHANGES.txt

+  USE_REST_DOCINFO_METADATA option, defaulting to False (Issue #1923)
+* New HIDE_REST_DOCINFO option, defaulting to False.
+* Support for Markdown Meta extension for Pelican
+  compatibility (Issue #1923)


add note about the needed settings

Kwpolska · 2017-06-02T09:21:49Z

nikola/nikola.py

@@ -604,6 +604,7 @@ def __init__(self, **config):
            'USE_BUNDLES': True,
            'USE_CDN': False,
            'USE_CDN_WARNING': True,
+            'USE_REST_DOCINFO_METADATA': False,


'HIDE_REST_DOCINFO': False,

Kwpolska · 2017-06-02T09:22:00Z

.gitignore

@@ -14,6 +17,8 @@ output/

 # All of .idea should be ignored
 .idea/
+.vscode/


Oh, someone’s trying out a new editor!

And I really like it! except the git "support" which is garbage.

ralsina added 4 commits May 28, 2017 20:42

Pelican style Markdown metadata (Issue #1923)

2e4169b

Merge branch 'master' into md-metadata

221d40c

docs

5814dbb

docs

08da62f

Kwpolska reviewed May 29, 2017

View reviewed changes

ralsina and others added 9 commits May 29, 2017 20:35

Merge branch 'master' into md-metadata

08bc2be

lowercase keys for Pelican-style metadata

78e1f9b

Merge branch 'md-metadata' of https://github.com/getnikola/nikola int…

9856574

…o md-metadata

reordered code so translated_source_path works earlier

4f72951

Use translated_source_path to get metadata out of ipynb files

fd2a791

lint

4531fd9

minor [ci skip]

0f2a3c3

Get metadata from reSt docinfo and title. Don't get title from regexps

5385b80

remove tests for deleted code

eebb77e

Kwpolska requested changes May 30, 2017

View reviewed changes

Roberto Alsina added 12 commits May 30, 2017 10:28

Flag to enable/disable docinfo metadata

990a546

Remove docinfo from output

5dc6956

don't assume

cb5fe79

Missing docstring.

94972b2

pedantry

5897f2d

Merge branch 'master' into md-metadata

68ee056

make post-list work

921ae9f

separate HIDE_REST_DOCINFO option

885776d

oops

d618395

Lint

06299db

Lint

925e6a0

damned

6f1fff6

Roberto Alsina added 4 commits June 1, 2017 12:50

damned

d22f12f

damned

f353bc1

damned

d38c10e

ignore more

78516fb

Kwpolska approved these changes Jun 2, 2017

View reviewed changes

ralsina added 3 commits June 2, 2017 18:01

Merge branch 'master' into md-metadata

b019065

minor doc fix

64fe90d

Add default

136bd84

ralsina changed the title ~~(WIP) Pelican style Markdown metadata (Issue #1923)~~ Pelican style Markdown metadata (Issue #1923) Jun 2, 2017

describe how to enable markdown metadata in changelog

94f1b24

ralsina merged commit f1dbc21 into master Jun 2, 2017

ralsina deleted the md-metadata branch June 2, 2017 16:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pelican style Markdown metadata (Issue #1923) #2805

Pelican style Markdown metadata (Issue #1923) #2805

ralsina commented May 28, 2017 •

edited

Kwpolska May 29, 2017

ralsina May 29, 2017

ralsina commented May 29, 2017

Kwpolska May 30, 2017

ralsina May 30, 2017

Kwpolska May 30, 2017

Kwpolska May 30, 2017

ralsina May 30, 2017

Kwpolska May 30, 2017

ralsina May 30, 2017

Kwpolska May 30, 2017

ralsina May 30, 2017

Kwpolska commented May 30, 2017

Kwpolska commented May 30, 2017

Kwpolska left a comment

Kwpolska Jun 2, 2017

Kwpolska Jun 2, 2017

Kwpolska Jun 2, 2017

ralsina Jun 2, 2017

Pelican style Markdown metadata (Issue #1923) #2805

Pelican style Markdown metadata (Issue #1923) #2805

Conversation

ralsina commented May 28, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ralsina commented May 29, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kwpolska commented May 30, 2017

Kwpolska commented May 30, 2017

Kwpolska left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ralsina commented May 28, 2017 •

edited