[WIP] Change draft, private and mathjax to own metadata (#2761) #3066

felixfontein · 2018-04-26T22:34:40Z

First try. Hacked together on a train ride. More will follow during the next days :)

Kwpolska

I think we should at least deprecate the tags feature and convince users to convert their input files, and definitely don’t mention the old tags as much in the docs.

Kwpolska · 2018-04-27T16:01:59Z

nikola/conf.py.in

+
+# If set to True, the tags 'draft', 'mathjax' and 'private' have special
+# meaning. If set to False, these tags are handled like regular tags.
+# USE_TAG_METADATA = True


I wouldn’t mind deprecating the tags in v8, conf.py-defaulting this to False, and providing a plugin that can upgrade posts from the old format to the new.

I'll give the plugin a shot tomorrow.

Kwpolska · 2018-04-27T16:03:34Z

nikola/plugins/command/import_wordpress.py

        if status == 'trash':
            LOGGER.warn('Trashed post "{0}" will not be imported.'.format(title))
            return False
        elif status == 'private':
-            tags.append('private')
+            if self.site.config['USE_TAG_METADATA']:


Don’t bother.

Kwpolska · 2018-04-27T16:04:52Z

nikola/post.py

-                self._tags[lang].remove('private')
+            status = self.meta[lang].get('status')
+            if status:
+                if status == 'published':


rewrite this, make it shorter (three lines above, one line in each if block)

I rewrote this, but not completely: I don't want to update post_status in case status has an invalid value. (Of course, we could turn this into an error. But it might screw up existing blogs which for whatever reason used status metadata already...)

That would be me and the projectpages plugin (I guess I’ll make it devstatus from now on.)

Kwpolska · 2018-04-27T16:05:32Z

nikola/post.py

@@ -312,14 +343,28 @@ def _has_pretty_url(self, lang):

    @property
    def is_mathjax(self):


This could be renamed to has_math for consistency and neatness.

Should we keep a is_mathjax dummy which logs that an update needs to be done to the theme, and returns the new has_math value? Otherwise, we might break some custom themes.

This is v8, feel free to break themes. (They should switch to math_helper.tmpl anyways.)

felixfontein · 2018-04-28T11:20:57Z

I've now taken a look at your upgrade_metadata plugin. A plugin for this case will be much more complicated: we have two-file posts and one-file posts, we have various metadata extraction plugins, and various metadata formats. Are you sure we want to support everything? Or should I restrict myself to classic ReST-style metadata?

… new sites with the new system.

Kwpolska · 2018-04-28T17:21:44Z

Re upgrader plugin: this should be doable, as metadata extractors can also write to files. If posts don’t know what extractor data comes from, that could be changed — or we could just let users modify their post themselves.

Kwpolska · 2018-04-28T17:30:45Z

Bonus feature request: support .. status: featured in a similar way. Will come in handy for the planned extensions to bootblog4.

felixfontein · 2018-04-29T11:18:42Z

I've added featured as a valid state. I'll take a look at the converter plugin again soon (definitely not today though).

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Kwpolska

LGTM (with very minor fixes I applied)

Kwpolska · 2018-05-01T18:30:17Z

nikola/post.py

