Content: People

Content: People

Ideas to reduce the overhead of these pages

There is some overlap between these ideas...

Agree a standard for optional text, that is commented out and then enabled...

Suggested standard:

• %% .... %% for instructions and comments to maintainers
• <!-- .... --> for things that may be activated (either on one line, or split, depending on context)
  • Never use this for multi-line sections, where activating individual lines means moving some text up or down.
  • Instead, comment out each individual line separately
• <https://> as a placeholder for a commented-out URL
  • So it's obvious where the URL goes, and that it can be pasted in directly
  • and this will make it more likely that ^ marker will be retained
  • It's important that there are no spaces after the ^marker, for it to work and display correctly

Change author template to simplify manual intervention, when running update-releases.py

The reasoning behind the above is to greatly reduce the number of lines that need to be reverted when the author pages are updated, from minimal edits to to the authors template(s).

It will help contributors see the intention for links and ^ too...

Change this:

<!-- - Website: <> ^website-->
<!-- - [[Publish sites|Publish site]]: ^publish-->

To this:

<!-- - Website: <https://> ^website-->
<!-- - [[Publish sites|Publish site]]: <https://> ^publish-->

Change this:

<!--
### Unlisted plugins

- 
-->

To this:

<!--
### Unlisted plugins
-->

Change this:

<!--
### Others

- 
-->

To this:

<!--
### Others
-->

Change this:

<!--
## Sponsor this author

- [[GitHub sponsors]]: [Sponsor @{{title}} on GitHub Sponsors](https://github.com/sponsors/{{title}}) ^github-sponsor
- [[Buy me a coffee]]: ^buy-me-a-coffee
- [[PayPal]]: ^paypal
- [[Patreon]]: ^patreon

-->

To this:

<!--
## Sponsor this author
-->

<!-- - [[GitHub sponsors]]: [Sponsor @{{title}} on GitHub Sponsors](https://github.com/sponsors/{{title}}) ^github-sponsor -->
<!-- - [[Buy me a coffee]]: <https://> ^buy-me-a-coffee-->
<!-- - [[PayPal]]: <https://> ^paypal-->
<!-- - [[Patreon]]: <https://> ^patreon-->

Change this:

<!--
## Follow this author

- [[YouTube Channels|On YouTube]]: ^youtube
- Twitter: ^twitter
- ...
-->

To this:

<!--
## Follow this author
-->

<!-- - [[YouTube Channels|On YouTube]]: <https://> ^youtube-->
<!-- - Twitter: <https://> ^twitter-->
<!-- - ... -->

Agree a standard begin/end prefix for marking 'do not edit' sections

We use these markers in Author pages, and they do not seem to be well-understand:

## Author of

%% Begin Hub: Released contributions %%

<!--
### Plugins

- 
-->

<!--markdown
### Themes

- 
-->

%% End Hub: Released contributions %%

In the new MOC files, we use this:

%% Hub MOCs: Don’t edit below  %%
...
%% Hub MOCs: Don’t edit above  %%

Example idea: standardise on:

%% Hub Content: Don’t edit below  %%
...
%% Hub Content: Don’t edit above  %%

And then use that pair in all boundaries of machine-generated text.

Create-and-include separate files for machine-generated content

Make the Python script that creates Author pages put the generated text in to little files for inclusion in the main file.

For example, we would end up with something like this:

Part of chrisgrieser.md:

## Author of

%% Hub Content: Don’t edit below %%
![[chrisgrieser.plugins]]

![[chrisgrieser.themes]]
%% Hub Content: Don’t edit above %%

In chrisgrieser.plugins:

### Plugins
- [[obsidian-extra-md-commands|Extra Markdown Commands]]

In chrisgrieser.themes:

### Themes
- [[Shimmering Focus]]

The big advantage of this is that the rest of the author file, with manual edits, will not get over-written.

For discussion:

• Would need to identify a sub-dir to put the files in
• If manually creating new author pages, would need to create the 2 extra files and put them in the right location