Skip to content

Commit 1314cde

Browse files
committed
issues-109-111-115 restore snippets module
1 parent 868764c commit 1314cde

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

modular-docs-manual/content/topics/using_text_snippets_or_text_fragments.adoc

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
1+
// Module included in the following assemblies:
2+
//
3+
// <List assemblies here, each on a new line>
14

2-
[id='using_text_snippets_or_text_fragments']
5+
// Base the file name and the ID on the module title. For example:
6+
// * file name: my-concept-module-a.adoc
7+
// * ID: [id="my-concept-module-a_{context}"]
8+
// * Title: = My concept module A
39

10+
// The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
11+
[id="using_text_snippets_or_text_fragments_{context}"]
12+
// The `context` attribute enables module reuse. Every module's ID includes a variable that sets the context, such as {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
413
= Text Snippets or Text Fragments (Pseudo-modules)
5-
14+
//In the title of concept modules, include nouns or noun phrases that are used in the body text. This helps readers and search engines find the information quickly.
15+
//Do not start the title of concept modules with a verb. See also _Wording of headings_ in _The IBM Style Guide_.
616

717
[NOTE]
818
The following standard is recommended when the documentation is being maintained without a Content Management System (CMS) capable of managing complex interrelations between modules.
@@ -13,3 +23,8 @@ Snippet (fragment) file use should be limited to:
1323

1424
* Standardized admonitions (such as 'Technology preview' and 'Beta' text).
1525
* Where there is an existing standard between the upstream and downstream communities.
26+
27+
28+
//.Additional resources
29+
30+
//* A bulleted list of links to other material closely related to the contents of the concept module.

0 commit comments

Comments
 (0)