Rename annotation to marker

README.md

@@ -35,41 +35,41 @@ $ go get github.com/upsidr/importer/cmd/importer@v0.0.1-rc2
 
 <!-- == imptr: getting-started-example-short / begin from: ./docs/getting-started/examples.md#[simple] == -->
 
-Let's see what Importer does with the file in this repository [`./testdata/simple-before.md`](https://raw.githubusercontent.com/upsidr/importer/main/testdata/simple-before.md).
+Let's see what Importer does with the file in this repository [`./testdata/markdown/simple-before.md`](https://raw.githubusercontent.com/upsidr/importer/main/testdata/simple-before.md).
 
 ```markdown
 # Simple Markdown Test
 
-<!-- == imptr: lorem / begin from: ../docs/template/_lorem.md#5~12 == -->
+<!-- == imptr: lorem / begin from: ../../docs/template/_lorem.md#5~12 == -->
 
 Any content here will be removed by Importer.
 
 <!-- == imptr: lorem / end == -->
 
-Content after annotation is left untouched.
+Content after marker is left untouched.
 ```
 
-When you run `importer purge ./testdata/simple-before.md`:
+When you run `importer purge ./testdata/markdown/simple-before.md`:
 
 ```bash
-$ importer purge ./testdata/simple-before.md
-$ cat ./testdata/simple-before.md
+$ importer purge ./testdata/markdown/simple-before.md
+$ cat ./testdata/markdown/simple-before.md
 # Simple Markdown Test
 
-<!-- == imptr: lorem / begin from: ../docs/template/_lorem.md#5~12 == -->
+<!-- == imptr: lorem / begin from: ../../docs/template/_lorem.md#5~12 == -->
 <!-- == imptr: lorem / end == -->
 
-Content after annotation is left untouched.
+Content after marker is left untouched.
 ```
 
-When you run `importer generate ./testdata/simple-before.md`:
+When you run `importer generate ./testdata/markdown/simple-before.md`:
 
 ```bash
-$ importer generate ./testdata/simple-before.md
-$ cat ./testdata/simple-before.md
+$ importer generate ./testdata/markdown/simple-before.md
+$ cat ./testdata/markdown/simple-before.md
 # Simple Markdown Test
 
-<!-- == imptr: lorem / begin from: ../docs/template/_lorem.md#5~12 == -->
+<!-- == imptr: lorem / begin from: ../../docs/template/_lorem.md#5~12 == -->
 "Lorem ipsum dolor sit amet,
 consectetur adipiscing elit,
 sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
@@ -80,7 +80,7 @@ Excepteur sint occaecat cupidatat non proident,
 sunt in culpa qui officia deserunt mollit anim id est laborum."
 <!-- == imptr: lorem / end == -->
 
-Content after annotation is left untouched.
+Content after marker is left untouched.
 ```
 
 <!-- == imptr: getting-started-example-short / end == -->
