Damien Cassou wrote:

On Sun, Jun 1, 2014 at 6:10 PM, Ben Coman<btc@openinworld.com>  wrote:

Yes. I am doing something similar. btw, is it a strong convention that Tex commands and environments are all lowercase? That is, should I force the annotation label in "\begin{note}" to lowercase, or should I pass that through unchanged.

I think you should not change anything. Is it up to the writer to do
something not stupid.

For Markdown, we should probably have the same solution as for HTML.

I had a hunt around and it seems that Markdown doesn't support paragraph styles.  And the workaround specified here...
http://stackoverflow.com/questions/1058933/can-i-define-a-class-name-on-paragraph-using-markdown

apparently does not work on github...
https://github.com/github/markup

in pillar we have both Markdown and GithubMarkdown as export options.
So we can have a solution dedicated to github if required.

But Hey! Check this out...
https://github.com/github/markup/blob/master/CONTRIBUTING.md

Maybe we could add a Pillar-->HTML processor to Github?

There should not be any technical problem to do that. Do you want to
try? I can help if you have problems.

"If your markup is in a language other than Ruby, drop a translator script in lib/github/commands which accepts input on STDIN and returns HTML on STDOUT..."
https://github.com/github/markup/blob/master/lib/github/markups.rb


So it seems that Text and Markdown cannot produce different formatted paragraphs.

for text it is clear. For Markdown I'm still not sure if it is
possible or not. Maybe a<div class=<annotation>>  would work.

In those two cases, I still lean towards putting the annotation label in the output, but I'm happy enough to leave it out.

for text I think we should not change the current export. For
Markdown, I leave the decision to you.

HI Damien,

After adding PRLaTeXWriter>>visitAnnotatedParagraph:, to make the build green I made the following modifications to PFTE.

FILE: CalculatorTutorial/CalculatorTutorial.pier
LaTeX Error: Environment  undefined  "\begin{}"
-@@ TODO
+@@todo
Removed the space after the '@@' and changed todo to lowercase.   Maybe I should have been changed it to a %todo comment, since now it looks like attached file Book-todo.


FILE: ComparingSolutions/ComparingSolutions.pier
LaTeX Error: Environment comment@@ undefined
-@@comment@@ May be you should give one example of an ODE and
+@@comment May be you should give one example of an ODE and

LaTeX Error: Environment comment: undefined
-@@comment: may be you should split the methods with an initialize phase
-@@comment: I simplified the code. If you want I can do a code review
+@@comment may be you should split the methods with an initialize phase
+@@comment I simplified the code. If you want I can do a code review

LaTeX Error: Environment we undefined
-@@we can use the configuration form to load. To verify
+@@note we can use the configuration form to load. To verify

-----
Now I notice...
https://github.com/pillar-markup/pillar-documentation#32-paragraphs-and-framed-paragraphs
says:

An empty line starts a new paragraph.
An annotated paragraph starts a line with @@ followed by either todo or note. For example,
@@note this is a note annotation.
generate
  Note: this is a note annotation.

But this is no longer the case.  As advised I changed it so that Pillar does not hardcode output "Note:".

Actually common.tex does define the 'note' environment to show "Note:" - but that is configurable without changing the Pillar code.

Also, annotations are no longer restricted to just @todo or @@note.  Any annotation can be used so long as a matching environment/style is defined.

So I will update that in the doc.

Also, it says:

@@todo this is a todo annotation
generates a todo annotation that is not visible in the output.

This is no longer the case as I removed this.  This was only being done in PRMarkdownWriter, and I did not see the point over using %todo. Can you confirm that is reasonable? Or did I miss some purpose.

After your reply, I will update that also in the doc.

cheers -ben

---

_______________________________________________
Magritte, Pier and Related Tools ...
https://www.iam.unibe.ch/mailman/listinfo/smallwiki