From 9a09fdea1a8d409f3fac04a258e6371270dce69b Mon Sep 17 00:00:00 2001 From: Shaun McCance Date: Fri, 8 May 2020 10:47:33 -0400 Subject: Adding new templates for yelp-new --- templates/concept.duck | 46 +++++++++++++++++++++++ templates/concept.page | 51 +++++++++++++++++++++++++ templates/guide.duck | 48 ++++++++++++++++++++++++ templates/guide.page | 54 ++++++++++++++++++++++++++ templates/reference.duck | 89 +++++++++++++++++++++++++++++++++++++++++++ templates/reference.page | 98 ++++++++++++++++++++++++++++++++++++++++++++++++ templates/task.duck | 62 ++++++++++++++++++++++++++++++ templates/task.page | 51 +++++++++++++++++++++---- 8 files changed, 491 insertions(+), 8 deletions(-) create mode 100644 templates/concept.duck create mode 100644 templates/concept.page create mode 100644 templates/guide.duck create mode 100644 templates/guide.page create mode 100644 templates/reference.duck create mode 100644 templates/reference.page create mode 100644 templates/task.duck diff --git a/templates/concept.duck b/templates/concept.duck new file mode 100644 index 0000000..f07c1d8 --- /dev/null +++ b/templates/concept.duck @@ -0,0 +1,46 @@ +@ducktype/1.0 +[-] yelp-tmpl-desc Explanation of a concept or background information + += @TITLE@ + [topic .concept version=1.1] + +[-- + Recommended statuses: stub incomplete draft outdated review candidate final +--] +@revision[version=0.1 date=@DATE@ status=stub] + +@credit[author copyright] + @name @NAME@ + @email @EMAIL@ + @years @YEAR@ + +[-- + This puts a link to this topic on the index page. + Change the xref to link it from another guide. +--] +@link[guide >index] + +[-- + Think about whether other pages should be in the seealso list. + The target page will automatically get a seealso link back. +@link[seealso >someotherid] +--] + +[-- + Think about whether external resources should be in the seealso + list. These require a title. +@link[seealso >>http://someurl] + @title Link title +--] + +@desc Write a short page description here. + +@keywords comma-separated list, of keywords, for search + + +Provide as many paragraphs, lists, or media as necessary to explain. + +[list] +. Next steps +* Optionally, links to other things the user might do now. +* But consider using seealso and other info links instead. diff --git a/templates/concept.page b/templates/concept.page new file mode 100644 index 0000000..c8edc6c --- /dev/null +++ b/templates/concept.page @@ -0,0 +1,51 @@ + + + + + + + + @NAME@ + @EMAIL@ + @YEAR@ + + + + + + + + + + Write a short page description here. + + comma-separated list, of keywords, for search + + + @TITLE@ + +

Provide as many paragraphs, lists, or media as necessary to explain.

+ + + Next steps +

Optionally, links to other things the user might do now.

 +

But consider using seealso and other info links instead.

 + + diff --git a/templates/guide.duck b/templates/guide.duck new file mode 100644 index 0000000..719d18c --- /dev/null +++ b/templates/guide.duck @@ -0,0 +1,48 @@ +@ducktype/1.0 +[-] yelp-tmpl-desc Navigational glue for Mallard documents + += @TITLE@ + [guide version=1.1] + +[-- + Recommended statuses: stub incomplete draft outdated review candidate final +--] +@revision[version=0.1 date=@DATE@ status=stub] + +@credit[author copyright] + @name @NAME@ + @email @EMAIL@ + @years @YEAR@ + +[-- + This puts a link to this topic on the index page. + Change the xref to link it from another guide. +--] +@link[guide >index] + +[-- + Think about whether other pages should be in the seealso list. + The target page will automatically get a seealso link back. +@link[seealso >someotherid] +--] + +[-- + Think about whether external resources should be in the seealso + list. These require a title. +@link[seealso >>http://someurl] + @title Link title +--] + +@desc Write a short page description here. + +@keywords comma-separated list, of keywords, for search + + +Optionally, an introductory paragraph. + +[-- + The links element is implicit, but you might want to add one + explicitly if you want to do link grouping or styles. +[links topic .STYLE groups="GROUPS"] + . Optional title +--] diff --git a/templates/guide.page b/templates/guide.page new file mode 100644 index 0000000..44e205c --- /dev/null +++ b/templates/guide.page @@ -0,0 +1,54 @@ + + + + + + + + @NAME@ + @EMAIL@ + @YEAR@ + + + + + + + + + + Write a short page description here. + + comma-separated list, of keywords, for search + + + @TITLE@ + +

Optionally, an introductory paragraph.

+ + + + diff --git a/templates/reference.duck b/templates/reference.duck new file mode 100644 index 0000000..c36db72 --- /dev/null +++ b/templates/reference.duck @@ -0,0 +1,89 @@ +@ducktype/1.0 +[-] yelp-tmpl-desc Lists or tables of information for quick lookup + += @TITLE@ + [topic .reference version=1.1] + +[-- + Recommended statuses: stub incomplete draft outdated review candidate final +--] +@revision[version=0.1 date=@DATE@ status=stub] + +@credit[author copyright] + @name @NAME@ + @email @EMAIL@ + @years @YEAR@ + +[-- + This puts a link to this topic on the index page. + Change the xref to link it from another guide. +--] +@link[guide >index] + +[-- + Think about whether other pages should be in the seealso list. + The target page will automatically get a seealso link back. +@link[seealso >someotherid] +--] + +[-- + Think about whether external resources should be in the seealso + list. These require a title. +@link[seealso >>http://someurl] + @title Link title +--] + +@desc Write a short page description here. + +@keywords comma-separated list, of keywords, for search + + +Optionally provide introductory text. +Use terms lists, tables, and bullet lists for reference material. + + +[terms] +. Example terms list (title optional) + +- Term 1 +* Description + +- Term 2 +* Terms can have multiple paragraphs. + + [screen] + Or any other block element. + +- Term 3.1 +- Term 3.2 +* Terms can also have multiple titles. + + +[table] +. Example table (title optional) + +[thead] +[tr] +- Column 1 +- Column 2 + +[tbody] +[tr] +* Row 1, column 1 +* Row 1, column 2 + +[tr] +* Row 2, column 1 +* Row 2, column 2 + + +[list] +. Example list (title optional) + +* Item 1 + +* Item 2 + * Subitem 2.1 + * Subitem 2.2 + +* Item 3 diff --git a/templates/reference.page b/templates/reference.page new file mode 100644 index 0000000..1671db7 --- /dev/null +++ b/templates/reference.page @@ -0,0 +1,98 @@ + + + + + + + + @NAME@ + @EMAIL@ + @YEAR@ + + + + + + + + + + Write a short page description here. + + comma-separated list, of keywords, for search + + + @TITLE@ + +

Optionally provide introductory text. + Use terms lists, tables, and bullet lists for reference material.

+ + + Example terms list (title optional) + + Term 1 + Description + + + Term 2 +

Terms can have multiple paragraphs.

+ Or any other block element. + + + Term 3.1 + Term 3.2 +

Terms can also have multiple titles.

+ + + + + Example table (title optional) + + + + + + + + + + + + + + + + +
Column 1Column 2
Row 1, column 1Row 1, column 2
Row 2, column 1Row 2, column 2
+ + + Example list (title optional) +

Item 1

 + +

Item 2

+ +

Subitem 2.1

 +

Subitem 2.2

 + + +

Item 3

 + + + diff --git a/templates/task.duck b/templates/task.duck new file mode 100644 index 0000000..c0665e1 --- /dev/null +++ b/templates/task.duck @@ -0,0 +1,62 @@ +@ducktype/1.0 +[-] yelp-tmpl-desc Description of how to accomplish a user task + += @TITLE@ + [topic .task version=1.1] + +[-- + Recommended statuses: stub incomplete draft outdated review candidate final +--] +@revision[version=0.1 date=@DATE@ status=stub] + +@credit[author copyright] + @name @NAME@ + @email @EMAIL@ + @years @YEAR@ + +[-- + This puts a link to this topic on the index page. + Change the xref to link it from another guide. +--] +@link[guide >index] + +[-- + Think about whether other pages should be in the seealso list. + The target page will automatically get a seealso link back. +@link[seealso >someotherid] +--] + +[-- + Think about whether external resources should be in the seealso + list. These require a title. +@link[seealso >>http://someurl] + @title Link title +--] + +@desc Write a short page description here. + +@keywords comma-separated list, of keywords, for search + + +Short introductory text: Write a couple sentences about what the +user is doing here, and why they might want to do it. + +[list] +. Prerequisites +* Optionally, list things the user needs to know or do first. +* Use links to other pages whenever they make sense. + +[steps] +. Optional title if different from page title or if prereqs present +* First step... +* Second step... +* Third step... + +Optionally, write expected results if non-obvious. + +[list] +. Next steps +* Optionally, links to other things the user might do now. +* But consider using seealso and other info links instead. + + diff --git a/templates/task.page b/templates/task.page index 225aefe..6b50dcf 100644 --- a/templates/task.page +++ b/templates/task.page @@ -1,8 +1,11 @@ + @@ -11,23 +14,55 @@ @YEAR@ - + + + + + + + + Write a short page description here. + + comma-separated list, of keywords, for search @TITLE@ - - @NAME@ -

This assumes the reader knows how to.... By the end of this page, - the reader will be able to....

- +

Short introductory text: Write a couple sentences about what the + user is doing here, and why they might want to do it.

-

Short introductory text...

+ + Prerequisites +

Optionally, list things the user needs to know or do first.

 +

Use links to other pages whenever they make sense.

 + + Optional title if different from page title or if prereqs present

First step...

Second step...

Third step...

 +

Optionally, write expected results if non-obvious.

+ + + Next steps +

Optionally, links to other things the user might do now.

 +

But consider using seealso and other info links instead.

 + + -- cgit v1.2.1 From df95ca59879b71c6ae7f433834794860c89904d7 Mon Sep 17 00:00:00 2001 From: Shaun McCance Date: Fri, 8 May 2020 10:50:53 -0400 Subject: Add new templates to Makefile.am --- templates/Makefile.am | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/templates/Makefile.am b/templates/Makefile.am index d4bbb75..1535f3a 100644 --- a/templates/Makefile.am +++ b/templates/Makefile.am @@ -1,4 +1,12 @@ tmpldir = $(datadir)/yelp-tools/templates -tmpl_DATA = task.page +tmpl_DATA = \ + concept.duck \ + concept.page \ + guide.duck \ + guide.page \ + reference.duck \ + reference.page \ + task.duck \ + task.page EXTRA_DIST = $(tmpl_DATA) -- cgit v1.2.1 From 20c1b7e84f0c5d1b297e1177ce9bcc78cc483eb6 Mon Sep 17 00:00:00 2001 From: Shaun McCance Date: Tue, 4 Aug 2020 08:55:52 -0400 Subject: Adding docversion and pkgversion to templates --- templates/concept.duck | 3 ++- templates/concept.page | 3 ++- templates/guide.duck | 3 ++- templates/guide.page | 3 ++- templates/reference.duck | 3 ++- templates/reference.page | 3 ++- templates/task.duck | 3 ++- templates/task.page | 3 ++- 8 files changed, 16 insertions(+), 8 deletions(-) diff --git a/templates/concept.duck b/templates/concept.duck index f07c1d8..c349e88 100644 --- a/templates/concept.duck +++ b/templates/concept.duck @@ -6,8 +6,9 @@ [-- Recommended statuses: stub incomplete draft outdated review candidate final + Remove version attributes you don't use. --] -@revision[version=0.1 date=@DATE@ status=stub] +@revision[version=0.1 docversion=0.1 pkgversion=0.1 date=@DATE@ status=stub] @credit[author copyright] @name @NAME@ diff --git a/templates/concept.page b/templates/concept.page index c8edc6c..92fbbb8 100644 --- a/templates/concept.page +++ b/templates/concept.page @@ -5,8 +5,9 @@ - + @NAME@ diff --git a/templates/guide.duck b/templates/guide.duck index 719d18c..61cd746 100644 --- a/templates/guide.duck +++ b/templates/guide.duck @@ -6,8 +6,9 @@ [-- Recommended statuses: stub incomplete draft outdated review candidate final + Remove version attributes you don't use. --] -@revision[version=0.1 date=@DATE@ status=stub] +@revision[version=0.1 docversion=0.1 pkgversion=0.1 date=@DATE@ status=stub] @credit[author copyright] @name @NAME@ diff --git a/templates/guide.page b/templates/guide.page index 44e205c..894b276 100644 --- a/templates/guide.page +++ b/templates/guide.page @@ -5,8 +5,9 @@ - + @NAME@ diff --git a/templates/reference.duck b/templates/reference.duck index c36db72..0aae96b 100644 --- a/templates/reference.duck +++ b/templates/reference.duck @@ -6,8 +6,9 @@ [-- Recommended statuses: stub incomplete draft outdated review candidate final + Remove version attributes you don't use. --] -@revision[version=0.1 date=@DATE@ status=stub] +@revision[version=0.1 docversion=0.1 pkgversion=0.1 date=@DATE@ status=stub] @credit[author copyright] @name @NAME@ diff --git a/templates/reference.page b/templates/reference.page index 1671db7..c7364ee 100644 --- a/templates/reference.page +++ b/templates/reference.page @@ -5,8 +5,9 @@ - + @NAME@ diff --git a/templates/task.duck b/templates/task.duck index c0665e1..75c8243 100644 --- a/templates/task.duck +++ b/templates/task.duck @@ -6,8 +6,9 @@ [-- Recommended statuses: stub incomplete draft outdated review candidate final + Remove version attributes you don't use. --] -@revision[version=0.1 date=@DATE@ status=stub] +@revision[version=0.1 docversion=0.1 pkgversion=0.1 date=@DATE@ status=stub] @credit[author copyright] @name @NAME@ diff --git a/templates/task.page b/templates/task.page index 6b50dcf..ba7be5f 100644 --- a/templates/task.page +++ b/templates/task.page @@ -5,8 +5,9 @@ - + @NAME@ -- cgit v1.2.1