@@ -122,30 +122,30 @@ You can find actually running CI setup in [`.github/workflows/importer-markdown-
 
 <!-- == imptr: getting-started-github-action / end == -->
 
-## 🖋 Annotations and Markers
+## 🖋 Markers
 
-### Importer Annotation
+### Importer Marker
 
-<!-- == imptr: basic-annotation / begin from: ./docs/getting-started/annotations.md#[basic-annotation] == -->
+<!-- == imptr: basic-marker / begin from: ./docs/getting-started/markers.md#[basic-marker] == -->
 
-An annotation is a simple comment with special syntax, and thus is slightly different depending on file used.
+A marker is a simple comment with special syntax, and thus is slightly different depending on file used.
 
 The below is a simple example for **Markdown**.
 
 ```markdown
 <!-- == imptr: getting-started-install / begin from: ./docs/getting-started/install.md#[homebrew-install] == -->
 ```
 
-![Annotation explained][annotation-explanation]
+![Marker explained][marker-explanation]
 
-[annotation-explanation]: /assets/images/annotation-explanation.png "Annotation Explanation"
+[marker-explanation]: /assets/images/marker-explanation.png "Marker Explanation"
 
-And there has to be a matching "end" annotation. This is much simpler, as options are all defined in the "begin" annotation.
+And there has to be a matching "end" marker. This is much simpler, as options are all defined in the "begin" marker.
 
 ```markdown
 <!-- == imptr: getting-started-install / end == -->
 ```
 
-<!-- == imptr: basic-annotation / end == -->
+<!-- == imptr: basic-marker / end == -->
 
-You can find more about the Importer Annotation [here](./docs/getting-started/annotations.md).
+You can find more about the Importer Marker [here](./docs/getting-started/markers.md).

docs/details/details.md

@@ -16,11 +16,11 @@ That's why Importer was created. You can stick to simple file format, but when i
 
 ## Implementation Details
 
-Importer is a simple regular expression file reader. It looks for special Importer Annotation comment, which has no meaning in that given language, but Importer can parse such comment and wires up other file content. [You can find more about Importer Annotation here.](../getting-started/annotatinos.md)
+Importer is a simple regular expression file reader. It looks for special Importer Marker comment, which has no meaning in that given language, but Importer can parse such comment and wires up other file content. [You can find more about Importer Marker here.](../getting-started/annotatinos.md)
 
 In language like Markdown and YAML, a single file is made to be as is, meaning you cannot import other files. This makes them really simple and easy to get started, but when you try to do something a bit more involved, it becomes difficult to maintain very quickly.
 
-Because Importer tries to be "dumb", it doesn't actually know much about the given file syntax. Importer looks for Importer Annotation comments, parses them, and generates the updated version of that file, with specified lines imported into it.
+Because Importer tries to be "dumb", it doesn't actually know much about the given file syntax. Importer looks for Importer Marker comments, parses them, and generates the updated version of that file, with specified lines imported into it.
 
 Because the goal of Importer is very simple, the implementation is based on simple regular expressions. It is not made to be performant, nor capable of handling complex scenarios. But it works for most cases, such as Markdown and YAML. Other file typse may benefit from this approach. If there is any other file types that could benefit from this, we will look to expand our support in the future.
 
@@ -43,22 +43,22 @@ Importer is planning to support YAML files in the near future.
 
 Currently, `importer generate` takes in a file argument, and updates the file content in place.
 
-Instead, we are aiming to provide `importer update` to provide the same feature, while `importer generate` to output the result to stdout. This allows having a separate file that contains Importer Annotations, and a generated file as a separate file.
+Instead, we are aiming to provide `importer update` to provide the same feature, while `importer generate` to output the result to stdout. This allows having a separate file that contains Importer Markers, and a generated file as a separate file.
 
 ### Add `graph` command
 
-Currently, Importer only looks at the provided argument and its Import Target Files. When the Target File contains another Importer Annotation, it would be better to update the Target File content first.
+Currently, Importer only looks at the provided argument and its Import Target Files. When the Target File contains another Importer Marker, it would be better to update the Target File content first.
 We will need much better processing than simple regex handling, and abstract syntax tree needs to be created for this command. Also, this command needs to ensure there is no cyclic dependencies in the Importer definitions.
 
-### Support line brak in Importer Annotation and Export Marker
+### Support line brak in Importer Marker and Exporter Marker
 
-Currently Importer Annotation and Export Marker have to be a single line input. If you have a line break in them, it will be ignored. This is because how it's currently implemented, and fixing this would require a proper AST setup when parsing a file.
+Currently Importer Marker and Exporter Marker have to be a single line input. If you have a line break in them, it will be ignored. This is because how it's currently implemented, and fixing this would require a proper AST setup when parsing a file.
 
-### Add special annotations `ignore` to skip Importer run
+### Add special markers `ignore` to skip Importer run
 
 When having an automation such as `find . -name '*.md' -exec importer generate {} \;`, you may want to skip some files.
 
-This shouldn't skip Export Marker handling, though.
+This shouldn't skip Exporter Marker handling, though.
 
 ### Add `diff` command
 

docs/details/roadmap.md

@@ -16,22 +16,22 @@ Importer is planning to support YAML files in the near future.
 
 Currently, `importer generate` takes in a file argument, and updates the file content in place.
 
-Instead, we are aiming to provide `importer update` to provide the same feature, while `importer generate` to output the result to stdout. This allows having a separate file that contains Importer Annotations, and a generated file as a separate file.
+Instead, we are aiming to provide `importer update` to provide the same feature, while `importer generate` to output the result to stdout. This allows having a separate file that contains Importer Markers, and a generated file as a separate file.
 
 ### Add `graph` command
 
-Currently, Importer only looks at the provided argument and its Import Target Files. When the Target File contains another Importer Annotation, it would be better to update the Target File content first.
+Currently, Importer only looks at the provided argument and its Import Target Files. When the Target File contains another Importer Marker, it would be better to update the Target File content first.
 We will need much better processing than simple regex handling, and abstract syntax tree needs to be created for this command. Also, this command needs to ensure there is no cyclic dependencies in the Importer definitions.
 
-### Support line brak in Importer Annotation and Export Marker
+### Support line brak in Importer Marker and Exporter Marker
 
-Currently Importer Annotation and Export Marker have to be a single line input. If you have a line break in them, it will be ignored. This is because how it's currently implemented, and fixing this would require a proper AST setup when parsing a file.
+Currently Importer Marker and Exporter Marker have to be a single line input. If you have a line break in them, it will be ignored. This is because how it's currently implemented, and fixing this would require a proper AST setup when parsing a file.
 
-### Add special annotations `ignore` to skip Importer run
+### Add special markers `ignore` to skip Importer run
 
 When having an automation such as `find . -name '*.md' -exec importer generate {} \;`, you may want to skip some files.
 
-This shouldn't skip Export Marker handling, though.
+This shouldn't skip Exporter Marker handling, though.
 
 ### Add `diff` command
 

docs/getting-started/examples.md

@@ -2,41 +2,41 @@
 
 <!-- == export: simple / begin == -->
 
-Let's see what Importer does with the file in this repository [`./testdata/simple-before.md`](https://raw.githubusercontent.com/upsidr/importer/main/testdata/simple-before.md).
+Let's see what Importer does with the file in this repository [`./testdata/markdown/simple-before.md`](https://raw.githubusercontent.com/upsidr/importer/main/testdata/simple-before.md).
 
 ```markdown
 # Simple Markdown Test
 
-<!-- == imptr: lorem / begin from: ../docs/template/_lorem.md#5~12 == -->
+<!-- == imptr: lorem / begin from: ../../docs/template/_lorem.md#5~12 == -->
 
 Any content here will be removed by Importer.
 
 <!-- == imptr: lorem / end == -->
 
-Content after annotation is left untouched.
+Content after marker is left untouched.
 ```
 
-When you run `importer purge ./testdata/simple-before.md`:
+When you run `importer purge ./testdata/markdown/simple-before.md`:
 
 ```bash
-$ importer purge ./testdata/simple-before.md
-$ cat ./testdata/simple-before.md
+$ importer purge ./testdata/markdown/simple-before.md
+$ cat ./testdata/markdown/simple-before.md
 # Simple Markdown Test
 
-<!-- == imptr: lorem / begin from: ../docs/template/_lorem.md#5~12 == -->
+<!-- == imptr: lorem / begin from: ../../docs/template/_lorem.md#5~12 == -->
 <!-- == imptr: lorem / end == -->
 
-Content after annotation is left untouched.
+Content after marker is left untouched.
 ```
 
-When you run `importer generate ./testdata/simple-before.md`:
+When you run `importer generate ./testdata/markdown/simple-before.md`:
 
 ```bash
-$ importer generate ./testdata/simple-before.md
-$ cat ./testdata/simple-before.md
+$ importer generate ./testdata/markdown/simple-before.md
+$ cat ./testdata/markdown/simple-before.md
 # Simple Markdown Test
 
-<!-- == imptr: lorem / begin from: ../docs/template/_lorem.md#5~12 == -->
+<!-- == imptr: lorem / begin from: ../../docs/template/_lorem.md#5~12 == -->
 "Lorem ipsum dolor sit amet,
 consectetur adipiscing elit,
 sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
@@ -47,7 +47,7 @@ Excepteur sint occaecat cupidatat non proident,
 sunt in culpa qui officia deserunt mollit anim id est laborum."
 <!-- == imptr: lorem / end == -->
 
-Content after annotation is left untouched.
+Content after marker is left untouched.
 ```
 
 <!-- == export: simple / end == -->
@@ -68,7 +68,7 @@ Any content here will be removed by Importer.
 
 <!-- == imptr: lorem / end == -->
 
-Content after annotation is left untouched.
+Content after marker is left untouched.
 EOF
 
     # Create a file with Lorem Ipsum in a separate file
@@ -110,30 +110,30 @@ $ importer preview /tmp/importer-example.md
 Content Before:
 0:      # Simple Markdown Test
 1:
-2:      <!-- == imptr: lorem / begin from: ../docs/template/_lorem.md#5~12 == -->
+2:      <!-- == imptr: lorem / begin from: ../../docs/template/_lorem.md#5~12 == -->
 3:
 4:      Any content here will be removed by Importer.
 5:
 6:      <!-- == imptr: lorem / end == -->
 7:
-8:      Content after annotation is left untouched.
+8:      Content after marker is left untouched.
 ---------------
 
 ---------------
 Content After Purged:
 0:      # Simple Markdown Test
 1:
-2:      <!-- == imptr: lorem / begin from: ../docs/template/_lorem.md#5~12 == -->
+2:      <!-- == imptr: lorem / begin from: ../../docs/template/_lorem.md#5~12 == -->
 3:      <!-- == imptr: lorem / end == -->
 4:
-5:      Content after annotation is left untouched.
+5:      Content after marker is left untouched.
 ---------------
 
 ---------------
 Content After Processed:
 1:      # Simple Markdown Test
 2:
-3:      <!-- == imptr: lorem / begin from: ../docs/template/_lorem.md#5~12 == -->
+3:      <!-- == imptr: lorem / begin from: ../../docs/template/_lorem.md#5~12 == -->
 4:      "Lorem ipsum dolor sit amet,
 5:      consectetur adipiscing elit,
 6:      sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
@@ -144,15 +144,15 @@ Content After Processed:
 11:     sunt in culpa qui officia deserunt mollit anim id est laborum."
 12:     <!-- == imptr: lorem / end == -->
 13:
-14:     Content after annotation is left untouched.
+14:     Content after marker is left untouched.
 ---------------
 
 You can replace the file content with either of the commands below:
 
 - 'importer generate testdata/simple-before.md'
   Replace the file content with the processed file, importing all annotated references.
 - 'importer purge testdata/simple-before.md'
-  Replace the file content by removing all data between annotation pairs.
+  Replace the file content by removing all data between marker pairs.
 
 You can find more with 'importer help'
 ```
@@ -182,7 +182,7 @@ The below is how the file would look like after `importer purge` and `importer g
 <!-- == imptr: lorem / begin from: ./lorem.md#5~12 == -->
 <!-- == imptr: lorem / end == -->
 
-Content after annotation is left untouched.
+Content after marker is left untouched.
 ```
 
 </details>
@@ -208,7 +208,7 @@ Excepteur sint occaecat cupidatat non proident,
 sunt in culpa qui officia deserunt mollit anim id est laborum."
 <!-- == imptr: lorem / end == -->
 
-Content after annotation is left untouched.
+Content after marker is left untouched.
 ```
 
 </details>