+                    show_warning = True
+                if show_warning:
+                    LOGGER.warn('It is suggested that you convert special tags to metadata and set ' +
+                                'USE_TAG_METADATA to False. You can use the XXX command plugin for ' +


Remove that sentence about this plugin for the time being so we can merge this more quickly.

Bonus code style hint: you do not need + to join two strings literals separated by whitespace.

felixfontein · 2018-05-01T20:32:33Z

CHANGES.txt

@@ -20,8 +20,8 @@ Features
 --------

 * Tags ``draft``, ``private`` and ``mathjax`` are no longer treated
-  special if ``USE_TAG_METADATA`` is set to ``True`` (default for


Good catch! Thanks :)

felixfontein · 2018-05-01T20:33:05Z

nikola/post.py

@@ -359,13 +359,13 @@ def has_math(self):
            return True
        lang = nikola.utils.LocaleBorg().current_lang
        if self.is_translation_available(lang):
-            if self.meta[lang].get('has_math') in ('true', 'True', 'yes'):
+            if self.meta[lang].get('has_math') in ('true', 'True', 'yes', '1', 1, True):


felixfontein · 2018-05-01T20:38:22Z

Ok. I guess we can merge this for now; I'll open a new PR for the plugin then.

Kwpolska · 2018-05-01T20:38:59Z

Thanks for getting this done!

felixfontein · 2018-05-01T20:40:40Z

Thanks for reviewing and merging!

felixfontein added the in progress label Apr 26, 2018

felixfontein added this to the v8.0.0 milestone Apr 26, 2018

felixfontein self-assigned this Apr 26, 2018

getnikola deleted a comment Apr 26, 2018

getnikola deleted a comment Apr 27, 2018

Kwpolska requested changes Apr 27, 2018

View reviewed changes

felixfontein added 7 commits April 28, 2018 13:22

First shot at #2761.

4d6010c

Using has_math in manual.

f04d952

Changing defaults to convice people to stop using this, and to set up…

cd2ab6b

… new sites with the new system.

Don't add tags in WordPress import.

ce0af0d

is_mathjax -> has_math.

453ce33

Added changes and improved warning.

5a5b3d2

Allow 'yes', 'true' and 'True' as truish values for has_math.

61ebd06

felixfontein force-pushed the implement-2761 branch from f06db0b to 61ebd06 Compare April 28, 2018 11:23

Allowing post state 'featured'.

2096af0

Kwpolska added 5 commits April 29, 2018 16:07

Minor documentation fixes

290e457

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Merge branch 'master' into implement-2761

b08ee3f

Update changelog to match master

a7815b1

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Fix changelog typos [ci skip]

00a6751

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Accept more values for has_math

1e184d8

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Kwpolska reviewed May 1, 2018

View reviewed changes

Kwpolska approved these changes May 1, 2018

View reviewed changes

felixfontein commented May 1, 2018

View reviewed changes

Remove hint on plugin (for now).

51f3e7f

Kwpolska merged commit af3c6a1 into master May 1, 2018

Kwpolska deleted the implement-2761 branch May 1, 2018 20:38

felixfontein mentioned this pull request May 1, 2018

[WIP] Conversion plugin for #2761 #3068

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Change draft, private and mathjax to own metadata (#2761) #3066

[WIP] Change draft, private and mathjax to own metadata (#2761) #3066

felixfontein commented Apr 26, 2018

Kwpolska left a comment

Kwpolska Apr 27, 2018

felixfontein Apr 27, 2018

Kwpolska Apr 27, 2018

felixfontein Apr 28, 2018

Kwpolska Apr 27, 2018

felixfontein Apr 28, 2018

Kwpolska Apr 28, 2018

Kwpolska Apr 27, 2018

felixfontein Apr 27, 2018

Kwpolska Apr 27, 2018

felixfontein Apr 28, 2018

felixfontein commented Apr 28, 2018

Kwpolska commented Apr 28, 2018

Kwpolska commented Apr 28, 2018

felixfontein commented Apr 29, 2018

Kwpolska left a comment

Kwpolska May 1, 2018

Kwpolska May 1, 2018

felixfontein May 1, 2018

felixfontein May 1, 2018

felixfontein May 1, 2018

felixfontein commented May 1, 2018

Kwpolska commented May 1, 2018

felixfontein commented May 1, 2018

		@@ -312,14 +343,28 @@ def _has_pretty_url(self, lang):

		@property
		def is_mathjax(self):

[WIP] Change draft, private and mathjax to own metadata (#2761) #3066

[WIP] Change draft, private and mathjax to own metadata (#2761) #3066

Conversation

felixfontein commented Apr 26, 2018

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

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

felixfontein commented Apr 28, 2018

Kwpolska commented Apr 28, 2018

Kwpolska commented Apr 28, 2018

felixfontein commented Apr 29, 2018

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

Choose a reason for hiding this comment

felixfontein commented May 1, 2018

Kwpolska commented May 1, 2018

felixfontein commented May 1, 2018